QGIS API Documentation
3.16.0-Hannover (43b64b13f3)
|
A base dialog for options and properties dialogs that offers vertical tabs. More...
#include <qgsoptionsdialogbase.h>
Public Slots | |
void | searchText (const QString &text) |
searchText searches for a text in all the pages of the stacked widget and highlight the results More... | |
Public Member Functions | |
QgsOptionsDialogBase (const QString &settingsKey, QWidget *parent=nullptr, Qt::WindowFlags fl=Qt::WindowFlags(), QgsSettings *settings=nullptr) | |
Constructor. More... | |
~QgsOptionsDialogBase () override | |
void | addPage (const QString &title, const QString &tooltip, const QIcon &icon, QWidget *widget) |
Adds a new page to the dialog pages. More... | |
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 | insertPage (const QString &title, const QString &tooltip, const QIcon &icon, QWidget *widget, const QString &before) |
Inserts a new page into the dialog pages. More... | |
void | resizeAlltabs (int index) |
Resizes all tabs when the dialog is resized. More... | |
void | restoreLastPage () |
Refocus the active tab from the last time the dialog was shown. More... | |
void | restoreOptionsBaseUi (const QString &title=QString()) |
Restore the base ui. More... | |
void | setCurrentPage (const QString &page) |
Sets the dialog page (by object name) to show. More... | |
void | setSettings (QgsSettings *settings) |
Protected Slots | |
virtual void | optionsStackedWidget_CurrentChanged (int index) |
Select relevant tab on current page change. More... | |
virtual void | optionsStackedWidget_WidgetRemoved (int index) |
Remove tab and unregister widgets on page remove. More... | |
virtual void | updateOptionsListVerticalTabs () |
Update tabs on the splitter move. More... | |
void | warnAboutMissingObjects () |
Protected Member Functions | |
void | paintEvent (QPaintEvent *e) override |
void | registerTextSearchWidgets () |
register widgets in the dialog to search for text in it it is automatically called if a line edit has "mSearchLineEdit" as object name. More... | |
void | showEvent (QShowEvent *e) override |
virtual void | updateWindowTitle () |
Protected Attributes | |
bool | mDelSettings |
QString | mDialogTitle |
bool | mIconOnly |
bool | mInit |
QDialogButtonBox * | mOptButtonBox = nullptr |
QListWidget * | mOptListWidget = nullptr |
QString | mOptsKey |
QSplitter * | mOptSplitter = nullptr |
QStackedWidget * | mOptStackedWidget = nullptr |
QList< QPair< QgsOptionsDialogHighlightWidget *, int > > | mRegisteredSearchWidgets |
QgsFilterLineEdit * | mSearchLineEdit = nullptr |
QPointer< QgsSettings > | mSettings |
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:
... 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 62 of file qgsoptionsdialogbase.h.
QgsOptionsDialogBase::QgsOptionsDialogBase | ( | const QString & | settingsKey, |
QWidget * | parent = nullptr , |
||
Qt::WindowFlags | fl = Qt::WindowFlags() , |
||
QgsSettings * | settings = nullptr |
||
) |
Constructor.
settingsKey | QgsSettings subgroup key for saving/restore ui states, e.g. "ProjectProperties". |
parent | parent object (owner) |
fl | widget flags |
settings | custom QgsSettings pointer |
Definition at line 38 of file qgsoptionsdialogbase.cpp.
|
override |
Definition at line 48 of file qgsoptionsdialogbase.cpp.
void QgsOptionsDialogBase::addPage | ( | const QString & | title, |
const QString & | tooltip, | ||
const QIcon & | icon, | ||
QWidget * | widget | ||
) |
Adds a new page to the dialog pages.
The title, tooltip and icon arguments dictate the page list item title, tooltip and icon respectively.
The page content is specified via the widget argument. Ownership of widget is transferred to the dialog.
Definition at line 266 of file qgsoptionsdialogbase.cpp.
|
inline |
Determine if the options list is in icon only mode.
Definition at line 112 of file qgsoptionsdialogbase.h.
void QgsOptionsDialogBase::initOptionsBase | ( | bool | restoreUi = true , |
const QString & | title = QString() |
||
) |
Set up the base ui connections for vertical tabs.
restoreUi | Whether to restore the base ui at this time. |
title | the window title |
Definition at line 65 of file qgsoptionsdialogbase.cpp.
void QgsOptionsDialogBase::insertPage | ( | const QString & | title, |
const QString & | tooltip, | ||
const QIcon & | icon, | ||
QWidget * | widget, | ||
const QString & | before | ||
) |
Inserts a new page into the dialog pages.
The title, tooltip and icon arguments dictate the page list item title, tooltip and icon respectively.
The page content is specified via the widget argument. Ownership of widget is transferred to the dialog.
The before argument specifies the object name of an existing page. The new page will be inserted directly before the matching page.
Definition at line 277 of file qgsoptionsdialogbase.cpp.
|
protectedvirtualslot |
Select relevant tab on current page change.
Definition at line 468 of file qgsoptionsdialogbase.cpp.
|
protectedvirtualslot |
Remove tab and unregister widgets on page remove.
Definition at line 477 of file qgsoptionsdialogbase.cpp.
|
overrideprotected |
Definition at line 408 of file qgsoptionsdialogbase.cpp.
|
protected |
register widgets in the dialog to search for text in it it is automatically called if a line edit has "mSearchLineEdit" as object name.
Definition at line 347 of file qgsoptionsdialogbase.cpp.
void QgsOptionsDialogBase::resizeAlltabs | ( | int | index | ) |
Resizes all tabs when the dialog is resized.
index | current tab index |
Definition at line 227 of file qgsoptionsdialogbase.cpp.
void QgsOptionsDialogBase::restoreLastPage | ( | ) |
Refocus the active tab from the last time the dialog was shown.
Definition at line 201 of file qgsoptionsdialogbase.cpp.
void QgsOptionsDialogBase::restoreOptionsBaseUi | ( | const QString & | title = QString() | ) |
Restore the base ui.
Sometimes useful to do at end of subclass's constructor.
title | the window title (it does not need to be defined if previously given to initOptionsBase(); |
Definition at line 161 of file qgsoptionsdialogbase.cpp.
|
slot |
searchText searches for a text in all the pages of the stacked widget and highlight the results
text | the text to search |
Definition at line 302 of file qgsoptionsdialogbase.cpp.
void QgsOptionsDialogBase::setCurrentPage | ( | const QString & | page | ) |
Sets the dialog page (by object name) to show.
Definition at line 251 of file qgsoptionsdialogbase.cpp.
void QgsOptionsDialogBase::setSettings | ( | QgsSettings * | settings | ) |
Definition at line 150 of file qgsoptionsdialogbase.cpp.
|
overrideprotected |
Definition at line 388 of file qgsoptionsdialogbase.cpp.
|
protectedvirtualslot |
Update tabs on the splitter move.
Definition at line 432 of file qgsoptionsdialogbase.cpp.
|
protectedvirtual |
Definition at line 416 of file qgsoptionsdialogbase.cpp.
|
protectedslot |
Definition at line 492 of file qgsoptionsdialogbase.cpp.
|
protected |
Definition at line 194 of file qgsoptionsdialogbase.h.
|
protected |
Definition at line 189 of file qgsoptionsdialogbase.h.
|
protected |
Definition at line 190 of file qgsoptionsdialogbase.h.
|
protected |
Definition at line 183 of file qgsoptionsdialogbase.h.
|
protected |
Definition at line 187 of file qgsoptionsdialogbase.h.
|
protected |
Definition at line 184 of file qgsoptionsdialogbase.h.
|
protected |
Definition at line 182 of file qgsoptionsdialogbase.h.
|
protected |
Definition at line 186 of file qgsoptionsdialogbase.h.
|
protected |
Definition at line 185 of file qgsoptionsdialogbase.h.
|
protected |
Definition at line 180 of file qgsoptionsdialogbase.h.
|
protected |
Definition at line 188 of file qgsoptionsdialogbase.h.
|
protected |
Definition at line 193 of file qgsoptionsdialogbase.h.