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

#include <qgscollapsiblegroupbox.h>

Inheritance diagram for QgsCollapsibleGroupBox:

[legend]

Public Member Functions
	QgsCollapsibleGroupBox (QWidget parent=nullptr, QSettings settings=nullptr)

	QgsCollapsibleGroupBox (const QString &title, QWidget parent=nullptr, QSettings settings=nullptr)

	~QgsCollapsibleGroupBox ()

bool	saveCheckedState ()

bool	saveCollapsedState ()

void	setSaveCheckedState (bool save)
	Set this to true to save/restore checked state. More...

void	setSaveCollapsedState (bool save)
	set this to false to not save/restore collapsed state More...

void	setSettingGroup (const QString &group)
	Set this to a defined string to share save/restore states across different parent dialogs. More...

void	setSettings (QSettings *settings)

QString	settingGroup () const
	Returns the name of the setting group in which the collapsed state will be saved. More...

Public Member Functions inherited from QgsCollapsibleGroupBoxBasic
	QgsCollapsibleGroupBoxBasic (QWidget *parent=nullptr)

	QgsCollapsibleGroupBoxBasic (const QString &title, QWidget *parent=nullptr)

	~QgsCollapsibleGroupBoxBasic ()

bool	isCollapsed () const
	Returns the current collapsed state of this group box. More...

bool	scrollOnExpand ()
	If this is set to false the parent QScrollArea will not be automatically scrolled to this widget's contents when expanded. More...

void	setCollapsed (bool collapse)
	Collapse or uncollapse this groupbox. More...

void	setScrollOnExpand (bool scroll)
	Set this to false to not automatically scroll parent QScrollArea to this widget's contents when expanded. More...

void	setSyncGroup (const QString &grp)
	Named group which synchronizes collapsing action when triangle is clicked while holding alt modifier key. More...

QString	syncGroup () const
	Named group which synchronizes collapsing action when triangle is clicked while holding alt modifier key. More...

Public Member Functions inherited from QGroupBox
	QGroupBox (QWidget *parent)

	QGroupBox (const QString &title, QWidget *parent)

	QGroupBox (QWidget parent, const char name)

	QGroupBox (const QString &title, QWidget parent, const char name)

	~QGroupBox ()

Qt::Alignment	alignment () const

void	clicked (bool checked)

bool	isCheckable () const

bool	isChecked () const

bool	isFlat () const

virtual QSize	minimumSizeHint () const

void	setAlignment (int alignment)

void	setCheckable (bool checkable)

void	setChecked (bool checked)

void	setFlat (bool flat)

void	setTitle (const QString &title)

QString	title () const

void	toggled (bool on)

Public Member Functions inherited from QWidget
	QWidget (QWidget *parent, QFlags< Qt::WindowType > f)

	QWidget (QWidget parent, const char name, QFlags< Qt::WindowType > f)

	~QWidget ()

bool	acceptDrops () const

QString	accessibleDescription () const

QString	accessibleName () const

QList< QAction * >	actions () const

void	activateWindow ()

void	addAction (QAction *action)

void	addActions (QList< QAction * > actions)

void	adjustSize ()

bool	autoFillBackground () const

Qt::BackgroundMode	backgroundMode () const

QPoint	backgroundOffset () const

BackgroundOrigin	backgroundOrigin () const

QPalette::ColorRole	backgroundRole () const

QSize	baseSize () const

QString	caption () const

QWidget *	childAt (int x, int y, bool includeThis) const

QWidget *	childAt (const QPoint &p, bool includeThis) const

QWidget *	childAt (int x, int y) const

QWidget *	childAt (const QPoint &p) const

QRect	childrenRect () const

QRegion	childrenRegion () const

void	clearFocus ()

void	clearMask ()

bool	close (bool alsoDelete)

bool	close ()

QColorGroup	colorGroup () const

void	constPolish () const

QMargins	contentsMargins () const

QRect	contentsRect () const

