QgsCollapsibleGroupBox Class Reference

A groupbox that collapses/expands when toggled and can save its collapsed and checked states. More...

#include <qgscollapsiblegroupbox.h>

Inheritance diagram for QgsCollapsibleGroupBox:

Collaboration diagram for QgsCollapsibleGroupBox:

List of all members.

Public Member Functions
	QgsCollapsibleGroupBox (QWidget *parent=0, QSettings *settings=0)
	QgsCollapsibleGroupBox (const QString &title, QWidget *parent=0, QSettings *settings=0)
	~QgsCollapsibleGroupBox ()
bool	saveCheckedState ()
bool	saveCollapsedState ()
void	setSaveCheckedState (bool save)
	set this to true to save/restore checked state
void	setSaveCollapsedState (bool save)
	set this to false to not save/restore collapsed state
void	setSettingGroup (const QString &group)
	set this to a defined string to share save/restore states across different parent dialogs
void	setSettings (QSettings *settings)
QString	settingGroup () const
Protected Slots
void	loadState ()
void	saveState ()
Protected Member Functions
void	init ()
QString	saveKey () const
void	showEvent (QShowEvent *event)
Protected Attributes
bool	mDelSettings
bool	mSaveCheckedState
bool	mSaveCollapsedState
QString	mSettingGroup
QPointer< QSettings >	mSettings
Properties
bool	collapsed
bool	saveCheckedState
bool	saveCollapsedState
QString	syncGroup

---

Detailed Description

A groupbox that collapses/expands when toggled and can save its collapsed and checked states.

By default, it auto-saves only its collapsed state to the global settings based on the widget and it's parent names. Holding Alt modifier key when toggling collapsed state will synchronize the toggling across other collapsible group boxes with the same syncGroup QString value Holding Shift modifier key when attempting to toggle collapsed state will expand current group box, then collapse any others with the same syncGroup QString value

See also:

basic class QgsCollapsibleGroupBoxBasic which does not auto-save states

Note:

To add Collapsible properties in promoted QtDesigner widgets, you can add the following "Dynamic properties" by clicking on the green + in the propreties palette: bool collapsed, bool saveCollapsedState, bool saveCheckedState, QString syncGroup

Definition at line 145 of file qgscollapsiblegroupbox.h.

---

Constructor & Destructor Documentation

QgsCollapsibleGroupBox::QgsCollapsibleGroupBox	(	QWidget *	parent = 0,
		QSettings *	settings = 0
	)

Definition at line 508 of file qgscollapsiblegroupbox.cpp.

References init().

QgsCollapsibleGroupBox::QgsCollapsibleGroupBox	(	const QString &	title,
		QWidget *	parent = 0,
		QSettings *	settings = 0
	)

Definition at line 514 of file qgscollapsiblegroupbox.cpp.

References init().

QgsCollapsibleGroupBox::~QgsCollapsibleGroupBox

(

)

Definition at line 521 of file qgscollapsiblegroupbox.cpp.

References mDelSettings, mSettings, and saveState().

---

Member Function Documentation

void QgsCollapsibleGroupBox::init

(

)

[protected]

Reimplemented from QgsCollapsibleGroupBoxBasic.

Definition at line 539 of file qgscollapsiblegroupbox.cpp.

References mDelSettings, mSaveCheckedState, mSaveCollapsedState, mSettingGroup, and mSettings.

Referenced by QgsCollapsibleGroupBox().

void QgsCollapsibleGroupBox::loadState

(

)

[protected, slot]

Definition at line 599 of file qgscollapsiblegroupbox.cpp.

References mSaveCheckedState, mSaveCollapsedState, mSettings, saveKey(), and QgsCollapsibleGroupBoxBasic::setCollapsed().

Referenced by showEvent().

bool QgsCollapsibleGroupBox::saveCheckedState

(

)

[inline]

Definition at line 169 of file qgscollapsiblegroupbox.h.

bool QgsCollapsibleGroupBox::saveCollapsedState

(

)

[inline]

Definition at line 168 of file qgscollapsiblegroupbox.h.

