Class: QgsOptionsWidgetFactory¶
- class qgis.gui.QgsOptionsWidgetFactory¶
Bases:
PyQt5.QtCore.QObject
Constructor
QgsOptionsWidgetFactory(title: str, icon: QIcon) Constructor
Methods
Factory function to create the widget on demand as needed by the options dialog.
The icon that will be shown in the UI for the panel.
Returns a tab name hinting at where this page should be inserted into the options properties tab list.
Returns the path to place the widget page at, for options dialogs which are structured using a tree view.
Set the
icon
to show in the interface for the factory object.Set the
title
for the interface.The title of the panel.
- childEvent(self, QChildEvent)¶
- connectNotify(self, QMetaMethod)¶
- createWidget(self, parent: QWidget = None) QgsOptionsPageWidget ¶
Factory function to create the widget on demand as needed by the options dialog.
- Parameters:
parent (QWidget = None) – The parent of the widget.
- Return type:
- Returns:
A new widget to show as a page in the options dialog.
- customEvent(self, QEvent)¶
- disconnectNotify(self, QMetaMethod)¶
- icon(self) QIcon ¶
The icon that will be shown in the UI for the panel.
- Return type:
QIcon
- Returns:
A QIcon for the panel icon.
See also
- isSignalConnected(self, QMetaMethod) bool ¶
- pagePositionHint(self) str ¶
Returns a tab name hinting at where this page should be inserted into the options properties tab list.
If the returned string is non-empty, the options widget page will be inserted before the existing page with matching object name.
The default implementation returns an empty string, which causes the widget to be placed at the end of the dialog page list.
New in version 3.18.
- Return type:
str
- path(self) List[str] ¶
Returns the path to place the widget page at, for options dialogs which are structured using a tree view.
A factory which returns “Code”, “Javascript” would have its widget placed in a group named “Javascript”, contained in a parent group named “Code”.
New in version 3.22.
- Return type:
List[str]
- receivers(self, PYQT_SIGNAL) int ¶
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- setIcon(self, icon: QIcon)¶
Set the
icon
to show in the interface for the factory object.See also
- Parameters:
icon (QIcon) –
- setTitle(self, title: str)¶
Set the
title
for the interface.See also
- Parameters:
title (str) –
- timerEvent(self, QTimerEvent)¶
- title(self) str ¶
The title of the panel.
See also
- Return type:
str