Qt::ContextMenuPolicy	contextMenuPolicy () const

QCursor	cursor () const

void	customContextMenuRequested (const QPoint &pos)

void	drawText (const QPoint &p, const QString &s)

void	drawText (int x, int y, const QString &s)

WId	effectiveWinId () const

void	ensurePolished () const

void	erase ()

void	erase (const QRect &rect)

void	erase (const QRegion &rgn)

void	erase (int x, int y, int w, int h)

Qt::FocusPolicy	focusPolicy () const

QWidget *	focusProxy () const

QWidget *	focusWidget () const

const QFont &	font () const

QFontInfo	fontInfo () const

QFontMetrics	fontMetrics () const

QPalette::ColorRole	foregroundRole () const

QRect	frameGeometry () const

QSize	frameSize () const

const QRect &	geometry () const

void	getContentsMargins (int left, int top, int right, int bottom) const

virtual HDC	getDC () const

void	grabGesture (Qt::GestureType gesture, QFlags< Qt::GestureFlag > flags)

void	grabKeyboard ()

void	grabMouse ()

void	grabMouse (const QCursor &cursor)

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)

QGraphicsEffect *	graphicsEffect () const

QGraphicsProxyWidget *	graphicsProxyWidget () const

bool	hasEditFocus () const

bool	hasFocus () const

bool	hasMouse () const

bool	hasMouseTracking () const

int	height () const

virtual int	heightForWidth (int w) const

void	hide ()

const QPixmap *	icon () const

void	iconify ()

QString	iconText () const

QInputContext *	inputContext ()

Qt::InputMethodHints	inputMethodHints () const

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const

void	insertAction (QAction before, QAction action)

void	insertActions (QAction before, QList< QAction > actions)

bool	isActiveWindow () const

bool	isAncestorOf (const QWidget *child) const

bool	isDesktop () const

bool	isDialog () const

bool	isEnabled () const

bool	isEnabledTo (QWidget *ancestor) const

bool	isEnabledToTLW () const

bool	isFullScreen () const

bool	isHidden () const

bool	isInputMethodEnabled () const

bool	isMaximized () const

bool	isMinimized () const

bool	isModal () const

bool	isPopup () const

bool	isShown () const

bool	isTopLevel () const

bool	isUpdatesEnabled () const

bool	isVisible () const

bool	isVisibleTo (QWidget *ancestor) const

bool	isVisibleToTLW () const

bool	isWindow () const

bool	isWindowModified () const

QLayout *	layout () const

Qt::LayoutDirection	layoutDirection () const

QLocale	locale () const

void	lower ()

Qt::HANDLE	macCGHandle () const

Qt::HANDLE	macQDHandle () const

QPoint	mapFrom (QWidget *parent, const QPoint &pos) const

QPoint	mapFromGlobal (const QPoint &pos) const

QPoint	mapFromParent (const QPoint &pos) const

QPoint	mapTo (QWidget *parent, const QPoint &pos) const

QPoint	mapToGlobal (const QPoint &pos) const

QPoint	mapToParent (const QPoint &pos) const

QRegion	mask () const

int	maximumHeight () const

QSize	maximumSize () const

int	maximumWidth () const

int	minimumHeight () const

QSize	minimumSize () const

int	minimumWidth () const

void	move (int x, int y)

void	move (const QPoint &)

QWidget *	nativeParentWidget () const

QWidget *	nextInFocusChain () const

QRect	normalGeometry () const

void	overrideWindowFlags (QFlags< Qt::WindowType > flags)

bool	ownCursor () const

bool	ownFont () const

bool	ownPalette () const

virtual QPaintEngine *	paintEngine () const

const QPalette &	palette () const

QWidget *	parentWidget (bool sameWindow) const

QWidget *	parentWidget () const

QPlatformWindow *	platformWindow () const

QPlatformWindowFormat	platformWindowFormat () const

void	polish ()

QPoint	pos () const

