QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
A factory class for creating custom options pages. More...
#include <qgsoptionswidgetfactory.h>
Public Member Functions | |
QgsOptionsWidgetFactory ()=default | |
QgsOptionsWidgetFactory (const QString &title, const QIcon &icon, const QString &key=QString()) | |
Constructor. | |
virtual QgsOptionsPageWidget * | createWidget (QWidget *parent=nullptr) const =0 |
Factory function to create the widget on demand as needed by the options dialog. | |
virtual QIcon | icon () const |
The icon that will be shown in the UI for the panel. | |
virtual QString | key () const |
The key of the panel (untranslated title). | |
virtual QString | pagePositionHint () const |
Returns a tab name hinting at where this page should be inserted into the options properties tab list. | |
virtual QStringList | path () const |
Returns the path to place the widget page at, for options dialogs which are structured using a tree view. | |
void | setIcon (const QIcon &icon) |
Set the icon to show in the interface for the factory object. | |
void | setKey (const QString &key) |
Set the key for the interface. | |
void | setTitle (const QString &title) |
Set the title for the interface. | |
virtual QString | title () const |
The title of the panel. | |
A factory class for creating custom options pages.
Definition at line 110 of file qgsoptionswidgetfactory.h.
|
default |
|
inline |
Constructor.
Definition at line 119 of file qgsoptionswidgetfactory.h.
|
pure virtual |
Factory function to create the widget on demand as needed by the options dialog.
parent | The parent of the widget. |
|
inlinevirtual |
The icon that will be shown in the UI for the panel.
Definition at line 130 of file qgsoptionswidgetfactory.h.
|
inlinevirtual |
The key of the panel (untranslated title).
Definition at line 156 of file qgsoptionswidgetfactory.h.
|
inlinevirtual |
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.
Definition at line 176 of file qgsoptionswidgetfactory.h.
|
inlinevirtual |
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".
Definition at line 187 of file qgsoptionswidgetfactory.h.
|
inline |
Set the icon to show in the interface for the factory object.
Definition at line 136 of file qgsoptionswidgetfactory.h.
|
inline |
Set the key for the interface.
Definition at line 162 of file qgsoptionswidgetfactory.h.
|
inline |
Set the title for the interface.
Definition at line 148 of file qgsoptionswidgetfactory.h.
|
inlinevirtual |
The title of the panel.
Definition at line 142 of file qgsoptionswidgetfactory.h.