QGIS API Documentation 3.27.0-Master (f261cc1f8b)
qgsvaluerelationconfigdlg.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsvaluerelationconfigdlg.cpp
3 --------------------------------------
4 Date : 5.1.2014
5 Copyright : (C) 2014 Matthias Kuhn
6 Email : matthias at opengis dot ch
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 "qgsproject.h"
18#include "qgsvectorlayer.h"
22
24 : QgsEditorConfigWidget( vl, fieldIdx, parent )
25{
26 setupUi( this );
27 mLayerName->setFilters( QgsMapLayerProxyModel::VectorLayer );
28 mKeyColumn->setLayer( mLayerName->currentLayer() );
29 mValueColumn->setLayer( mLayerName->currentLayer() );
30 mDescriptionExpression->setLayer( mLayerName->currentLayer() );
31 connect( mLayerName, &QgsMapLayerComboBox::layerChanged, mKeyColumn, &QgsFieldComboBox::setLayer );
32 connect( mLayerName, &QgsMapLayerComboBox::layerChanged, mValueColumn, &QgsFieldComboBox::setLayer );
33 connect( mLayerName, &QgsMapLayerComboBox::layerChanged, mDescriptionExpression, &QgsFieldExpressionWidget::setLayer );
34 connect( mLayerName, &QgsMapLayerComboBox::layerChanged, this, &QgsValueRelationConfigDlg::layerChanged );
35 connect( mEditExpression, &QAbstractButton::clicked, this, &QgsValueRelationConfigDlg::editExpression );
36
37 mNofColumns->setMinimum( 1 );
38 mNofColumns->setMaximum( 10 );
39 mNofColumns->setValue( 1 );
40
42 connect( mKeyColumn, static_cast<void ( QComboBox::* )( int )>( &QComboBox::currentIndexChanged ), this, &QgsEditorConfigWidget::changed );
43 connect( mValueColumn, static_cast<void ( QComboBox::* )( int )>( &QComboBox::currentIndexChanged ), this, &QgsEditorConfigWidget::changed );
44 connect( mDescriptionExpression, static_cast<void ( QgsFieldExpressionWidget::* )( const QString & )>( &QgsFieldExpressionWidget::fieldChanged ), this, &QgsEditorConfigWidget::changed );
45 connect( mAllowMulti, &QAbstractButton::toggled, this, &QgsEditorConfigWidget::changed );
46 connect( mAllowNull, &QAbstractButton::toggled, this, &QgsEditorConfigWidget::changed );
47 connect( mOrderByValue, &QAbstractButton::toggled, this, &QgsEditorConfigWidget::changed );
48 connect( mFilterExpression, &QTextEdit::textChanged, this, &QgsEditorConfigWidget::changed );
49 connect( mUseCompleter, &QAbstractButton::toggled, this, &QgsEditorConfigWidget::changed );
50 connect( mAllowMulti, &QAbstractButton::toggled, this, [ = ]( bool checked )
51 {
52 label_nofColumns->setEnabled( checked );
53 mNofColumns->setEnabled( checked );
54 }
55 );
56
57 connect( mNofColumns, static_cast < void ( QSpinBox::* )( int ) > ( &QSpinBox::valueChanged ), this, &QgsEditorConfigWidget::changed );
58
59 layerChanged();
60}
61
63{
64 QVariantMap cfg;
65
66 cfg.insert( QStringLiteral( "Layer" ), mLayerName->currentLayer() ? mLayerName->currentLayer()->id() : QString() );
67 cfg.insert( QStringLiteral( "LayerName" ), mLayerName->currentLayer() ? mLayerName->currentLayer()->name() : QString() );
68 cfg.insert( QStringLiteral( "LayerSource" ), mLayerName->currentLayer() ? mLayerName->currentLayer()->publicSource() : QString() );
69 cfg.insert( QStringLiteral( "LayerProviderName" ), ( mLayerName->currentLayer() && mLayerName->currentLayer()->dataProvider() ) ?
70 mLayerName->currentLayer()->providerType() :
71 QString() );
72 cfg.insert( QStringLiteral( "Key" ), mKeyColumn->currentField() );
73 cfg.insert( QStringLiteral( "Value" ), mValueColumn->currentField() );
74 cfg.insert( QStringLiteral( "Description" ), mDescriptionExpression->expression() );
75 cfg.insert( QStringLiteral( "AllowMulti" ), mAllowMulti->isChecked() );
76 cfg.insert( QStringLiteral( "NofColumns" ), mNofColumns->value() );
77 cfg.insert( QStringLiteral( "AllowNull" ), mAllowNull->isChecked() );
78 cfg.insert( QStringLiteral( "OrderByValue" ), mOrderByValue->isChecked() );
79 cfg.insert( QStringLiteral( "FilterExpression" ), mFilterExpression->toPlainText() );
80 cfg.insert( QStringLiteral( "UseCompleter" ), mUseCompleter->isChecked() );
81
82 return cfg;
83}
84
85void QgsValueRelationConfigDlg::setConfig( const QVariantMap &config )
86{
88 mLayerName->setLayer( lyr );
89 mKeyColumn->setField( config.value( QStringLiteral( "Key" ) ).toString() );
90 mValueColumn->setField( config.value( QStringLiteral( "Value" ) ).toString() );
91 mDescriptionExpression->setField( config.value( QStringLiteral( "Description" ) ).toString() );
92 mAllowMulti->setChecked( config.value( QStringLiteral( "AllowMulti" ) ).toBool() );
93 mNofColumns->setValue( config.value( QStringLiteral( "NofColumns" ), 1 ).toInt() );
94 if ( !mAllowMulti->isChecked() )
95 {
96 label_nofColumns->setEnabled( false );
97 mNofColumns->setEnabled( false );
98 }
99 mAllowNull->setChecked( config.value( QStringLiteral( "AllowNull" ) ).toBool() );
100 mOrderByValue->setChecked( config.value( QStringLiteral( "OrderByValue" ) ).toBool() );
101 mFilterExpression->setPlainText( config.value( QStringLiteral( "FilterExpression" ) ).toString() );
102 mUseCompleter->setChecked( config.value( QStringLiteral( "UseCompleter" ) ).toBool() );
103}
104
105void QgsValueRelationConfigDlg::layerChanged()
106{
107 mFilterExpression->setEnabled( qobject_cast<QgsVectorLayer *>( mLayerName->currentLayer() ) );
108 mEditExpression->setEnabled( qobject_cast<QgsVectorLayer *>( mLayerName->currentLayer() ) );
109}
110
112{
113 QgsVectorLayer *vl = qobject_cast<QgsVectorLayer *>( mLayerName->currentLayer() );
114 if ( !vl )
115 return;
116
120
121 context.setHighlightedFunctions( QStringList() << QStringLiteral( "current_value" ) << QStringLiteral( "current_parent_value" ) );
122 context.setHighlightedVariables( QStringList() << QStringLiteral( "current_geometry" )
123 << QStringLiteral( "current_feature" )
124 << QStringLiteral( "form_mode" )
125 << QStringLiteral( "current_parent_geometry" )
126 << QStringLiteral( "current_parent_feature" ) );
127
128 QgsExpressionBuilderDialog dlg( vl, mFilterExpression->toPlainText(), this, QStringLiteral( "generic" ), context );
129 dlg.setWindowTitle( tr( "Edit Filter Expression" ) );
130
131 if ( dlg.exec() == QDialog::Accepted )
132 {
133 mFilterExpression->setText( dlg.expressionBuilder()->expressionText() );
134 }
135}
This class should be subclassed for every configurable editor widget type.
void changed()
Emitted when the configuration of the widget is changed.
A generic dialog for building expression strings.
QgsExpressionBuilderWidget * expressionBuilder()
The builder widget that is used by the dialog.
QString expressionText()
Gets the expression string that has been set in the expression area.
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 setHighlightedFunctions(const QStringList &names)
Sets the list of function names intended to be highlighted to the user.
void setHighlightedVariables(const QStringList &variableNames)
Sets the list of variable names within the context intended to be highlighted to the user.
void setLayer(QgsMapLayer *layer)
Sets the layer for which fields are listed in the combobox.
The QgsFieldExpressionWidget class reates a widget to choose fields and edit expressions It contains ...
void setLayer(QgsMapLayer *layer)
Sets the layer used to display the fields and expression.
void fieldChanged(const QString &fieldName)
Emitted when the currently selected field changes.
void layerChanged(QgsMapLayer *layer)
Emitted whenever the currently selected layer changes.
static QgsProject * instance()
Returns the QgsProject singleton instance.
Definition: qgsproject.cpp:480
QgsValueRelationConfigDlg(QgsVectorLayer *vl, int fieldIdx, QWidget *parent=nullptr)
void setConfig(const QVariantMap &config) override
Update the configuration widget to represent the given configuration.
QVariantMap config() override
Create a configuration from the current GUI state.
static QgsVectorLayer * resolveLayer(const QVariantMap &config, const QgsProject *project)
Returns the (possibly NULL) layer from the widget's config and project.
Represents a vector layer which manages a vector based data sets.