Class: QgsOptionsDialogBase¶

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:

Start with copy of qgsoptionsdialog_template.ui and build options/properties dialog.
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

Class Hierarchy¶

Base classes¶

QDialog
QWidget
QObject
QPaintDevice

Subclasses¶

QgsLayerPropertiesDialog

Base class for “layer properties” dialogs, containing common utilities for handling functionality in these dialogs.

Methods

`addPage`	Adds a new page to the dialog pages.
`iconOnly`	Determine if the options list is in icon only mode
`initOptionsBase`	Set up the base ui connections for vertical tabs.
`insertPage`	Inserts a new page into the dialog pages.
`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.
`resizeAlltabs`	Resizes all tabs when the dialog is resized
`restoreLastPage`	Refocus the active tab from the last time the dialog was shown.
`restoreOptionsBaseUi`	Restore the base ui.
`searchText`	searchText searches for a text in all the pages of the stacked widget and highlight the results
`setCurrentPage`	Sets the dialog page (by object name) to show.
`setSettings`
`warnAboutMissingObjects`

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsOptionsDialogBase. See the FAQ for more details.

`optionsStackedWidget_CurrentChanged`	Select relevant tab on current page change
`optionsStackedWidget_WidgetRemoved`	Remove tab and unregister widgets on page remove
`updateOptionsListVerticalTabs`	Update tabs on the splitter move
`updateWindowTitle`

class qgis.gui.QgsOptionsDialogBase[source]¶

Bases: QDialog

__init__(settingsKey: str | None, parent: QWidget | None = None, fl: Qt.WindowFlags | Qt.WindowType = Qt.WindowFlags(), settings: QgsSettings | None = None)

Constructor

Parameters:

settingsKey (Optional[str]) – QgsSettings subgroup key for saving/restore ui states, e.g. “ProjectProperties”.
parent (Optional[QWidget] = None) – parent object (owner)
fl (Union[Qt.WindowFlags, Qt.WindowType] = Qt.WindowFlags()) – widget flags
settings (Optional[QgsSettings] = None) – custom QgsSettings pointer

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.

Since QGIS 3.22, the optional path argument can be used to set the path of the item’s entry in the tree view (for dialogs which show a tree view of options pages only).

Since QGIS 3.32, the optional key argument can be used to set an untranslated key that path can refer to in following calls. Default to title.