-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgseditorwidgetregistry.sip
182 lines (138 loc) · 6.58 KB
/
qgseditorwidgetregistry.sip
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/editorwidgets/core/qgseditorwidgetregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsEditorWidgetRegistry : QObject
{
%Docstring
This class manages all known edit widget factories.
QgsEditorWidgetRegistry is not usually directly created, but rather accessed through
QgsGui.editorWidgetRegistry().
%End
%TypeHeaderCode
#include "qgseditorwidgetregistry.h"
%End
public:
QgsEditorWidgetRegistry();
%Docstring
Constructor for QgsEditorWidgetRegistry. QgsEditorWidgetRegistry is not usually directly created, but rather accessed through
QgsGui.editorWidgetRegistry().
%End
void initEditors( QgsMapCanvas *mapCanvas = 0, QgsMessageBar *messageBar = 0 );
%Docstring
Registers all the default widgets.
Only call this once on startup of an application.
\param mapCanvas Specify a map canvas with which the widgets (relation reference) work
\param messageBar Specify a message bar on which messages by widgets will be shown while working with the map canvas
.. versionadded:: 2.8
.. note::
Not required for plugins, the QGIS application does that already
%End
~QgsEditorWidgetRegistry();
%Docstring
Destructor
Deletes all the registered widgets
%End
QgsEditorWidgetSetup findBest( const QgsVectorLayer *vl, const QString &fieldName ) const;
%Docstring
Find the best editor widget and its configuration for a given field.
\param vl The vector layer for which this widget will be created
\param fieldName The field name on the specified layer for which this widget will be created
:return: The id of the widget type to use and its config
:rtype: QgsEditorWidgetSetup
%End
QgsEditorWidgetWrapper *create( const QString &widgetId,
QgsVectorLayer *vl,
int fieldIdx,
const QVariantMap &config,
QWidget *editor,
QWidget *parent /TransferThis/ ) /Factory/;
%Docstring
Create an attribute editor widget wrapper of a given type for a given field.
The editor may be NULL if you want the widget wrapper to create a default widget.
\param widgetId The id of the widget type to create an attribute editor for
\param vl The vector layer for which this widget will be created
\param fieldIdx The field index on the specified layer for which this widget will be created
\param config A configuration which should be used for the widget creation
\param editor An editor widget which will be used instead of an autocreated widget
\param parent The parent which will be used for the created wrapper and the created widget
\param context The editor context (not available in Python bindings)
:return: A new widget wrapper
:rtype: QgsEditorWidgetWrapper
%End
QgsEditorWidgetWrapper *create( QgsVectorLayer *vl,
int fieldIdx,
QWidget *editor,
QWidget *parent /TransferThis/ ) /Factory/;
%Docstring
Create an attribute editor widget wrapper of the best type for a given field.
The editor may be NULL if you want the widget wrapper to create a default widget.
\param vl The vector layer for which this widget will be created
\param fieldIdx The field index on the specified layer for which this widget will be created
\param editor An editor widget which will be used instead of an autocreated widget
\param parent The parent which will be used for the created wrapper and the created widget
\param context The editor context (not available in Python bindings)
:return: A new widget wrapper
:rtype: QgsEditorWidgetWrapper
%End
QgsSearchWidgetWrapper *createSearchWidget( const QString &widgetId,
QgsVectorLayer *vl,
int fieldIdx,
const QVariantMap &config,
QWidget *parent /TransferThis/ ) /Factory/;
%Docstring
:rtype: QgsSearchWidgetWrapper
%End
QgsEditorConfigWidget *createConfigWidget( const QString &widgetId, QgsVectorLayer *vl, int fieldIdx, QWidget *parent /TransferThis/ ) /Factory/;
%Docstring
Creates a configuration widget
\param widgetId The id of the widget type to create a configuration widget for
\param vl The vector layer for which this widget will be created
\param fieldIdx The field index on the specified layer for which this widget will be created
\param parent The parent widget for the created widget
:return: A new configuration widget
:rtype: QgsEditorConfigWidget
%End
QString name( const QString &widgetId );
%Docstring
Get the human readable name for a widget type
\param widgetId The widget type to get the name for
:return: A human readable name
:rtype: str
%End
QMap<QString, QgsEditorWidgetFactory *> factories();
%Docstring
Get access to all registered factories
:return: All ids and factories
:rtype: QMap<str, QgsEditorWidgetFactory *>
%End
QgsEditorWidgetFactory *factory( const QString &widgetId );
%Docstring
Get a factory for the given widget type id.
:return: A factory or Null if not existent
:rtype: QgsEditorWidgetFactory
%End
bool registerWidget( const QString &widgetId, QgsEditorWidgetFactory *widgetFactory /Transfer/ );
%Docstring
Register a new widget factory with the given id
\param widgetId The id which will be used later to refer to this widget type
\param widgetFactory The factory which will create this widget type
:return: true, if successful, false, if the widgetId is already in use or widgetFactory is NULL
:rtype: bool
%End
void registerAutoConfPlugin( QgsEditorWidgetAutoConfPlugin *plugin );
%Docstring
Register a new auto-conf plugin.
\param plugin The plugin (ownership is transferred)
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/editorwidgets/core/qgseditorwidgetregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/