QGIS API Documentation  3.6.0-Noosa (5873452)
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"
21 
23  : QgsEditorConfigWidget( vl, fieldIdx, parent )
24 {
25  setupUi( this );
26  mLayerName->setFilters( QgsMapLayerProxyModel::VectorLayer );
27  connect( mLayerName, &QgsMapLayerComboBox::layerChanged, mKeyColumn, &QgsFieldComboBox::setLayer );
28  connect( mLayerName, &QgsMapLayerComboBox::layerChanged, mValueColumn, &QgsFieldComboBox::setLayer );
29  connect( mEditExpression, &QAbstractButton::clicked, this, &QgsValueRelationConfigDlg::editExpression );
30 
31  mNofColumns->setMinimum( 1 );
32  mNofColumns->setMaximum( 10 );
33  mNofColumns->setValue( 1 );
34 
36  connect( mKeyColumn, static_cast<void ( QComboBox::* )( int )>( &QComboBox::currentIndexChanged ), this, &QgsEditorConfigWidget::changed );
37  connect( mValueColumn, static_cast<void ( QComboBox::* )( int )>( &QComboBox::currentIndexChanged ), this, &QgsEditorConfigWidget::changed );
38  connect( mAllowMulti, &QAbstractButton::toggled, this, &QgsEditorConfigWidget::changed );
39  connect( mAllowNull, &QAbstractButton::toggled, this, &QgsEditorConfigWidget::changed );
40  connect( mOrderByValue, &QAbstractButton::toggled, this, &QgsEditorConfigWidget::changed );
41  connect( mFilterExpression, &QTextEdit::textChanged, this, &QgsEditorConfigWidget::changed );
42  connect( mUseCompleter, &QAbstractButton::toggled, this, &QgsEditorConfigWidget::changed );
43  connect( mAllowMulti, &QAbstractButton::toggled, this, [ = ]( bool checked )
44  {
45  label_nofColumns->setEnabled( checked );
46  mNofColumns->setEnabled( checked );
47  }
48  );
49 
50  connect( mNofColumns, static_cast < void ( QSpinBox::* )( int ) > ( &QSpinBox::valueChanged ), this, &QgsEditorConfigWidget::changed );
51 }
52 
54 {
55  QVariantMap cfg;
56 
57  cfg.insert( QStringLiteral( "Layer" ), mLayerName->currentLayer() ? mLayerName->currentLayer()->id() : QString() );
58  cfg.insert( QStringLiteral( "Key" ), mKeyColumn->currentField() );
59  cfg.insert( QStringLiteral( "Value" ), mValueColumn->currentField() );
60  cfg.insert( QStringLiteral( "AllowMulti" ), mAllowMulti->isChecked() );
61  cfg.insert( QStringLiteral( "NofColumns" ), mNofColumns->value() );
62  cfg.insert( QStringLiteral( "AllowNull" ), mAllowNull->isChecked() );
63  cfg.insert( QStringLiteral( "OrderByValue" ), mOrderByValue->isChecked() );
64  cfg.insert( QStringLiteral( "FilterExpression" ), mFilterExpression->toPlainText() );
65  cfg.insert( QStringLiteral( "UseCompleter" ), mUseCompleter->isChecked() );
66 
67  return cfg;
68 }
69 
70 void QgsValueRelationConfigDlg::setConfig( const QVariantMap &config )
71 {
72  QgsVectorLayer *lyr = QgsProject::instance()->mapLayer<QgsVectorLayer *>( config.value( QStringLiteral( "Layer" ) ).toString() );
73  mLayerName->setLayer( lyr );
74  mKeyColumn->setField( config.value( QStringLiteral( "Key" ) ).toString() );
75  mValueColumn->setField( config.value( QStringLiteral( "Value" ) ).toString() );
76  mAllowMulti->setChecked( config.value( QStringLiteral( "AllowMulti" ) ).toBool() );
77  mNofColumns->setValue( config.value( QStringLiteral( "NofColumns" ), 1 ).toInt() );
78  if ( !mAllowMulti->isChecked() )
79  {
80  label_nofColumns->setEnabled( false );
81  mNofColumns->setEnabled( false );
82  }
83  mAllowNull->setChecked( config.value( QStringLiteral( "AllowNull" ) ).toBool() );
84  mOrderByValue->setChecked( config.value( QStringLiteral( "OrderByValue" ) ).toBool() );
85  mFilterExpression->setPlainText( config.value( QStringLiteral( "FilterExpression" ) ).toString() );
86  mUseCompleter->setChecked( config.value( QStringLiteral( "UseCompleter" ) ).toBool() );
87 }
88 
90 {
91  QgsVectorLayer *vl = qobject_cast<QgsVectorLayer *>( mLayerName->currentLayer() );
92  if ( !vl )
93  return;
94 
97 
98  context.setHighlightedFunctions( QStringList() << QStringLiteral( "current_value" ) );
99  context.setHighlightedVariables( QStringList() << QStringLiteral( "current_geometry" )
100  << QStringLiteral( "current_feature" )
101  << QStringLiteral( "form_mode" ) );
102 
103  QgsExpressionBuilderDialog dlg( vl, mFilterExpression->toPlainText(), this, QStringLiteral( "generic" ), context );
104  dlg.setWindowTitle( tr( "Edit Filter Expression" ) );
105 
106  if ( dlg.exec() == QDialog::Accepted )
107  {
108  mFilterExpression->setText( dlg.expressionBuilder()->expressionText() );
109  }
110 }
This class should be subclassed for every configurable editor widget type.
QVariantMap config() override
Create a configuration from the current GUI state.
void setConfig(const QVariantMap &config) override
Update the configuration widget to represent the given configuration.
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 feat...
void layerChanged(QgsMapLayer *layer)
layerChanged this signal is emitted whenever the currently selected layer changes ...
void setHighlightedFunctions(const QStringList &names)
Sets the list of function names intended to be highlighted to the user.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
static QList< QgsExpressionContextScope * > globalProjectLayerScopes(const QgsMapLayer *layer)
Creates a list of three scopes: global, layer&#39;s project and layer.
void changed()
Emitted when the configuration of the widget is changed.
void setLayer(QgsMapLayer *layer)
Sets the layer for which fields are listed in the combobox.
static QgsProject * instance()
Returns the QgsProject singleton instance.
Definition: qgsproject.cpp:430
QgsMapLayer * mapLayer(const QString &layerId) const
Retrieve a pointer to a registered layer by layer ID.
void setHighlightedVariables(const QStringList &variableNames)
Sets the list of variable names within the context intended to be highlighted to the user...
QgsValueRelationConfigDlg(QgsVectorLayer *vl, int fieldIdx, QWidget *parent=nullptr)
Represents a vector layer which manages a vector based data sets.
A generic dialog for building expression strings.