QString QgsCollapsibleGroupBox::saveKey

(

)

const [protected]

Definition at line 580 of file qgscollapsiblegroupbox.cpp.

References mSettingGroup.

Referenced by loadState(), and saveState().

void QgsCollapsibleGroupBox::saveState

(

)

[protected, slot]

Definition at line 628 of file qgscollapsiblegroupbox.cpp.

References QgsCollapsibleGroupBoxBasic::isCollapsed(), mSaveCheckedState, mSaveCollapsedState, mSettings, and saveKey().

Referenced by ~QgsCollapsibleGroupBox().

void QgsCollapsibleGroupBox::setSaveCheckedState

(

bool

save

)

[inline]

set this to true to save/restore checked state

Note:

only turn on mSaveCheckedState for groupboxes NOT used in multiple places or used as options for different parent objects

Definition at line 167 of file qgscollapsiblegroupbox.h.

void QgsCollapsibleGroupBox::setSaveCollapsedState

(

bool

save

)

[inline]

set this to false to not save/restore collapsed state

Definition at line 163 of file qgscollapsiblegroupbox.h.

void QgsCollapsibleGroupBox::setSettingGroup

(

const QString &

group

)

[inline]

set this to a defined string to share save/restore states across different parent dialogs

Definition at line 172 of file qgscollapsiblegroupbox.h.

void QgsCollapsibleGroupBox::setSettings

(

QSettings *

settings

)

Definition at line 530 of file qgscollapsiblegroupbox.cpp.

References mDelSettings, and mSettings.

QString QgsCollapsibleGroupBox::settingGroup

(

)

const [inline]

Definition at line 173 of file qgscollapsiblegroupbox.h.

void QgsCollapsibleGroupBox::showEvent

(

QShowEvent *

event

)

[protected]

Reimplemented from QgsCollapsibleGroupBoxBasic.

Definition at line 558 of file qgscollapsiblegroupbox.cpp.

References loadState(), QgsCollapsibleGroupBoxBasic::mInitFlat, QgsCollapsibleGroupBoxBasic::mInitFlatChecked, and QgsCollapsibleGroupBoxBasic::mShown.

---

Member Data Documentation

bool QgsCollapsibleGroupBox::mDelSettings [protected]

Definition at line 187 of file qgscollapsiblegroupbox.h.

Referenced by init(), setSettings(), and ~QgsCollapsibleGroupBox().

bool QgsCollapsibleGroupBox::mSaveCheckedState [protected]

Definition at line 190 of file qgscollapsiblegroupbox.h.

Referenced by init(), loadState(), and saveState().

bool QgsCollapsibleGroupBox::mSaveCollapsedState [protected]

Definition at line 189 of file qgscollapsiblegroupbox.h.

Referenced by init(), loadState(), and saveState().

QString QgsCollapsibleGroupBox::mSettingGroup [protected]

Definition at line 191 of file qgscollapsiblegroupbox.h.

Referenced by init(), and saveKey().

QPointer<QSettings> QgsCollapsibleGroupBox::mSettings [protected]

Definition at line 186 of file qgscollapsiblegroupbox.h.

Referenced by init(), loadState(), saveState(), setSettings(), and ~QgsCollapsibleGroupBox().

---

Property Documentation

bool QgsCollapsibleGroupBox::collapsed [read, write]

Reimplemented from QgsCollapsibleGroupBoxBasic.

Definition at line 149 of file qgscollapsiblegroupbox.h.

bool QgsCollapsibleGroupBox::saveCheckedState [read, write]

Definition at line 151 of file qgscollapsiblegroupbox.h.

bool QgsCollapsibleGroupBox::saveCollapsedState [read, write]

Definition at line 150 of file qgscollapsiblegroupbox.h.

QString QgsCollapsibleGroupBox::syncGroup [read, write]

Reimplemented from QgsCollapsibleGroupBoxBasic.

Definition at line 152 of file qgscollapsiblegroupbox.h.

---

The documentation for this class was generated from the following files:

• src/gui/qgscollapsiblegroupbox.h
• src/gui/qgscollapsiblegroupbox.cpp