QGIS API Documentation
3.0.2-Girona (307d082)
|
A groupbox that collapses/expands when toggled and can save its collapsed and checked states. More...
#include <qgscollapsiblegroupbox.h>
Public Member Functions | |
QgsCollapsibleGroupBox (QWidget *parent=nullptr, QgsSettings *settings=nullptr) | |
QgsCollapsibleGroupBox (const QString &title, QWidget *parent=nullptr, QgsSettings *settings=nullptr) | |
~QgsCollapsibleGroupBox () override | |
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 (QgsSettings *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) | |
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... | |
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 |
void | showEvent (QShowEvent *event) override |
QRect | titleRect () const |
void | updateStyle () |
Protected Attributes | |
bool | mDelSettings |
bool | mSaveCheckedState |
bool | mSaveCollapsedState |
QString | mSettingGroup |
QPointer< QgsSettings > | mSettings |
Protected Attributes inherited from QgsCollapsibleGroupBoxBasic | |
bool | mAltDown |
QgsGroupBoxCollapseButton * | mCollapseButton = nullptr |
bool | mCollapsed |
QIcon | mCollapseIcon |
QIcon | mExpandIcon |
bool | mInitFlat |
bool | mInitFlatChecked |
QScrollArea * | mParentScrollArea = nullptr |
bool | mScrollOnExpand |
bool | mShiftDown |
bool | mShown |
QString | mSyncGroup |
QWidget * | mSyncParent = nullptr |
bool | mTitleClicked |
Properties | |
bool | saveCheckedState |
Shall the checked state of this group box be saved and loaded persistently in QgsSettings. More... | |
bool | saveCollapsedState |
Shall the collapsed state of this group box be saved and loaded persistently in QgsSettings. 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... | |
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... | |
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
Definition at line 183 of file qgscollapsiblegroupbox.h.
QgsCollapsibleGroupBox::QgsCollapsibleGroupBox | ( | QWidget * | parent = nullptr , |
QgsSettings * | settings = nullptr |
||
) |
Definition at line 475 of file qgscollapsiblegroupbox.cpp.
QgsCollapsibleGroupBox::QgsCollapsibleGroupBox | ( | const QString & | title, |
QWidget * | parent = nullptr , |
||
QgsSettings * | settings = nullptr |
||
) |
Definition at line 482 of file qgscollapsiblegroupbox.cpp.
|
override |
Definition at line 490 of file qgscollapsiblegroupbox.cpp.
|
protected |
Definition at line 507 of file qgscollapsiblegroupbox.cpp.
|
protectedslot |
Will load the collapsed and checked state.
The configuration path from which it is loaded is defined by
Definition at line 569 of file qgscollapsiblegroupbox.cpp.
|
inline |
Definition at line 214 of file qgscollapsiblegroupbox.h.
|
inline |
Definition at line 213 of file qgscollapsiblegroupbox.h.
|
protected |
Definition at line 547 of file qgscollapsiblegroupbox.cpp.
|
protectedslot |
Will save the collapsed and checked state.
The configuration path to which it is saved is defined by
Definition at line 599 of file qgscollapsiblegroupbox.cpp.
|
inline |
Set this to true to save/restore checked state.
Definition at line 212 of file qgscollapsiblegroupbox.h.
|
inline |
set this to false to not save/restore collapsed state
Definition at line 206 of file qgscollapsiblegroupbox.h.
|
inline |
Set this to a defined string to share save/restore states across different parent dialogs.
Definition at line 217 of file qgscollapsiblegroupbox.h.
void QgsCollapsibleGroupBox::setSettings | ( | QgsSettings * | settings | ) |
Definition at line 498 of file qgscollapsiblegroupbox.cpp.
|
inline |
Returns the name of the setting group in which the collapsed state will be saved.
Definition at line 219 of file qgscollapsiblegroupbox.h.
|
overrideprotected |
Definition at line 526 of file qgscollapsiblegroupbox.cpp.
|
protected |
Definition at line 249 of file qgscollapsiblegroupbox.h.
|
protected |
Definition at line 252 of file qgscollapsiblegroupbox.h.
|
protected |
Definition at line 251 of file qgscollapsiblegroupbox.h.
|
protected |
Definition at line 253 of file qgscollapsiblegroupbox.h.
|
protected |
Definition at line 248 of file qgscollapsiblegroupbox.h.
|
readwrite |
Shall the checked state of this group box be saved and loaded persistently in QgsSettings.
Definition at line 195 of file qgscollapsiblegroupbox.h.
|
readwrite |
Shall the collapsed state of this group box be saved and loaded persistently in QgsSettings.
Definition at line 190 of file qgscollapsiblegroupbox.h.