QGIS API Documentation  2.99.0-Master (8ec3eaf)
Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | List of all members
QgsOptionsDialogBase Class Reference

A base dialog for options and properties dialogs that offers vertical tabs. More...

#include <qgsoptionsdialogbase.h>

Inheritance diagram for QgsOptionsDialogBase:
Inheritance graph
[legend]

Public Member Functions

 QgsOptionsDialogBase (const QString &settingsKey, QWidget *parent=nullptr, Qt::WindowFlags fl=0, QSettings *settings=nullptr)
 Constructor. More...
 
 ~QgsOptionsDialogBase ()
 
bool iconOnly ()
 Determine if the options list is in icon only mode. More...
 
void initOptionsBase (bool restoreUi=true, const QString &title=QString())
 Set up the base ui connections for vertical tabs. More...
 
void restoreOptionsBaseUi (const QString &title=QString())
 Restore the base ui. More...
 
void setSettings (QSettings *settings)
 

Protected Slots

void optionsStackedWidget_CurrentChanged (int indx)
 
void optionsStackedWidget_WidgetRemoved (int indx)
 
void updateOptionsListVerticalTabs ()
 
void warnAboutMissingObjects ()
 

Protected Member Functions

void paintEvent (QPaintEvent *e) override
 
void showEvent (QShowEvent *e) override
 
virtual void updateWindowTitle ()
 

Protected Attributes

bool mDelSettings
 
QString mDialogTitle
 
bool mIconOnly
 
bool mInit
 
QDialogButtonBox * mOptButtonBox
 
QListWidget * mOptListWidget
 
QString mOptsKey
 
QSplitter * mOptSplitter
 
QStackedWidget * mOptStackedWidget
 
QPointer< QSettings > mSettings
 

Detailed Description

A base dialog for options and properties dialogs that offers vertical tabs.

It handles saving/restoring of geometry, splitter and current tab states, switching vertical tabs between icon/text to icon-only modes (splitter collapsed to left), and connecting QDialogButtonBox's accepted/rejected signals to dialog's accept/reject slots

To use: 1) Start with copy of qgsoptionsdialog_template.ui and build options/properties dialog. 2) In source file for dialog, inherit this class instead of QDialog, then in constructor: ... setupUi( this ); // set up .ui file objects initOptionsBase( false ); // set up this class to use .ui objects, optionally restoring base ui ... restoreOptionsBaseUi(); // restore the base ui with initOptionsBase or use this later on

Definition at line 48 of file qgsoptionsdialogbase.h.

Constructor & Destructor Documentation

§ QgsOptionsDialogBase()

QgsOptionsDialogBase::QgsOptionsDialogBase ( const QString &  settingsKey,
QWidget *  parent = nullptr,
Qt::WindowFlags  fl = 0,
QSettings *  settings = nullptr 
)

Constructor.

Parameters
settingsKeyQSettings subgroup key for saving/restore ui states, e.g. "ProjectProperties".
parentparent object (owner)
flwidget flags
settingscustom QSettings pointer

Definition at line 30 of file qgsoptionsdialogbase.cpp.

§ ~QgsOptionsDialogBase()

QgsOptionsDialogBase::~QgsOptionsDialogBase ( )

Definition at line 45 of file qgsoptionsdialogbase.cpp.

Member Function Documentation

§ iconOnly()

bool QgsOptionsDialogBase::iconOnly ( )
inline

Determine if the options list is in icon only mode.

Definition at line 80 of file qgsoptionsdialogbase.h.

§ initOptionsBase()

void QgsOptionsDialogBase::initOptionsBase ( bool  restoreUi = true,
const QString &  title = QString() 
)

Set up the base ui connections for vertical tabs.

Parameters
restoreUiWhether to restore the base ui at this time.
titlethe window title

Definition at line 62 of file qgsoptionsdialogbase.cpp.

§ optionsStackedWidget_CurrentChanged

void QgsOptionsDialogBase::optionsStackedWidget_CurrentChanged ( int  indx)
protectedslot

Definition at line 271 of file qgsoptionsdialogbase.cpp.

§ optionsStackedWidget_WidgetRemoved

void QgsOptionsDialogBase::optionsStackedWidget_WidgetRemoved ( int  indx)
protectedslot

Definition at line 280 of file qgsoptionsdialogbase.cpp.

§ paintEvent()

void QgsOptionsDialogBase::paintEvent ( QPaintEvent *  e)
overrideprotected

Definition at line 214 of file qgsoptionsdialogbase.cpp.

§ restoreOptionsBaseUi()

void QgsOptionsDialogBase::restoreOptionsBaseUi ( const QString &  title = QString())

Restore the base ui.

Sometimes useful to do at end of subclass's constructor.

Parameters
titlethe window title (it does not need to be defined if previously given to initOptionsBase();

Definition at line 150 of file qgsoptionsdialogbase.cpp.

§ setSettings()

void QgsOptionsDialogBase::setSettings ( QSettings *  settings)

Definition at line 139 of file qgsoptionsdialogbase.cpp.

§ showEvent()

void QgsOptionsDialogBase::showEvent ( QShowEvent *  e)
overrideprotected

Definition at line 199 of file qgsoptionsdialogbase.cpp.

§ updateOptionsListVerticalTabs

void QgsOptionsDialogBase::updateOptionsListVerticalTabs ( )
protectedslot

Definition at line 235 of file qgsoptionsdialogbase.cpp.

§ updateWindowTitle()

void QgsOptionsDialogBase::updateWindowTitle ( )
protectedvirtual

Definition at line 222 of file qgsoptionsdialogbase.cpp.

§ warnAboutMissingObjects

void QgsOptionsDialogBase::warnAboutMissingObjects ( )
protectedslot

Definition at line 286 of file qgsoptionsdialogbase.cpp.

Member Data Documentation

§ mDelSettings

bool QgsOptionsDialogBase::mDelSettings
protected

Definition at line 105 of file qgsoptionsdialogbase.h.

§ mDialogTitle

QString QgsOptionsDialogBase::mDialogTitle
protected

Definition at line 100 of file qgsoptionsdialogbase.h.

§ mIconOnly

bool QgsOptionsDialogBase::mIconOnly
protected

Definition at line 101 of file qgsoptionsdialogbase.h.

§ mInit

bool QgsOptionsDialogBase::mInit
protected

Definition at line 95 of file qgsoptionsdialogbase.h.

§ mOptButtonBox

QDialogButtonBox* QgsOptionsDialogBase::mOptButtonBox
protected

Definition at line 99 of file qgsoptionsdialogbase.h.

§ mOptListWidget

QListWidget* QgsOptionsDialogBase::mOptListWidget
protected

Definition at line 96 of file qgsoptionsdialogbase.h.

§ mOptsKey

QString QgsOptionsDialogBase::mOptsKey
protected

Definition at line 94 of file qgsoptionsdialogbase.h.

§ mOptSplitter

QSplitter* QgsOptionsDialogBase::mOptSplitter
protected

Definition at line 98 of file qgsoptionsdialogbase.h.

§ mOptStackedWidget

QStackedWidget* QgsOptionsDialogBase::mOptStackedWidget
protected

Definition at line 97 of file qgsoptionsdialogbase.h.

§ mSettings

QPointer<QSettings> QgsOptionsDialogBase::mSettings
protected

Definition at line 104 of file qgsoptionsdialogbase.h.


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