QWidget *	previousInFocusChain () const

void	raise ()

void	recreate (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt)

QRect	rect () const

virtual void	releaseDC (HDC hdc) const

void	releaseKeyboard ()

void	releaseMouse ()

void	releaseShortcut (int id)

void	removeAction (QAction *action)

void	render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)

void	render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)

void	repaint (int x, int y, int w, int h, bool b)

void	repaint (const QRegion &rgn, bool b)

void	repaint ()

void	repaint (int x, int y, int w, int h)

void	repaint (const QRegion &rgn)

void	repaint (bool b)

void	repaint (const QRect &rect)

void	repaint (const QRect &r, bool b)

void	reparent (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt)

void	reparent (QWidget *parent, const QPoint &p, bool showIt)

void	resize (int w, int h)

void	resize (const QSize &)

bool	restoreGeometry (const QByteArray &geometry)

QByteArray	saveGeometry () const

void	scroll (int dx, int dy)

void	scroll (int dx, int dy, const QRect &r)

void	setAcceptDrops (bool on)

void	setAccessibleDescription (const QString &description)

void	setAccessibleName (const QString &name)

void	setActiveWindow ()

void	setAttribute (Qt::WidgetAttribute attribute, bool on)

void	setAutoFillBackground (bool enabled)

void	setBackgroundColor (const QColor &color)

void	setBackgroundMode (Qt::BackgroundMode widgetBackground, Qt::BackgroundMode paletteBackground)

void	setBackgroundOrigin (BackgroundOrigin background)

void	setBackgroundPixmap (const QPixmap &pixmap)

void	setBackgroundRole (QPalette::ColorRole role)

void	setBaseSize (const QSize &)

void	setBaseSize (int basew, int baseh)

void	setCaption (const QString &c)

void	setContentsMargins (int left, int top, int right, int bottom)

void	setContentsMargins (const QMargins &margins)

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	setCursor (const QCursor &)

void	setDisabled (bool disable)

void	setEditFocus (bool enable)

void	setEnabled (bool)

void	setEraseColor (const QColor &color)

void	setErasePixmap (const QPixmap &pixmap)

void	setFixedHeight (int h)

void	setFixedSize (const QSize &s)

void	setFixedSize (int w, int h)

void	setFixedWidth (int w)

void	setFocus (Qt::FocusReason reason)

void	setFocus ()

void	setFocusPolicy (Qt::FocusPolicy policy)

void	setFocusProxy (QWidget *w)

void	setFont (const QFont &)

void	setFont (const QFont &f, bool b)

void	setForegroundRole (QPalette::ColorRole role)

void	setGeometry (int x, int y, int w, int h)

void	setGeometry (const QRect &)

void	setGraphicsEffect (QGraphicsEffect *effect)

void	setHidden (bool hidden)

void	setIcon (const QPixmap &i)

void	setIconText (const QString &it)

void	setInputContext (QInputContext *context)

void	setInputMethodEnabled (bool enabled)

void	setInputMethodHints (QFlags< Qt::InputMethodHint > hints)

void	setKeyCompression (bool b)

void	setLayout (QLayout *layout)

void	setLayoutDirection (Qt::LayoutDirection direction)

void	setLocale (const QLocale &locale)

void	setMask (const QBitmap &bitmap)

void	setMask (const QRegion &region)

void	setMaximumHeight (int maxh)

void	setMaximumSize (const QSize &)

void	setMaximumSize (int maxw, int maxh)

void	setMaximumWidth (int maxw)

void	setMinimumHeight (int minh)

void	setMinimumSize (int minw, int minh)

void	setMinimumSize (const QSize &)

void	setMinimumWidth (int minw)

void	setMouseTracking (bool enable)

void	setPalette (const QPalette &)

void	setPalette (const QPalette &p, bool b)

void	setPaletteBackgroundColor (const QColor &color)

void	setPaletteBackgroundPixmap (const QPixmap &pixmap)

