QGIS API Documentation  2.99.0-Master (7d4f81d)
qgsrelationreferencewidgetwrapper.cpp
Go to the documentation of this file.
1 /***************************************************************************
2  qgsrelationreferencewidgetwrapper.cpp
3  --------------------------------------
4  Date : 20.4.2013
5  Copyright : (C) 2013 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 
16 
18 #include "qgsproject.h"
19 #include "qgsrelationmanager.h"
21 
22 QgsRelationReferenceWidgetWrapper::QgsRelationReferenceWidgetWrapper( QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QgsMapCanvas *canvas, QgsMessageBar *messageBar, QWidget *parent )
23  : QgsEditorWidgetWrapper( vl, fieldIdx, editor, parent )
24  , mWidget( nullptr )
25  , mCanvas( canvas )
26  , mMessageBar( messageBar )
27  , mIndeterminateState( false )
28 {
29 }
30 
32 {
34  return w;
35 }
36 
38 {
39  QgsRelationReferenceWidget *w = dynamic_cast<QgsRelationReferenceWidget *>( editor );
40  if ( !w )
41  {
42  w = new QgsRelationReferenceWidget( editor );
43  }
44 
45  mWidget = w;
46 
47  mWidget->setEditorContext( context(), mCanvas, mMessageBar );
48 
49  bool showForm = config( QStringLiteral( "ShowForm" ), false ).toBool();
50  bool mapIdent = config( QStringLiteral( "MapIdentification" ), false ).toBool();
51  bool readOnlyWidget = config( QStringLiteral( "ReadOnly" ), false ).toBool();
52  bool orderByValue = config( QStringLiteral( "OrderByValue" ), false ).toBool();
53  bool showOpenFormButton = config( QStringLiteral( "ShowOpenFormButton" ), true ).toBool();
54 
55  mWidget->setEmbedForm( showForm );
56  mWidget->setReadOnlySelector( readOnlyWidget );
57  mWidget->setAllowMapIdentification( mapIdent );
58  mWidget->setOrderByValue( orderByValue );
59  mWidget->setOpenFormButtonVisible( showOpenFormButton );
60  if ( config( QStringLiteral( "FilterFields" ), QVariant() ).isValid() )
61  {
62  mWidget->setFilterFields( config( QStringLiteral( "FilterFields" ) ).toStringList() );
63  mWidget->setChainFilters( config( QStringLiteral( "ChainFilters" ) ).toBool() );
64  }
65  mWidget->setAllowAddFeatures( config( QStringLiteral( "AllowAddFeatures" ), false ).toBool() );
66 
67  const QVariant relationName = config( QStringLiteral( "Relation" ) );
68  QgsRelation relation = relationName.isValid() ?
69  QgsProject::instance()->relationManager()->relation( relationName.toString() ) :
71 
72  // If this widget is already embedded by the same relation, reduce functionality
73  const QgsAttributeEditorContext *ctx = &context();
74  do
75  {
76  if ( ctx->relation().name() == relation.name() )
77  {
78  mWidget->setEmbedForm( false );
79  mWidget->setReadOnlySelector( false );
80  mWidget->setAllowMapIdentification( false );
81  break;
82  }
83  ctx = ctx->parentContext();
84  }
85  while ( ctx );
86 
87  mWidget->setRelation( relation, config( QStringLiteral( "AllowNULL" ) ).toBool() );
88 
89  connect( mWidget, &QgsRelationReferenceWidget::foreignKeyChanged, this, &QgsRelationReferenceWidgetWrapper::foreignKeyChanged );
90 }
91 
93 {
94  if ( !mWidget )
95  return QVariant( field().type() );
96 
97  QVariant v = mWidget->foreignKey();
98 
99  if ( v.isNull() )
100  {
101  return QVariant( field().type() );
102  }
103  else
104  {
105  return v;
106  }
107 }
108 
110 {
111  return mWidget;
112 }
113 
115 {
116  if ( mWidget )
117  {
118  mWidget->showIndeterminateState();
119  }
120  mIndeterminateState = true;
121 }
122 
124 {
125  if ( !mWidget || ( !mIndeterminateState && val == value() ) )
126  return;
127 
128  mIndeterminateState = false;
129  mWidget->setForeignKey( val );
130 }
131 
133 {
134  if ( !mWidget )
135  return;
136 
137  mWidget->setRelationEditable( enabled );
138 }
139 
140 void QgsRelationReferenceWidgetWrapper::foreignKeyChanged( QVariant value )
141 {
142  if ( !value.isValid() || value.isNull() )
143  {
144  value = QVariant( field().type() );
145  }
146  emit valueChanged( value );
147 }
148 
150 {
151  if ( mWidget )
152  {
153  switch ( status )
154  {
156  mWidget->setStyleSheet( QString() );
157  break;
158 
160  mWidget->setStyleSheet( QStringLiteral( ".QComboBox { background-color: #dd7777; }" ) );
161  break;
162 
164  mWidget->setStyleSheet( QStringLiteral( ".QComboBox { background-color: #ffd85d; }" ) );
165  break;
166  }
167  }
168 }
void setEditorContext(const QgsAttributeEditorContext &context, QgsMapCanvas *canvas, QgsMessageBar *messageBar)
QString name
Definition: qgsrelation.h:44
QVariant foreignKey() const
returns the related feature foreign key
Widget failed at least one soft (non-enforced) constraint.
void valueChanged()
Will call the value() method to determine the emitted value.
QgsField field() const
Access the field.
void setFilterFields(const QStringList &filterFields)
Set the fields for which filter comboboxes will be created.
void foreignKeyChanged(const QVariant &)
This class contains context information for attribute editor widgets.
Manages an editor widget Widget and wrapper share the same parent.
void setOpenFormButtonVisible(bool openFormButtonVisible)
A bar for displaying non-blocking messages to the user.
Definition: qgsmessagebar.h:44
Widget failed at least one hard (enforced) constraint.
QVariantMap config() const
Returns the whole config.
Map canvas is a class for displaying all GIS data types on a canvas.
Definition: qgsmapcanvas.h:73
void setAllowMapIdentification(bool allowMapIdentification)
void showIndeterminateState() override
Sets the widget to display in an indeterminate "mixed value" state.
void setForeignKey(const QVariant &value)
this sets the related feature using from the foreign key
void setOrderByValue(bool orderByValue)
Set if the widget will order the combobox entries by value.
virtual QVariant value() const override
Will be used to access the widget&#39;s value.
QList< QgsRelation > referencingRelations(int idx) const
Get relations, where the foreign key is on this layer.
const QgsRelation & relation() const
QgsRelationManager relationManager
Definition: qgsproject.h:89
void setRelation(const QgsRelation &relation, bool allowNullValue)
virtual QWidget * createWidget(QWidget *parent) override
This method should create a new widget with the provided parent.
const QgsAttributeEditorContext & context() const
Returns information about the context in which this widget is shown.
const QgsAttributeEditorContext * parentContext() const
void updateConstraintWidgetStatus(ConstraintResult status) override
This should update the widget with a visual cue if a constraint status changed.
Widget passed constraints successfully.
ConstraintResult
Result of constraint checks.
bool isValid
Definition: qgsrelation.h:45
void setAllowAddFeatures(bool allowAddFeatures)
Determines if a button for adding new features should be shown.
static QgsProject * instance()
Returns the QgsProject singleton instance.
Definition: qgsproject.cpp:379
void showIndeterminateState()
Sets the widget to display in an indeterminate "mixed value" state.
int fieldIdx() const
Access the field index.
bool valid() const override
Return true if the widget has been properly initialized.
QgsVectorLayer * layer() const
Access the QgsVectorLayer, you are working on.
Q_INVOKABLE QgsRelation relation(const QString &id) const
Get access to a relation by its id.
Represents a vector layer which manages a vector based data sets.
QgsRelationReferenceWidgetWrapper(QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QgsMapCanvas *canvas, QgsMessageBar *messageBar, QWidget *parent=0)
virtual void setValue(const QVariant &value) override
void setChainFilters(bool chainFilters)
Set if filters are chained.
virtual void initWidget(QWidget *editor) override
This method should initialize the editor widget with runtime data.
virtual void setEnabled(bool enabled) override