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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsexternalstoragefilewidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsExternalStorageFileWidget : QgsFileWidget
{
%Docstring(signature="appended")
The :py:class:`QgsExternalStorageFileWidget` class creates a widget for
selecting a file or a folder and stores it to a given external storage
backend if defined
.. versionadded:: 3.22
%End
%TypeHeaderCode
#include "qgsexternalstoragefilewidget.h"
%End
%ConvertToSubClassCode
if ( qobject_cast<QgsExternalStorageFileWidget *>( sipCpp ) )
sipType = sipType_QgsExternalStorageFileWidget;
else
sipType = NULL;
%End
public:
explicit QgsExternalStorageFileWidget( QWidget *parent /TransferThis/ = 0 );
%Docstring
QgsExternalStorageFileWidget creates a widget for selecting a file or a
folder.
%End
void setStorageType( const QString &storageType );
%Docstring
Set ``storageType`` storage type unique identifier as defined in
:py:class:`QgsExternalStorageRegistry` or null QString if there is no
storage defined. If no external storage has been defined,
QgsExternalStorageFileWidget will only update file path according to
selected files.
.. seealso:: :py:func:`storageType`
.. versionadded:: 3.22
%End
QString storageType() const;
%Docstring
Returns storage type unique identifier as defined in
:py:class:`QgsExternalStorageRegistry`. Returns null QString if there is
no storage defined, only file selection.
.. seealso:: :py:func:`setStorageType`
.. versionadded:: 3.22
%End
QgsExternalStorage *externalStorage() const;
%Docstring
Returns external storage used to store selected file names, None if none
have been defined. If no external storage has been defined,
QgsExternalStorageFileWidget will only update file path according to
selected files.
.. seealso:: :py:func:`setStorageType`
.. versionadded:: 3.22
%End
void setStorageAuthConfigId( const QString &authCfg );
%Docstring
Sets the authentication configuration ID to be used for the current
external storage (if defined)
.. versionadded:: 3.22
%End
const QString &storageAuthConfigId() const;
%Docstring
Returns the authentication configuration ID used for the current
external storage (if defined)
.. versionadded:: 3.22
%End
void setStorageUrlExpression( const QString &urlExpression );
%Docstring
Set ``urlExpression`` expression, which once evaluated, provide the URL
used to store selected documents. This is used only if an external
storage has been defined
.. seealso:: :py:func:`setStorageType`
.. seealso:: :py:func:`externalStorage`
.. versionadded:: 3.22
%End
QString storageUrlExpressionString() const;
%Docstring
Returns the original, unmodified expression string, which once
evaluated, provide the URL used to store selected documents. This is
used only if an external storage has been defined. Returns null if no
expression has been set.
.. seealso:: :py:func:`setStorageUrlExpression`
.. versionadded:: 3.22
%End
QgsExpression *storageUrlExpression() const;
%Docstring
Returns expression, which once evaluated, provide the URL used to store
selected documents. This is used only if an external storage has been
defined. Returns null if no expression has been set.
.. seealso:: :py:func:`setStorageUrlExpression`
.. versionadded:: 3.22
%End
void setExpressionContext( const QgsExpressionContext &context );
%Docstring
Set expression context to be used when for storage URL expression
evaluation
.. seealso:: :py:func:`setStorageUrlExpression`
.. versionadded:: 3.22
%End
const QgsExpressionContext &expressionContext() const;
%Docstring
Returns expression context used for storage url expression evaluation
.. seealso:: :py:func:`storageUrlExpression`
.. versionadded:: 3.22
%End
void setMessageBar( QgsMessageBar *messageBar );
%Docstring
Set ``messageBar`` to report messages
.. versionadded:: 3.22
%End
QgsMessageBar *messageBar() const;
%Docstring
Returns message bar used to report messages
.. versionadded:: 3.22
%End
static QgsExpressionContextScope *createFileWidgetScope();
%Docstring
Creates and Returns an expression context scope specific to
QgsExternalStorageFileWidget It defines the variable containing the user
selected file name
.. versionadded:: 3.22
%End
virtual void setReadOnly( bool readOnly );
protected:
virtual void updateLayout();
virtual void setSelectedFileNames( QStringList fileNames );
void addFileWidgetScope();
%Docstring
Add file widget specific scope to expression context
%End
virtual void dragEnterEvent( QDragEnterEvent *event );
virtual void dropEvent( QDropEvent *event );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsexternalstoragefilewidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
