1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsoptionswidgetfactory.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsOptionsPageWidget : QWidget
{
%Docstring(signature="appended")
Base class for widgets for pages included in the options dialog.
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgsoptionswidgetfactory.h"
%End
public:
QgsOptionsPageWidget( QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsOptionsPageWidget.
%End
virtual QString helpKey() const;
%Docstring
Returns the optional help key for the options page. The default implementation
returns an empty string.
If a non-empty string is returned by this method, it will be used as the help key
retrieved when the "help" button is clicked while this options page is active.
If an empty string is returned by this method the default QGIS options
help will be retrieved.
%End
public slots:
virtual void apply() = 0;
%Docstring
Called to permanently apply the settings shown in the options page (e.g. save them to
:py:class:`QgsSettings` objects). This is usually called when the options dialog is accepted.
%End
protected:
void registerHighlightWidget( QgsOptionsDialogHighlightWidget *highlightWidget );
%Docstring
Register a highlight widget to be used to search and highlight text in
options dialogs. This can be used to provide a custom implementation of
:py:class:`QgsOptionsDialogHighlightWidget`.
%End
};
class QgsOptionsWidgetFactory : QObject
{
%TypeHeaderCode
#include "qgsoptionswidgetfactory.h"
%End
public:
QgsOptionsWidgetFactory();
%Docstring
Constructor
%End
QgsOptionsWidgetFactory( const QString &title, const QIcon &icon );
%Docstring
Constructor
%End
virtual QIcon icon() const;
%Docstring
The icon that will be shown in the UI for the panel.
:return: A QIcon for the panel icon.
.. seealso:: :py:func:`setIcon`
%End
void setIcon( const QIcon &icon );
%Docstring
Set the ``icon`` to show in the interface for the factory object.
.. seealso:: :py:func:`icon`
%End
virtual QString title() const;
%Docstring
The title of the panel.
.. seealso:: :py:func:`setTitle`
%End
void setTitle( const QString &title );
%Docstring
Set the ``title`` for the interface.
.. seealso:: :py:func:`title`
%End
virtual QString pagePositionHint() const;
%Docstring
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.
.. versionadded:: 3.18
%End
virtual QStringList path() const;
%Docstring
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".
.. versionadded:: 3.22
%End
virtual QgsOptionsPageWidget *createWidget( QWidget *parent = 0 ) const = 0 /Factory/;
%Docstring
Factory function to create the widget on demand as needed by the options dialog.
:param parent: The parent of the widget.
:return: A new widget to show as a page in the options dialog.
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsoptionswidgetfactory.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
|
