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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsexternalresourcewidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
%ModuleHeaderCode
// fix to allow compilation with sip that for some reason
// doesn't add this include to the file where the code from
// ConvertToSubClassCode goes.
#include <qgsexternalresourcewidget.h>
#include <qgsexternalstoragefilewidget.h>
%End
class QgsExternalResourceWidget : QWidget
{
%Docstring(signature="appended")
Widget to display file path with a push button for an "open file" dialog
It can also be used to display a picture or a web page.
%End
%TypeHeaderCode
#include "qgsexternalresourcewidget.h"
%End
%ConvertToSubClassCode
if ( qobject_cast<QgsExternalResourceWidget *>( sipCpp ) )
sipType = sipType_QgsExternalResourceWidget;
else
sipType = NULL;
%End
public:
enum DocumentViewerContent /BaseType=IntEnum/
{
NoContent,
Image,
Web,
Audio,
Video,
};
explicit QgsExternalResourceWidget( QWidget *parent /TransferThis/ = 0 );
%Docstring
QgsExternalResourceWidget creates a widget with a file widget and a
document viewer Both part of the widget are optional.
.. seealso:: :py:class:`QgsFileWidget`
%End
QVariant documentPath( QMetaType::Type type = QMetaType::Type::QString ) const;
%Docstring
documentPath returns the path of the current document in the widget
:param type: determines the type of the returned null variant if the
document is not defined yet
%End
QVariant documentPath( QVariant::Type type ) const /Deprecated/;
%Docstring
documentPath returns the path of the current document in the widget
:param type: determines the type of the returned null variant if the
document is not defined yet
.. deprecated:: 3.38
Use the method with a QMetaType.Type argument instead.
%End
void setDocumentPath( const QVariant &documentPath );
QgsExternalStorageFileWidget *fileWidget();
%Docstring
Returns file widget to allow its configuration
%End
bool fileWidgetVisible() const;
%Docstring
returns if the file widget is visible in the widget
%End
void setFileWidgetVisible( bool visible );
%Docstring
Sets the visibility of the file widget in the layout
%End
QgsExternalResourceWidget::DocumentViewerContent documentViewerContent() const;
%Docstring
returns the type of content used in the document viewer
%End
void setDocumentViewerContent( QgsExternalResourceWidget::DocumentViewerContent content );
%Docstring
setDocumentViewerContent defines the type of content to be shown. Widget
will be adapted accordingly
%End
int documentViewerHeight() const;
%Docstring
returns the height of the document viewer
%End
void setDocumentViewerHeight( int height );
%Docstring
setDocumentViewerWidth set the height of the document viewer.
:param height: the height. Use 0 for automatic best display.
%End
int documentViewerWidth() const;
%Docstring
returns the width of the document viewer
%End
void setDocumentViewerWidth( int width );
%Docstring
setDocumentViewerWidth set the width of the document viewer.
:param width: the width. Use 0 for automatic best display.
%End
void setReadOnly( bool readOnly );
%Docstring
defines if the widget is readonly
%End
QgsFileWidget::RelativeStorage relativeStorage() const;
%Docstring
Configures if paths are handled absolute or relative and if relative,
which should be the base path.
%End
void setRelativeStorage( QgsFileWidget::RelativeStorage relativeStorage );
%Docstring
Configures if paths are handled absolute or relative and if relative,
which should be the base path.
%End
QString defaultRoot() const;
%Docstring
Configures the base path which should be used if the relativeStorage
property is set to :py:class:`QgsFileWidget`.RelativeDefaultPath.
%End
void setDefaultRoot( const QString &defaultRoot );
%Docstring
Configures the base path which should be used if the relativeStorage
property is set to :py:class:`QgsFileWidget`.RelativeDefaultPath.
%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, only file selection.
.. 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
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
QString storageAuthConfigId() const;
%Docstring
Returns the authentication configuration ID used for the current
external storage (if defined)
.. 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
signals:
void valueChanged( const QString &value );
%Docstring
Emitted as soon as the current document changes
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsexternalresourcewidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
