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:

Public Member Functions
	QgsCollapsibleGroupBox (QWidget *parent=0, QSettings *settings=0)
	QgsCollapsibleGroupBox (const QString &title, QWidget *parent=0, QSettings *settings=0)
	~QgsCollapsibleGroupBox ()
void	setSettings (QSettings *settings)
void	setSaveCollapsedState (bool save)
	set this to false to not save/restore collapsed state
void	setSaveCheckedState (bool save)
	set this to true to save/restore checked state
bool	saveCollapsedState ()
bool	saveCheckedState ()
void	setSettingGroup (const QString &group)
	set this to a defined string to share save/restore states across different parent dialogs
QString	settingGroup () const
Public Member Functions inherited from QgsCollapsibleGroupBoxBasic
	QgsCollapsibleGroupBoxBasic (QWidget *parent=0)
	QgsCollapsibleGroupBoxBasic (const QString &title, QWidget *parent=0)
	~QgsCollapsibleGroupBoxBasic ()
bool	isCollapsed () const
void	setCollapsed (bool collapse)
QString	syncGroup () const
	Named group which synchronizes collapsing action when triangle is clicked while holding alt modifier key.
void	setSyncGroup (QString grp)
void	setScrollOnExpand (bool scroll)
	set this to false to not automatically scroll parent QScrollArea to this widget's contents when expanded
bool	scrollOnExpand ()

Protected Slots
void	loadState ()
void	saveState ()

Protected Member Functions
void	init ()
void	showEvent (QShowEvent *event)
QString	saveKey () const
Protected Member Functions inherited from QgsCollapsibleGroupBoxBasic
void	collapseExpandFixes ()
	Visual fixes for when group box is collapsed/expanded.
void	mousePressEvent (QMouseEvent *event)
void	mouseReleaseEvent (QMouseEvent *event)
void	changeEvent (QEvent *event)
void	updateStyle ()
QRect	titleRect () const
void	clearModifiers ()

Protected Attributes
QPointer< QSettings >	mSettings
bool	mDelSettings
bool	mSaveCollapsedState
bool	mSaveCheckedState
QString	mSettingGroup
Protected Attributes inherited from QgsCollapsibleGroupBoxBasic
bool	mCollapsed
bool	mInitFlat
bool	mInitFlatChecked
bool	mScrollOnExpand
bool	mShown
QScrollArea *	mParentScrollArea
QgsGroupBoxCollapseButton *	mCollapseButton
QWidget *	mSyncParent
QString	mSyncGroup
bool	mAltDown
bool	mShiftDown
bool	mTitleClicked

Properties
bool	collapsed
bool	saveCollapsedState
bool	saveCheckedState
QString	syncGroup
bool	scrollOnExpand
Properties inherited from QgsCollapsibleGroupBoxBasic
bool	collapsed
QString	syncGroup
bool	scrollOnExpand

Additional Inherited Members
Public Slots inherited from QgsCollapsibleGroupBoxBasic
void	checkToggled (bool ckd)
void	checkClicked (bool ckd)
void	toggleCollapsed ()
Signals inherited from QgsCollapsibleGroupBoxBasic
void	collapsedStateChanged (bool collapsed)
	Signal emitted when groupbox collapsed/expanded state is changed, and when first shown.
Static Protected Attributes inherited from QgsCollapsibleGroupBoxBasic
static QIcon	mCollapseIcon
static QIcon	mExpandIcon

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

Constructor & Destructor Documentation

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

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

QgsCollapsibleGroupBox::~QgsCollapsibleGroupBox

(

)

Member Function Documentation

void QgsCollapsibleGroupBox::init ( )

protected

Reimplemented from QgsCollapsibleGroupBoxBasic.

void QgsCollapsibleGroupBox::loadState ( )

protectedslot

bool QgsCollapsibleGroupBox::saveCheckedState ( )

inline

bool QgsCollapsibleGroupBox::saveCollapsedState ( )

inline

QString QgsCollapsibleGroupBox::saveKey ( ) const

protected

void QgsCollapsibleGroupBox::saveState ( )

protectedslot

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

void QgsCollapsibleGroupBox::setSaveCollapsedState ( bool  save )

inline

set this to false to not save/restore collapsed state

void QgsCollapsibleGroupBox::setSettingGroup ( const QString &  group )

inline

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

void QgsCollapsibleGroupBox::setSettings

(

QSettings *

settings

)

QString QgsCollapsibleGroupBox::settingGroup ( ) const

inline

void QgsCollapsibleGroupBox::showEvent ( QShowEvent *  event )

protected

Reimplemented from QgsCollapsibleGroupBoxBasic.

Member Data Documentation

bool QgsCollapsibleGroupBox::mDelSettings

protected

bool QgsCollapsibleGroupBox::mSaveCheckedState

protected

bool QgsCollapsibleGroupBox::mSaveCollapsedState

protected

QString QgsCollapsibleGroupBox::mSettingGroup

protected

QPointer<QSettings> QgsCollapsibleGroupBox::mSettings

protected

Property Documentation

bool QgsCollapsibleGroupBox::collapsed

readwrite

bool QgsCollapsibleGroupBox::saveCheckedState

readwrite

bool QgsCollapsibleGroupBox::saveCollapsedState

readwrite

bool QgsCollapsibleGroupBox::scrollOnExpand

readwrite

QString QgsCollapsibleGroupBox::syncGroup

readwrite

---

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

• /tmp/buildd/qgis-2.6.0+wheezy1/src/gui/qgscollapsiblegroupbox.h
• /tmp/buildd/qgis-2.6.0+wheezy1/src/gui/qgscollapsiblegroupbox.cpp