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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsdatasourceselectdialog.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsDataSourceSelectWidget : QgsPanelWidget
{
%Docstring(signature="appended")
The :py:class:`QgsDataSourceSelectWidget` class embeds the browser view
to select an existing data source.
By default any layer type can be chosen, the valid layer type can be
restricted by setting a layer type filter with
setLayerTypeFilter(layerType) or by activating the filter directly from
the constructor.
To retrieve the selected data source, :py:func:`~uri` can be called and
it will return a (possibly invalid) :py:class:`QgsMimeDataUtils`.Uri.
.. versionadded:: 3.14
%End
%TypeHeaderCode
#include "qgsdatasourceselectdialog.h"
%End
public:
QgsDataSourceSelectWidget( QgsBrowserGuiModel *browserModel = 0, bool setFilterByLayerType = false, Qgis::LayerType layerType = Qgis::LayerType::Vector, QWidget *parent = 0 );
%Docstring
Constructs a QgsDataSourceSelectWidget, optionally filtering by layer
type
:param browserModel: an existing browser model (typically from app), if
``None`` an instance will be created
:param setFilterByLayerType: activates filtering by layer type
:param layerType: sets the layer type filter, this is in effect only if
filtering by layer type is also active
:param parent: the object
%End
~QgsDataSourceSelectWidget();
void setLayerTypeFilter( Qgis::LayerType layerType );
%Docstring
Sets layer type filter to ``layerType`` and activates the filtering
%End
void setDescription( const QString &description );
%Docstring
Sets a description label
:param description: a description string
.. note::
the description will be displayed at the bottom of the dialog
.. versionadded:: 3.8
%End
void expandPath( const QString &path, bool selectPath = false );
%Docstring
Expands out a file ``path`` in the view.
The ``path`` must correspond to a valid directory existing on the file
system.
Since QGIS 3.38 the ``selectPath`` argument can be used to automatically
select the path too.
.. versionadded:: 3.28
%End
QgsMimeDataUtils::Uri uri() const;
%Docstring
Returns the (possibly invalid) uri of the selected data source
%End
void showFilterWidget( bool visible );
%Docstring
Show/hide filter widget
%End
void setFilterSyntax( QAction * );
%Docstring
Sets filter syntax
%End
void setCaseSensitive( bool caseSensitive );
%Docstring
Sets filter case sensitivity
%End
void setFilter();
%Docstring
Apply filter to the model
%End
virtual void showEvent( QShowEvent *e );
%Docstring
Scroll to last selected index and expand it's children
%End
virtual void dragEnterEvent( QDragEnterEvent *event );
virtual void dropEvent( QDropEvent *event );
signals:
void validationChanged( bool isValid );
%Docstring
This signal is emitted whenever the validation status of the widget
changes.
:param isValid: ``True`` if the current status of the widget is valid
%End
void selectionChanged();
%Docstring
Emitted when the current selection changes in the widget.
%End
void itemTriggered( const QgsMimeDataUtils::Uri &uri );
%Docstring
Emitted when an item is triggered, e.g. via a double-click.
%End
};
class QgsDataSourceSelectDialog : QDialog
{
%Docstring(signature="appended")
The :py:class:`QgsDataSourceSelectDialog` class embeds the browser view
to select an existing data source.
By default any layer type can be chosen, the valid layer type can be
restricted by setting a layer type filter with
setLayerTypeFilter(layerType) or by activating the filter directly from
the constructor.
To retrieve the selected data source, :py:func:`~uri` can be called and
it will return a (possibly invalid) :py:class:`QgsMimeDataUtils`.Uri.
.. versionadded:: 3.6
%End
%TypeHeaderCode
#include "qgsdatasourceselectdialog.h"
%End
public:
QgsDataSourceSelectDialog( QgsBrowserGuiModel *browserModel = 0, bool setFilterByLayerType = false, Qgis::LayerType layerType = Qgis::LayerType::Vector, QWidget *parent = 0 );
%Docstring
Constructs a QgsDataSourceSelectDialog, optionally filtering by layer
type
:param browserModel: an existing browser model (typically from app), if
``None`` an instance will be created
:param setFilterByLayerType: activates filtering by layer type
:param layerType: sets the layer type filter, this is in effect only if
filtering by layer type is also active
:param parent: the object
%End
void setLayerTypeFilter( Qgis::LayerType layerType );
%Docstring
Sets layer type filter to ``layerType`` and activates the filtering
%End
void setDescription( const QString &description );
%Docstring
Sets a description label
:param description: a description string
.. note::
the description will be displayed at the bottom of the dialog
.. versionadded:: 3.8
%End
void expandPath( const QString &path, bool selectPath = false );
%Docstring
Expands out a file ``path`` in the view.
The ``path`` must correspond to a valid directory existing on the file
system.
Since QGIS 3.38 the ``selectPath`` argument can be used to automatically
select the path too.
.. versionadded:: 3.28
%End
QgsMimeDataUtils::Uri uri() const;
%Docstring
Returns the (possibly invalid) uri of the selected data source
%End
void showFilterWidget( bool visible );
%Docstring
Show/hide filter widget
%End
void setFilterSyntax( QAction * );
%Docstring
Sets filter syntax
%End
void setCaseSensitive( bool caseSensitive );
%Docstring
Sets filter case sensitivity
%End
void setFilter();
%Docstring
Apply filter to the model
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsdatasourceselectdialog.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
