QGIS API Documentation  3.2.0-Bonn (bc43194)
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"
20 
22  : QgsEditorConfigWidget( vl, fieldIdx, parent )
23 {
24  setupUi( this );
25  mLayerName->setFilters( QgsMapLayerProxyModel::VectorLayer );
26  connect( mLayerName, &QgsMapLayerComboBox::layerChanged, mKeyColumn, &QgsFieldComboBox::setLayer );
27  connect( mLayerName, &QgsMapLayerComboBox::layerChanged, mValueColumn, &QgsFieldComboBox::setLayer );
28  connect( mEditExpression, &QAbstractButton::clicked, this, &QgsValueRelationConfigDlg::editExpression );
29 
30  mNofColumns->setMinimum( 1 );
31  mNofColumns->setMaximum( 10 );
32  mNofColumns->setValue( 1 );
33 
35  connect( mKeyColumn, static_cast<void ( QComboBox::* )( int )>( &QComboBox::currentIndexChanged ), this, &QgsEditorConfigWidget::changed );
36  connect( mValueColumn, static_cast<void ( QComboBox::* )( int )>( &QComboBox::currentIndexChanged ), this, &QgsEditorConfigWidget::changed );
37  connect( mAllowMulti, &QAbstractButton::toggled, this, &QgsEditorConfigWidget::changed );
38  connect( mAllowNull, &QAbstractButton::toggled, this, &QgsEditorConfigWidget::changed );
39  connect( mOrderByValue, &QAbstractButton::toggled, this, &QgsEditorConfigWidget::changed );
40  connect( mFilterExpression, &QTextEdit::textChanged, this, &QgsEditorConfigWidget::changed );
41  connect( mUseCompleter, &QAbstractButton::toggled, this, &QgsEditorConfigWidget::changed );
42  connect( mAllowMulti, &QAbstractButton::toggled, this, [ = ]( bool checked )
43  {
44  label_nofColumns->setEnabled( checked );
45  mNofColumns->setEnabled( checked );
46  }
47  );
48 
49  connect( mNofColumns, static_cast < void ( QSpinBox::* )( int ) > ( &QSpinBox::valueChanged ), this, &QgsEditorConfigWidget::changed );
50 }
51 
53 {
54  QVariantMap cfg;
55 
56  cfg.insert( QStringLiteral( "Layer" ), mLayerName->currentLayer() ? mLayerName->currentLayer()->id() : QString() );
57  cfg.insert( QStringLiteral( "Key" ), mKeyColumn->currentField() );
58  cfg.insert( QStringLiteral( "Value" ), mValueColumn->currentField() );
59  cfg.insert( QStringLiteral( "AllowMulti" ), mAllowMulti->isChecked() );
60  cfg.insert( QStringLiteral( "NofColumns" ), mNofColumns->value() );
61  cfg.insert( QStringLiteral( "AllowNull" ), mAllowNull->isChecked() );
62  cfg.insert( QStringLiteral( "OrderByValue" ), mOrderByValue->isChecked() );
63  cfg.insert( QStringLiteral( "FilterExpression" ), mFilterExpression->toPlainText() );
64  cfg.insert( QStringLiteral( "UseCompleter" ), mUseCompleter->isChecked() );
65 
66  return cfg;
67 }
68 
69 void QgsValueRelationConfigDlg::setConfig( const QVariantMap &config )
70 {
71  QgsVectorLayer *lyr = qobject_cast<QgsVectorLayer *>( QgsProject::instance()->mapLayer( config.value( QStringLiteral( "Layer" ) ).toString() ) );
72  mLayerName->setLayer( lyr );
73  mKeyColumn->setField( config.value( QStringLiteral( "Key" ) ).toString() );
74  mValueColumn->setField( config.value( QStringLiteral( "Value" ) ).toString() );
75  mAllowMulti->setChecked( config.value( QStringLiteral( "AllowMulti" ) ).toBool() );
76  mNofColumns->setValue( config.value( QStringLiteral( "NofColumns" ), 1 ).toInt() );
77  if ( !mAllowMulti->isChecked() )
78  {
79  label_nofColumns->setEnabled( false );
80  mNofColumns->setEnabled( false );
81  }
82  mAllowNull->setChecked( config.value( QStringLiteral( "AllowNull" ) ).toBool() );
83  mOrderByValue->setChecked( config.value( QStringLiteral( "OrderByValue" ) ).toBool() );
84  mFilterExpression->setPlainText( config.value( QStringLiteral( "FilterExpression" ) ).toString() );
85  mUseCompleter->setChecked( config.value( QStringLiteral( "UseCompleter" ) ).toBool() );
86 }
87 
89 {
90  QgsVectorLayer *vl = qobject_cast<QgsVectorLayer *>( mLayerName->currentLayer() );
91  if ( !vl )
92  return;
93 
96 
97  QgsExpressionBuilderDialog dlg( vl, mFilterExpression->toPlainText(), this, QStringLiteral( "generic" ), context );
98  dlg.setWindowTitle( tr( "Edit Filter Expression" ) );
99 
100  if ( dlg.exec() == QDialog::Accepted )
101  {
102  mFilterExpression->setText( dlg.expressionBuilder()->expressionText() );
103  }
104 }
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.
void layerChanged(QgsMapLayer *layer)
layerChanged this signal is emitted whenever the currently selected layer changes ...
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 QgsExpressionContextScope * formScope(const QgsFeature &formFeature=QgsFeature())
Creates a new scope which contains functions and variables from the current attribute form/table feat...
static QgsProject * instance()
Returns the QgsProject singleton instance.
Definition: qgsproject.cpp:391
QgsMapLayer * mapLayer(const QString &layerId) const
Retrieve a pointer to a registered layer by layer ID.
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.