void	setPaletteForegroundColor (const QColor &color)

void	setParent (QWidget *parent)

void	setParent (QWidget *parent, QFlags< Qt::WindowType > f)

void	setPlatformWindow (QPlatformWindow *window)

void	setPlatformWindowFormat (const QPlatformWindowFormat &format)

void	setShortcutAutoRepeat (int id, bool enable)

void	setShortcutEnabled (int id, bool enable)

void	setShown (bool shown)

void	setSizeIncrement (const QSize &)

void	setSizeIncrement (int w, int h)

void	setSizePolicy (QSizePolicy::Policy hor, QSizePolicy::Policy ver, bool hfw)

void	setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)

void	setSizePolicy (QSizePolicy)

void	setStatusTip (const QString &)

void	setStyle (QStyle *style)

QStyle *	setStyle (const QString &style)

void	setStyleSheet (const QString &styleSheet)

void	setToolTip (const QString &)

void	setUpdatesEnabled (bool enable)

void	setupUi (QWidget *widget)

virtual void	setVisible (bool visible)

void	setWhatsThis (const QString &)

void	setWindowFilePath (const QString &filePath)

void	setWindowFlags (QFlags< Qt::WindowType > type)

void	setWindowIcon (const QIcon &icon)

void	setWindowIconText (const QString &)

void	setWindowModality (Qt::WindowModality windowModality)

void	setWindowModified (bool)

void	setWindowOpacity (qreal level)

void	setWindowRole (const QString &role)

void	setWindowState (QFlags< Qt::WindowState > windowState)

void	setWindowSurface (QWindowSurface *surface)

void	setWindowTitle (const QString &)

void	show ()

void	showFullScreen ()

void	showMaximized ()

void	showMinimized ()

void	showNormal ()

QSize	size () const

virtual QSize	sizeHint () const

QSize	sizeIncrement () const

QSizePolicy	sizePolicy () const

void	stackUnder (QWidget *w)

QString	statusTip () const

QStyle *	style () const

QString	styleSheet () const

bool	testAttribute (Qt::WidgetAttribute attribute) const

QString	toolTip () const

QWidget *	topLevelWidget () const

bool	underMouse () const

void	ungrabGesture (Qt::GestureType gesture)

void	unsetCursor ()

void	unsetFont ()

void	unsetLayoutDirection ()

void	unsetLocale ()

void	unsetPalette ()

void	update (const QRect &rect)

void	update (const QRegion &rgn)

void	update (int x, int y, int w, int h)

void	update ()

void	updateGeometry ()

bool	updatesEnabled () const

QRect	visibleRect () const

QRegion	visibleRegion () const

QString	whatsThis () const

int	width () const

QWidget *	window () const

QString	windowFilePath () const

Qt::WindowFlags	windowFlags () const

QIcon	windowIcon () const

QString	windowIconText () const

Qt::WindowModality	windowModality () const

qreal	windowOpacity () const

QString	windowRole () const

Qt::WindowStates	windowState () const

QWindowSurface *	windowSurface () const

QString	windowTitle () const

Qt::WindowType	windowType () const

WId	winId () const

int	x () const

const QX11Info &	x11Info () const

Qt::HANDLE	x11PictureHandle () const

int	y () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Public Member Functions inherited from QPaintDevice
virtual	~QPaintDevice ()

int	colorCount () const

int	depth () const

int	height () const

int	heightMM () const

int	logicalDpiX () const

int	logicalDpiY () const

int	numColors () const

virtual QPaintEngine *	paintEngine () const=0

bool	paintingActive () const

int	physicalDpiX () const

int	physicalDpiY () const

int	width () const

int	widthMM () const

int	x11Cells () const

Qt::HANDLE	x11Colormap () const

bool	x11DefaultColormap () const

bool	x11DefaultVisual () const

int	x11Depth () const

Display *	x11Display () const

int	x11Screen () const

void *	x11Visual () const

