QGIS API Documentation 3.41.0-Master (3440c17df1d)
Loading...
Searching...
No Matches
qgsexternalresourcewidgetwrapper.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsexternalresourcewidgetwrapper.cpp
3 --------------------------------------
4 begin : 16.12.2015
5 copyright : (C) 2015 by Denis Rouzaud
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
17#include "moc_qgsexternalresourcewidgetwrapper.cpp"
18
19#include <QPushButton>
20#include <QSettings>
21#include <QLabel>
22
23#include "qgsproject.h"
25#include "qgsfilterlineedit.h"
26#include "qgsapplication.h"
29
30
31QgsExternalResourceWidgetWrapper::QgsExternalResourceWidgetWrapper( QgsVectorLayer *layer, int fieldIdx, QWidget *editor, QgsMessageBar *messageBar, QWidget *parent )
32 : QgsEditorWidgetWrapper( layer, fieldIdx, editor, parent )
33 , mMessageBar( messageBar )
34{
35}
36
38{
39 if ( mQgsWidget )
40 {
41 return mQgsWidget->documentPath( field().type() );
42 }
43
44 if ( mLineEdit )
45 {
46 if ( mLineEdit->text().isEmpty() || mLineEdit->text() == QgsApplication::nullRepresentation() )
47 {
49 }
50 else
51 {
52 return mLineEdit->text();
53 }
54 }
55
57}
58
60{
61 if ( mLineEdit )
62 {
63 whileBlocking( mLineEdit )->clear();
64 }
65
66 if ( mLabel )
67 {
68 mLabel->clear();
69 }
70
71 if ( mQgsWidget )
72 {
73 whileBlocking( mQgsWidget )->setDocumentPath( QString() );
74 }
75}
76
78{
79 return mLineEdit || mLabel || mQgsWidget;
80}
81
82void QgsExternalResourceWidgetWrapper::updateProperties( const QgsFeature &feature )
83{
84 if ( mQgsWidget && mPropertyCollection.hasActiveProperties() )
85 {
87 expressionContext.setFeature( feature );
88 bool ok = false;
89
91 {
92 const QString path = mPropertyCollection.valueAsString( QgsEditorWidgetWrapper::Property::RootPath, expressionContext, QString(), &ok );
93 if ( ok )
94 {
95 mQgsWidget->setDefaultRoot( path );
96 }
97 }
99 {
100 const QString dvcString = mPropertyCollection.valueAsString( QgsEditorWidgetWrapper::Property::DocumentViewerContent, expressionContext, QStringLiteral( "NoContent" ), &ok );
101 if ( ok )
102 {
104 if ( dvcString.compare( QLatin1String( "image" ), Qt::CaseInsensitive ) == 0 )
105 {
107 }
108 else if ( dvcString.compare( QLatin1String( "audio" ), Qt::CaseInsensitive ) == 0 )
109 {
111 }
112 else if ( dvcString.compare( QLatin1String( "video" ), Qt::CaseInsensitive ) == 0 )
113 {
115 }
116 else if ( dvcString.compare( QLatin1String( "web" ), Qt::CaseInsensitive ) == 0 )
117 {
119 }
120 else
121 {
123 }
124 mQgsWidget->setDocumentViewerContent( dvc );
125 }
126 }
127 }
128}
129
131{
132 updateProperties( feature );
134
135 if ( mQgsWidget )
136 {
138 }
139}
140
142{
143 mForm = qobject_cast<QgsAttributeForm *>( parent );
144
145 if ( mForm )
147
148 return new QgsExternalResourceWidget( parent );
149}
150
152{
153 mLineEdit = qobject_cast<QLineEdit *>( editor );
154 mLabel = qobject_cast<QLabel *>( editor );
155 mQgsWidget = qobject_cast<QgsExternalResourceWidget *>( editor );
156
157 if ( mLineEdit )
158 {
159 QgsFilterLineEdit *fle = qobject_cast<QgsFilterLineEdit *>( editor );
160 if ( fle )
161 {
163 }
164 }
165 else
166 mLineEdit = editor->findChild<QLineEdit *>();
167
168 if ( mQgsWidget )
169 {
170 mQgsWidget->setMessageBar( mMessageBar );
171
173
174 const QVariantMap cfg = config();
175 mPropertyCollection.loadVariant( cfg.value( QStringLiteral( "PropertyCollection" ) ), propertyDefinitions() );
176
177 mQgsWidget->setStorageType( cfg.value( QStringLiteral( "StorageType" ) ).toString() );
178 mQgsWidget->setStorageAuthConfigId( cfg.value( QStringLiteral( "StorageAuthConfigId" ) ).toString() );
179
182 QgsExpression::quotedValue( cfg.value( QStringLiteral( "StorageUrl" ) ).toString() ) );
183
185
186 if ( cfg.contains( QStringLiteral( "UseLink" ) ) )
187 {
188 mQgsWidget->fileWidget()->setUseLink( cfg.value( QStringLiteral( "UseLink" ) ).toBool() );
189 }
190 if ( cfg.contains( QStringLiteral( "FullUrl" ) ) )
191 {
192 mQgsWidget->fileWidget()->setFullUrl( cfg.value( QStringLiteral( "FullUrl" ) ).toBool() );
193 }
194
196 {
197 mQgsWidget->setDefaultRoot( cfg.value( QStringLiteral( "DefaultRoot" ) ).toString() );
198 }
199 if ( cfg.contains( QStringLiteral( "StorageMode" ) ) )
200 {
201 mQgsWidget->fileWidget()->setStorageMode( ( QgsFileWidget::StorageMode )cfg.value( QStringLiteral( "StorageMode" ) ).toInt() );
202 }
203 if ( cfg.contains( QStringLiteral( "RelativeStorage" ) ) )
204 {
205 mQgsWidget->setRelativeStorage( ( QgsFileWidget::RelativeStorage )cfg.value( QStringLiteral( "RelativeStorage" ) ).toInt() );
206 }
207 if ( cfg.contains( QStringLiteral( "FileWidget" ) ) )
208 {
209 mQgsWidget->setFileWidgetVisible( cfg.value( QStringLiteral( "FileWidget" ) ).toBool() );
210 }
211 if ( cfg.contains( QStringLiteral( "FileWidgetButton" ) ) )
212 {
213 mQgsWidget->fileWidget()->setFileWidgetButtonVisible( cfg.value( QStringLiteral( "FileWidgetButton" ) ).toBool() );
214 }
215 if ( cfg.contains( QStringLiteral( "DocumentViewer" ) ) )
216 {
217 mQgsWidget->setDocumentViewerContent( ( QgsExternalResourceWidget::DocumentViewerContent )cfg.value( QStringLiteral( "DocumentViewer" ) ).toInt() );
218 }
219 if ( cfg.contains( QStringLiteral( "FileWidgetFilter" ) ) )
220 {
221 mQgsWidget->fileWidget()->setFilter( cfg.value( QStringLiteral( "FileWidgetFilter" ) ).toString() );
222 }
223 if ( cfg.contains( QStringLiteral( "DocumentViewerHeight" ) ) )
224 {
225 mQgsWidget->setDocumentViewerHeight( cfg.value( QStringLiteral( "DocumentViewerHeight" ) ).toInt( ) );
226 }
227 if ( cfg.contains( QStringLiteral( "DocumentViewerWidth" ) ) )
228 {
229 mQgsWidget->setDocumentViewerWidth( cfg.value( QStringLiteral( "DocumentViewerWidth" ) ).toInt( ) );
230 }
231 }
232
233 if ( mLineEdit )
234 connect( mLineEdit, &QLineEdit::textChanged, this, [ = ]( const QString & value )
235 {
237 emit valueChanged( value );
239 emit valuesChanged( value );
240 } );
241
242}
243
244void QgsExternalResourceWidgetWrapper::updateValues( const QVariant &value, const QVariantList & )
245{
246 if ( mLineEdit )
247 {
249 {
250 mLineEdit->setText( QgsApplication::nullRepresentation() );
251 }
252 else
253 {
254 mLineEdit->setText( value.toString() );
255 }
256 }
257
258 if ( mLabel )
259 {
260 mLabel->setText( value.toString() );
262 emit valueChanged( value.toString() );
264 emit valuesChanged( value.toString() ); // emit signal that value has changed, do not do it for other widgets
265 }
266
267 if ( mQgsWidget )
268 {
270 {
272 }
273 else
274 {
275 mQgsWidget->setDocumentPath( value.toString() );
276 }
277 }
278}
279
281{
282 if ( mLineEdit )
283 mLineEdit->setReadOnly( !enabled );
284
285 if ( mQgsWidget )
286 mQgsWidget->setReadOnly( !enabled );
287}
288
289void QgsExternalResourceWidgetWrapper::widgetValueChanged( const QString &attribute, const QVariant &newValue, bool attributeChanged )
290{
291 Q_UNUSED( newValue );
292 if ( attributeChanged )
293 {
296
297 if ( documentViewerContentExp.referencedColumns().contains( attribute ) ||
298 rootPathExp.referencedColumns().contains( attribute ) )
299 {
300 const QgsFeature feature = mForm->currentFormFeature();
301 updateProperties( feature );
302 }
303 }
304}
305
306void QgsExternalResourceWidgetWrapper::updateConstraintWidgetStatus()
307{
308 if ( mLineEdit )
309 {
311 {
312 widget()->setStyleSheet( QString() );
313 }
314 else
315 {
316 switch ( constraintResult() )
317 {
319 mLineEdit->setStyleSheet( QString() );
320 break;
321
323 mLineEdit->setStyleSheet( QStringLiteral( "QgsFilterLineEdit { background-color: #dd7777; }" ) );
324 break;
325
327 mLineEdit->setStyleSheet( QStringLiteral( "QgsFilterLineEdit { background-color: #ffd85d; }" ) );
328 break;
329 }
330 }
331 }
332}
333
335{
336 if ( !mQgsWidget || !layer() )
337 return;
338
339 QgsExpressionContext expressionContext( layer()->createExpressionContext() );
340 expressionContext.setFeature( formFeature() );
342 if ( context().parentFormFeature().isValid() )
343 {
344 expressionContext.appendScope( QgsExpressionContextUtils::parentFormScope( context().parentFormFeature() ) );
345 }
346
347 mQgsWidget->fileWidget()->setExpressionContext( expressionContext );
348}
QString valueAsString(int key, const QgsExpressionContext &context, const QString &defaultString=QString(), bool *ok=nullptr) const
Calculates the current value of the property with the specified key and interprets it as a string.
static QString nullRepresentation()
Returns the string used to represent the value NULL throughout QGIS.
void widgetValueChanged(const QString &attribute, const QVariant &value, bool attributeChanged)
Notifies about changes of attributes.
QgsFeature currentFormFeature() const
Returns the feature that is currently displayed in the form with all the changes received on editing ...
Manages an editor widget Widget and wrapper share the same parent.
QgsFeature formFeature() const
The feature currently being edited, in its current state.
Q_DECL_DEPRECATED void valueChanged(const QVariant &value)
Emit this signal, whenever the value changed.
void setFeature(const QgsFeature &feature) override
Will be called when the feature changes.
void valuesChanged(const QVariant &value, const QVariantList &additionalFieldValues=QVariantList())
Emit this signal, whenever the value changed.
QgsField field() const
Access the field.
@ ConstraintResultFailSoft
Widget failed at least one soft (non-enforced) constraint.
@ ConstraintResultPass
Widget passed constraints successfully.
@ ConstraintResultFailHard
Widget failed at least one hard (enforced) constraint.
static QgsExpressionContextScope * parentFormScope(const QgsFeature &formFeature=QgsFeature(), const QString &formMode=QString())
Creates a new scope which contains functions and variables from the current parent attribute form/tab...
static QgsExpressionContextScope * formScope(const QgsFeature &formFeature=QgsFeature(), const QString &formMode=QString())
Creates a new scope which contains functions and variables from the current attribute form/table form...
static QList< QgsExpressionContextScope * > globalProjectLayerScopes(const QgsMapLayer *layer)
Creates a list of three scopes: global, layer's project and layer.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
void appendScope(QgsExpressionContextScope *scope)
Appends a scope to the end of the context.
void setFeature(const QgsFeature &feature)
Convenience function for setting a feature for the context.
Class for parsing and evaluation of expressions (formerly called "search strings").
static QString quotedValue(const QVariant &value)
Returns a string representation of a literal value, including appropriate quotations where required.
QSet< QString > referencedColumns() const
Gets list of columns referenced by the expression.
void updateFileWidgetExpressionContext()
Update file widget current expression context according to layer, feature, and parent feature.
void setFeature(const QgsFeature &feature) override
bool valid() const override
Returns true if the widget has been properly initialized.
QVariant value() const override
Will be used to access the widget's value.
QWidget * createWidget(QWidget *parent) override
This method should create a new widget with the provided parent.
void showIndeterminateState() override
Sets the widget to display in an indeterminate "mixed value" state.
void widgetValueChanged(const QString &attribute, const QVariant &newValue, bool attributeChanged)
Will be called when a value in the current edited form or table row changes.
void initWidget(QWidget *editor) override
This method should initialize the editor widget with runtime data.
QgsExternalResourceWidgetWrapper(QgsVectorLayer *layer, int fieldIdx, QWidget *editor=nullptr, QgsMessageBar *messageBar=nullptr, QWidget *parent=nullptr)
Constructor for QgsExternalResourceWidgetWrapper.
Widget to display file path with a push button for an "open file" dialog It can also be used to displ...
void setDocumentPath(const QVariant &documentPath)
void setMessageBar(QgsMessageBar *messageBar)
Set messageBar to report messages.
void setStorageAuthConfigId(const QString &authCfg)
Sets the authentication configuration ID to be used for the current external storage (if defined)
QgsExternalStorageFileWidget * fileWidget()
Returns file widget to allow its configuration.
void setStorageType(const QString &storageType)
Set storageType storage type unique identifier as defined in QgsExternalStorageRegistry or null QStri...
void setRelativeStorage(QgsFileWidget::RelativeStorage relativeStorage)
Configures if paths are handled absolute or relative and if relative, which should be the base path.
void setDocumentViewerHeight(int height)
setDocumentViewerWidth set the height of the document viewer.
void setDocumentViewerContent(QgsExternalResourceWidget::DocumentViewerContent content)
setDocumentViewerContent defines the type of content to be shown. Widget will be adapted accordingly
void setDefaultRoot(const QString &defaultRoot)
Configures the base path which should be used if the relativeStorage property is set to QgsFileWidget...
void setDocumentViewerWidth(int width)
setDocumentViewerWidth set the width of the document viewer.
void setFileWidgetVisible(bool visible)
Sets the visibility of the file widget in the layout.
QVariant documentPath(QMetaType::Type type=QMetaType::Type::QString) const
documentPath returns the path of the current document in the widget
void setReadOnly(bool readOnly)
defines if the widget is readonly
void setExpressionContext(const QgsExpressionContext &context)
Set expression context to be used when for storage URL expression evaluation.
void setStorageUrlExpression(const QString &urlExpression)
Set urlExpression expression, which once evaluated, provide the URL used to store selected documents.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:58
StorageMode
The StorageMode enum determines if the file picker should pick files or directories.
@ GetFile
Select a single file.
void setFullUrl(bool fullUrl)
Sets whether links shown use the full path.
RelativeStorage
The RelativeStorage enum determines if path is absolute, relative to the current project path or rela...
void setStorageMode(QgsFileWidget::StorageMode storageMode)
Sets the widget's storage mode (i.e.
void setUseLink(bool useLink)
Sets whether the file path will be shown as a link.
void setFileWidgetButtonVisible(bool visible)
Sets whether the tool button is visible.
void setFilter(const QString &filter)
setFilter sets the filter used by the model to filters.
QLineEdit subclass with built in support for clearing the widget's value and handling custom null val...
void setNullValue(const QString &nullValue)
Sets the string representation for null values in the widget.
A bar for displaying non-blocking messages to the user.
bool isActive(int key) const final
Returns true if the collection contains an active property with the specified key.
bool loadVariant(const QVariant &configuration, const QgsPropertiesDefinition &definitions) final
Loads this property collection from a QVariantMap, wrapped in a QVariant.
bool hasActiveProperties() const final
Returns true if the collection has any active properties, or false if all properties within the colle...
QgsProperty property(int key) const final
Returns a matching property from the collection, if one exists.
QString asExpression() const
Returns an expression string representing the state of the property, or an empty string if the proper...
QString expressionString() const
Returns the expression used for the property value.
static bool isNull(const QVariant &variant, bool silenceNullWarnings=false)
Returns true if the specified variant should be considered a NULL value.
static QVariant createNullVariant(QMetaType::Type metaType)
Helper method to properly create a null QVariant from a metaType Returns the created QVariant.
Represents a vector layer which manages a vector based data sets.
QWidget * widget()
Access the widget managed by this wrapper.
static const QgsPropertiesDefinition & propertyDefinitions()
Returns the editor widget property definitions.
const QgsAttributeEditorContext & context() const
Returns information about the context in which this widget is shown.
QgsVectorLayer * layer() const
Returns the vector layer associated with the widget.
QgsPropertyCollection mPropertyCollection
Data defined property collection.
QVariantMap config() const
Returns the whole config.
@ DocumentViewerContent
Document type for external resource.
@ StorageUrl
Storage URL for external resource.
@ RootPath
Root path for external resource.
#define Q_NOWARN_DEPRECATED_POP
Definition qgis.h:6535
#define Q_NOWARN_DEPRECATED_PUSH
Definition qgis.h:6534
QgsSignalBlocker< Object > whileBlocking(Object *object)
Temporarily blocks signals from a QObject while calling a single method from the object.
Definition qgis.h:5862