QGIS API Documentation  2.99.0-Master (8ec3eaf)
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" ), true ).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 
54  mWidget->setEmbedForm( showForm );
55  mWidget->setReadOnlySelector( readOnlyWidget );
56  mWidget->setAllowMapIdentification( mapIdent );
57  mWidget->setOrderByValue( orderByValue );
58  if ( config( QStringLiteral( "FilterFields" ), QVariant() ).isValid() )
59  {
60  mWidget->setFilterFields( config( QStringLiteral( "FilterFields" ) ).toStringList() );
61  mWidget->setChainFilters( config( QStringLiteral( "ChainFilters" ) ).toBool() );
62  }
63  mWidget->setAllowAddFeatures( config( QStringLiteral( "AllowAddFeatures" ), false ).toBool() );
64 
65  const QVariant relationName = config( QStringLiteral( "Relation" ) );
66  QgsRelation relation = relationName.isValid() ?
67  QgsProject::instance()->relationManager()->relation( relationName.toString() ) :
69 
70  // If this widget is already embedded by the same relation, reduce functionality
71  const QgsAttributeEditorContext* ctx = &context();
72  do
73  {
74  if ( ctx->relation().name() == relation.name() )
75  {
76  mWidget->setEmbedForm( false );
77  mWidget->setReadOnlySelector( false );
78  mWidget->setAllowMapIdentification( false );
79  break;
80  }
81  ctx = ctx->parentContext();
82  }
83  while ( ctx );
84 
85  mWidget->setRelation( relation, config( QStringLiteral( "AllowNULL" ) ).toBool() );
86 
87  connect( mWidget, SIGNAL( foreignKeyChanged( QVariant ) ), this, SLOT( foreignKeyChanged( QVariant ) ) );
88 }
89 
91 {
92  if ( !mWidget )
93  return QVariant( field().type() );
94 
95  QVariant v = mWidget->foreignKey();
96 
97  if ( v.isNull() )
98  {
99  return QVariant( field().type() );
100  }
101  else
102  {
103  return v;
104  }
105 }
106 
108 {
109  return mWidget;
110 }
111 
113 {
114  if ( mWidget )
115  {
116  mWidget->showIndeterminateState();
117  }
118  mIndeterminateState = true;
119 }
120 
122 {
123  if ( !mWidget || ( !mIndeterminateState && val == value() ) )
124  return;
125 
126  mIndeterminateState = false;
127  mWidget->setForeignKey( val );
128 }
129 
131 {
132  if ( !mWidget )
133  return;
134 
135  mWidget->setRelationEditable( enabled );
136 }
137 
138 void QgsRelationReferenceWidgetWrapper::foreignKeyChanged( QVariant value )
139 {
140  if ( !value.isValid() || value.isNull() )
141  {
142  value = QVariant( field().type() );
143  }
144  emit valueChanged( value );
145 }
146 
148 {
149  if ( mWidget )
150  {
151  switch ( status )
152  {
154  mWidget->setStyleSheet( QString() );
155  break;
156 
158  mWidget->setStyleSheet( QStringLiteral( ".QComboBox { background-color: #dd7777; }" ) );
159  break;
160 
162  mWidget->setStyleSheet( QStringLiteral( ".QComboBox { background-color: #ffd85d; }" ) );
163  break;
164  }
165  }
166 }
void setEditorContext(const QgsAttributeEditorContext &context, QgsMapCanvas *canvas, QgsMessageBar *messageBar)
QVariant foreignKey() const
returns the related feature foreign key
bool isValid() const
Returns the validity of this relation.
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.
This class contains context information for attribute editor widgets.
Manages an editor widget Widget and wrapper share the same parent.
A bar for displaying non-blocking messages to the user.
Definition: qgsmessagebar.h:42
Widget failed at least one hard (enforced) constraint.
QgsRelationManager * relationManager() const
Map canvas is a class for displaying all GIS data types on a canvas.
Definition: qgsmapcanvas.h:106
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
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.
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:348
void showIndeterminateState()
Sets the widget to display in an indeterminate "mixed value" state.
QgsEditorWidgetConfig config() const
Returns the whole config.
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.
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=nullptr)
virtual void setValue(const QVariant &value) override
QString name() const
Returns a human readable name for this relation.
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