Protected Slots
void	loadState ()
	Will load the collapsed and checked state. More...

void	saveState () const
	Will save the collapsed and checked state. More...

Protected Member Functions
void	init ()

QString	saveKey () const

void	showEvent (QShowEvent *event) override

Protected Member Functions inherited from QgsCollapsibleGroupBoxBasic
void	changeEvent (QEvent *event) override

void	clearModifiers ()

void	collapseExpandFixes ()
	Visual fixes for when group box is collapsed/expanded. More...

void	init ()

void	mousePressEvent (QMouseEvent *event) override

void	mouseReleaseEvent (QMouseEvent *event) override

QRect	titleRect () const

void	updateStyle ()

Protected Member Functions inherited from QGroupBox
virtual void	childEvent (QChildEvent *c)

virtual bool	event (QEvent *e)

virtual void	focusInEvent (QFocusEvent *fe)

void	initStyleOption (QStyleOptionGroupBox *option) const

virtual void	mouseMoveEvent (QMouseEvent *event)

virtual void	paintEvent (QPaintEvent *event)

virtual void	resizeEvent (QResizeEvent *e)

Protected Member Functions inherited from QWidget
virtual void	actionEvent (QActionEvent *event)

virtual void	closeEvent (QCloseEvent *event)

virtual void	contextMenuEvent (QContextMenuEvent *event)

void	create (WId window, bool initializeWindow, bool destroyOldWindow)

void	destroy (bool destroyWindow, bool destroySubWindows)

virtual void	dragEnterEvent (QDragEnterEvent *event)

virtual void	dragLeaveEvent (QDragLeaveEvent *event)

virtual void	dragMoveEvent (QDragMoveEvent *event)

virtual void	dropEvent (QDropEvent *event)

virtual void	enterEvent (QEvent *event)

bool	focusNextChild ()

virtual bool	focusNextPrevChild (bool next)

virtual void	focusOutEvent (QFocusEvent *event)

bool	focusPreviousChild ()

virtual void	hideEvent (QHideEvent *event)

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	languageChange ()

virtual void	leaveEvent (QEvent *event)

virtual bool	macEvent (EventHandlerCallRef caller, EventRef event)

virtual int	metric (PaintDeviceMetric m) const

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	moveEvent (QMoveEvent *event)

virtual bool	qwsEvent (QWSEvent *event)

void	resetInputContext ()

virtual void	tabletEvent (QTabletEvent *event)

void	updateMicroFocus ()

virtual void	wheelEvent (QWheelEvent *event)

virtual bool	winEvent (MSG message, long result)

virtual bool	x11Event (XEvent *event)

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Protected Member Functions inherited from QPaintDevice
	QPaintDevice ()

Protected Attributes
bool	mDelSettings

bool	mSaveCheckedState

bool	mSaveCollapsedState

QString	mSettingGroup

QPointer< QSettings >	mSettings

Protected Attributes inherited from QgsCollapsibleGroupBoxBasic
bool	mAltDown

QgsGroupBoxCollapseButton *	mCollapseButton

bool	mCollapsed

QIcon	mCollapseIcon

QIcon	mExpandIcon

bool	mInitFlat

bool	mInitFlatChecked

QScrollArea *	mParentScrollArea

bool	mScrollOnExpand

bool	mShiftDown

bool	mShown

QString	mSyncGroup

QWidget *	mSyncParent

bool	mTitleClicked

Properties
bool	saveCheckedState
	Shall the checked state of this group box be saved and loaded persistently in QSettings. More...

bool	saveCollapsedState
	Shall the collapsed state of this group box be saved and loaded persistently in QSettings. More...

Properties inherited from QgsCollapsibleGroupBoxBasic
bool	collapsed
	The collapsed state of this group box. More...

bool	scrollOnExpand
	If this property is set to true, a parent scroll area will try to make sure that the whole group box is visible when uncollapsing it. More...

