QGIS API Documentation 3.38.0-Grenoble (exported)
Loading...
Searching...
No Matches
qgsqmlwidgetwrapper.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsqmlwidgetwrapper.cpp
3
4 ---------------------
5 begin : 25.6.2018
6 copyright : (C) 2018 by Matthias Kuhn
8 ***************************************************************************
9 * *
10 * This program is free software; you can redistribute it and/or modify *
11 * it under the terms of the GNU General Public License as published by *
12 * the Free Software Foundation; either version 2 of the License, or *
13 * (at your option) any later version. *
14 * *
15 ***************************************************************************/
16
17#include "qgsqmlwidgetwrapper.h"
18#include "qgsattributeform.h"
19#include "qgsmessagelog.h"
22
23#include <QQmlContext>
24#include <QQmlEngine>
25#include <QUrl>
26
27QgsQmlWidgetWrapper::QgsQmlWidgetWrapper( QgsVectorLayer *layer, QWidget *editor, QWidget *parent )
28 : QgsWidgetWrapper( layer, editor, parent )
29{
30 connect( this, &QgsWidgetWrapper::contextChanged, this, &QgsQmlWidgetWrapper::setQmlContext );
31}
32
34{
35 return true;
36}
37
38QWidget *QgsQmlWidgetWrapper::createWidget( QWidget *parent )
39{
40 QgsAttributeForm *form = qobject_cast<QgsAttributeForm *>( parent );
41
42 if ( form )
43 {
44 mFormFeature = form->feature();
45 connect( form, &QgsAttributeForm::widgetValueChanged, this, [ = ]( const QString & attribute, const QVariant & newValue, bool attributeChanged )
46 {
47 if ( attributeChanged )
48 {
49 if ( mRequiresFormScope )
50 {
51 mFormFeature.setAttribute( attribute, newValue );
52 setQmlContext();
53 }
54 }
55 } );
56 }
57
58 return new QQuickWidget( parent );
59}
60
61void QgsQmlWidgetWrapper::initWidget( QWidget *editor )
62{
63 mWidget = qobject_cast<QQuickWidget *>( editor );
64
65 if ( !mWidget )
66 return;
67
68
69 if ( !mQmlFile.open() )
70 {
71 QgsMessageLog::logMessage( tr( "Failed to open temporary QML file" ) );
72 return;
73 }
74
75 mWidget->setSource( QUrl::fromLocalFile( mQmlFile.fileName() ) );
76
77 mQmlFile.close();
78}
79
80
82{
83 if ( !mWidget )
84 return;
85
86 mWidget->engine()->clearComponentCache();
87
88 initWidget( mWidget );
89}
90
91void QgsQmlWidgetWrapper::setQmlCode( const QString &qmlCode )
92{
93 if ( mQmlCode == qmlCode )
94 {
95 return;
96 }
97
98 mQmlCode = qmlCode;
99
100 bool ok = false;
101 const thread_local QRegularExpression expRe( QStringLiteral( R"re(expression.evaluate\s*\‍(\s*"(.*)"\))re" ), QRegularExpression::PatternOption::MultilineOption | QRegularExpression::PatternOption::DotMatchesEverythingOption );
102 QRegularExpressionMatchIterator matchIt = expRe.globalMatch( mQmlCode );
103 while ( !ok && matchIt.hasNext() )
104 {
105 const QRegularExpressionMatch match = matchIt.next();
106 const QgsExpression exp = match.captured( 1 );
108 }
109 mRequiresFormScope = ok;
110
111 if ( !mQmlFile.open() )
112 {
113 QgsMessageLog::logMessage( tr( "Failed to open temporary QML file" ) );
114 return;
115 }
116
117 mQmlFile.resize( 0 );
118 mQmlFile.write( mQmlCode.toUtf8() );
119
120 mQmlFile.close();
121}
122
123void QgsQmlWidgetWrapper::setQmlContext( )
124{
125 if ( !mWidget )
126 return;
127
128 const QgsAttributeEditorContext attributecontext = context();
129 QgsExpressionContext expressionContext = layer()->createExpressionContext();
130 expressionContext << QgsExpressionContextUtils::formScope( mFormFeature, attributecontext.attributeFormModeString() );
131 if ( attributecontext.parentFormFeature().isValid() )
132 {
133 expressionContext << QgsExpressionContextUtils::parentFormScope( attributecontext.parentFormFeature() );
134 }
135
136 expressionContext.setFeature( mFeature );
137
138 QmlExpression *qmlExpression = new QmlExpression();
139 qmlExpression->setExpressionContext( expressionContext );
140
141 mWidget->rootContext()->setContextProperty( "expression", qmlExpression );
142}
143
145{
146 if ( !mWidget )
147 return;
148
149 mFeature = feature;
150 mFormFeature = feature;
151
152 setQmlContext();
153}
154
156void QmlExpression::setExpressionContext( const QgsExpressionContext &context )
157{
158 mExpressionContext = context;
159}
160
161QVariant QmlExpression::evaluate( const QString &expression ) const
162{
163 QgsExpression exp = QgsExpression( expression );
164 exp.prepare( &mExpressionContext );
165 return exp.evaluate( &mExpressionContext );
166}
This class contains context information for attribute editor widgets.
QString attributeFormModeString() const
Returns given attributeFormMode as string.
QgsFeature parentFormFeature() const
Returns the feature of the currently edited parent form in its actual state.
void widgetValueChanged(const QString &attribute, const QVariant &value, bool attributeChanged)
Notifies about changes of attributes.
const QgsFeature & feature()
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...
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
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").
bool prepare(const QgsExpressionContext *context)
Gets the expression ready for evaluation - find out column indexes.
QVariant evaluate()
Evaluate the feature and return the result.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:58
Q_INVOKABLE bool setAttribute(int field, const QVariant &attr)
Sets an attribute's value by field index.
bool isValid() const
Returns the validity of this feature.
static void logMessage(const QString &message, const QString &tag=QString(), Qgis::MessageLevel level=Qgis::MessageLevel::Warning, bool notifyUser=true)
Adds a message to the log instance (and creates it if necessary).
QWidget * createWidget(QWidget *parent) override
This method should create a new widget with the provided parent.
void initWidget(QWidget *editor) override
This method should initialize the editor widget with runtime data.
bool valid() const override
Returns true if the widget has been properly initialized.
void setFeature(const QgsFeature &feature) override
void reinitWidget()
Clears the content and makes new initialization.
void setQmlCode(const QString &qmlCode)
writes the qmlCode into a temporary file
QgsQmlWidgetWrapper(QgsVectorLayer *layer, QWidget *editor, QWidget *parent)
Create a qml widget wrapper.
static bool expressionRequiresFormScope(const QString &expression)
Check if the expression requires a form scope (i.e.
Represents a vector layer which manages a vector based data sets.
QgsExpressionContext createExpressionContext() const FINAL
This method needs to be reimplemented in all classes which implement this interface and return an exp...
Manages an editor widget Widget and wrapper share the same parent.
void contextChanged()
Signal when QgsAttributeEditorContext mContext changed.
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.