QString	syncGroup
	An optional group to be collapsed and uncollapsed in sync with this group box if the Alt-modifier is pressed while collapsing / uncollapsing. More...

Properties inherited from QGroupBox
	alignment

	checkable

	checked

	flat

	title

Properties inherited from QWidget
	acceptDrops

	accessibleDescription

	accessibleName

	autoFillBackground

	baseSize

	childrenRect

	childrenRegion

	contextMenuPolicy

	cursor

	enabled

	focus

	focusPolicy

	font

	frameGeometry

	frameSize

	fullScreen

	geometry

	height

	inputMethodHints

	isActiveWindow

	layoutDirection

	locale

	maximized

	maximumHeight

	maximumSize

	maximumWidth

	minimized

	minimumHeight

	minimumSize

	minimumSizeHint

	minimumWidth

	modal

	mouseTracking

	normalGeometry

	palette

	pos

	rect

	size

	sizeHint

	sizeIncrement

	sizePolicy

	statusTip

	styleSheet

	toolTip

	updatesEnabled

	visible

	whatsThis

	width

	windowFilePath

	windowFlags

	windowIcon

	windowIconText

	windowModality

	windowModified

	windowOpacity

	windowTitle

	x

	y

Properties inherited from QObject
	objectName

Additional Inherited Members
Public Slots inherited from QgsCollapsibleGroupBoxBasic
void	checkClicked (bool ckd)

void	checkToggled (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. More...

Static Public Member Functions inherited from QWidget
QWidget *	find (WId id)

QWidget *	keyboardGrabber ()

QWidget *	mouseGrabber ()

void	setTabOrder (QWidget first, QWidget second)

QWidgetMapper *	wmapper ()

Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Static Public Member Functions inherited from QPaintDevice
int	x11AppCells (int screen)

Qt::HANDLE	x11AppColormap (int screen)

bool	x11AppDefaultColormap (int screen)

bool	x11AppDefaultVisual (int screen)

int	x11AppDepth (int screen)

Display *	x11AppDisplay ()

int	x11AppDpiX (int screen)

int	x11AppDpiY (int screen)

Qt::HANDLE	x11AppRootWindow (int screen)

int	x11AppScreen ()

void *	x11AppVisual (int screen)

void	x11SetAppDpiX (int dpi, int screen)

void	x11SetAppDpiY (int dpi, int screen)

Public Attributes inherited from QWidget
typedef	RenderFlags

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

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 183 of file qgscollapsiblegroupbox.h.

Constructor & Destructor Documentation

◆ QgsCollapsibleGroupBox() [1/2]

QgsCollapsibleGroupBox::QgsCollapsibleGroupBox	(	QWidget *	parent = `nullptr`,
		QSettings *	settings = `nullptr`
	)

Definition at line 477 of file qgscollapsiblegroupbox.cpp.

◆ QgsCollapsibleGroupBox() [2/2]

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

Definition at line 484 of file qgscollapsiblegroupbox.cpp.

◆ ~QgsCollapsibleGroupBox()

QgsCollapsibleGroupBox::~QgsCollapsibleGroupBox ( )

Definition at line 492 of file qgscollapsiblegroupbox.cpp.

Member Function Documentation

◆ init()

void QgsCollapsibleGroupBox::init ( )

protected

Definition at line 509 of file qgscollapsiblegroupbox.cpp.

◆ loadState

void QgsCollapsibleGroupBox::loadState ( )

protectedslot

Will load the collapsed and checked state.

The configuration path from which it is loaded is defined by

The object name
The settingGroup

Definition at line 567 of file qgscollapsiblegroupbox.cpp.

◆ saveCheckedState()

bool QgsCollapsibleGroupBox::saveCheckedState ( )

inline

Definition at line 212 of file qgscollapsiblegroupbox.h.

◆ saveCollapsedState()

bool QgsCollapsibleGroupBox::saveCollapsedState ( )

inline

Definition at line 211 of file qgscollapsiblegroupbox.h.

◆ saveKey()

QString QgsCollapsibleGroupBox::saveKey ( ) const

protected

Definition at line 548 of file qgscollapsiblegroupbox.cpp.

◆ saveState

void QgsCollapsibleGroupBox::saveState ( ) const

protectedslot

Will save the collapsed and checked state.

The configuration path to which it is saved is defined by

The object name
The settingGroup

Definition at line 595 of file qgscollapsiblegroupbox.cpp.

◆ setSaveCheckedState()

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 210 of file qgscollapsiblegroupbox.h.

◆ setSaveCollapsedState()

void QgsCollapsibleGroupBox::setSaveCollapsedState ( bool save )

inline

set this to false to not save/restore collapsed state

Definition at line 206 of file qgscollapsiblegroupbox.h.

◆ setSettingGroup()

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 215 of file qgscollapsiblegroupbox.h.

◆ setSettings()

void QgsCollapsibleGroupBox::setSettings ( QSettings * settings )

Definition at line 500 of file qgscollapsiblegroupbox.cpp.

◆ settingGroup()

QString QgsCollapsibleGroupBox::settingGroup ( ) const

inline

Returns the name of the setting group in which the collapsed state will be saved.

Definition at line 217 of file qgscollapsiblegroupbox.h.

◆ showEvent()

void QgsCollapsibleGroupBox::showEvent ( QShowEvent * event )

overrideprotectedvirtual

Reimplemented from QgsCollapsibleGroupBoxBasic.

Definition at line 527 of file qgscollapsiblegroupbox.cpp.

Member Data Documentation

◆ mDelSettings

bool QgsCollapsibleGroupBox::mDelSettings

protected

Definition at line 245 of file qgscollapsiblegroupbox.h.

◆ mSaveCheckedState

bool QgsCollapsibleGroupBox::mSaveCheckedState

protected

Definition at line 248 of file qgscollapsiblegroupbox.h.

◆ mSaveCollapsedState

bool QgsCollapsibleGroupBox::mSaveCollapsedState

protected

Definition at line 247 of file qgscollapsiblegroupbox.h.

◆ mSettingGroup

QString QgsCollapsibleGroupBox::mSettingGroup

protected

Definition at line 249 of file qgscollapsiblegroupbox.h.

◆ mSettings

QPointer<QSettings> QgsCollapsibleGroupBox::mSettings

protected

Definition at line 244 of file qgscollapsiblegroupbox.h.

Property Documentation

◆ saveCheckedState

bool QgsCollapsibleGroupBox::saveCheckedState

readwrite

Shall the checked state of this group box be saved and loaded persistently in QSettings.

Definition at line 195 of file qgscollapsiblegroupbox.h.

◆ saveCollapsedState

bool QgsCollapsibleGroupBox::saveCollapsedState

readwrite

Shall the collapsed state of this group box be saved and loaded persistently in QSettings.

Definition at line 190 of file qgscollapsiblegroupbox.h.

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

/tmp/buildd/qgis-2.18.21+99unstable/src/gui/qgscollapsiblegroupbox.h
/tmp/buildd/qgis-2.18.21+99unstable/src/gui/qgscollapsiblegroupbox.cpp

Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsCollapsibleGroupBox() [1/2]

◆ QgsCollapsibleGroupBox() [2/2]

◆ ~QgsCollapsibleGroupBox()

Member Function Documentation

◆ init()

◆ loadState

◆ saveCheckedState()

◆ saveCollapsedState()

◆ saveKey()

◆ saveState

◆ setSaveCheckedState()

◆ setSaveCollapsedState()

◆ setSettingGroup()

◆ setSettings()

◆ settingGroup()

◆ showEvent()

Member Data Documentation

◆ mDelSettings

◆ mSaveCheckedState

◆ mSaveCollapsedState

◆ mSettingGroup

◆ mSettings

Property Documentation

◆ saveCheckedState

◆ saveCollapsedState