QGIS API Documentation 3.43.0-Master (a93bf8b6462)
qgsattributetabledelegate.cpp
Go to the documentation of this file.
1/***************************************************************************
2 QgsAttributeTableDelegate.cpp
3 --------------------------------------
4 Date : Feb 2009
5 Copyright : (C) 2009 Vita Cizek
6 Email : weetya (at) gmail.com
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#include <QItemDelegate>
17#include <QLineEdit>
18#include <QComboBox>
19#include <QPainter>
20#include <QToolButton>
21
23#include "moc_qgsattributetabledelegate.cpp"
31#include "qgsactionmanager.h"
32#include "qgsgui.h"
35#include "qgsrendercontext.h"
36
37QgsVectorLayer *QgsAttributeTableDelegate::layer( const QAbstractItemModel *model )
38{
39 const QgsAttributeTableModel *tm = qobject_cast<const QgsAttributeTableModel *>( model );
40 if ( tm )
41 return tm->layer();
42
43 const QgsAttributeTableFilterModel *fm = qobject_cast<const QgsAttributeTableFilterModel *>( model );
44 if ( fm )
45 return fm->layer();
46
47 return nullptr;
48}
49
50const QgsAttributeTableModel *QgsAttributeTableDelegate::masterModel( const QAbstractItemModel *model )
51{
52 const QgsAttributeTableModel *tm = qobject_cast<const QgsAttributeTableModel *>( model );
53 if ( tm )
54 return tm;
55
56 const QgsAttributeTableFilterModel *fm = qobject_cast<const QgsAttributeTableFilterModel *>( model );
57 if ( fm )
58 return fm->masterModel();
59
60 return nullptr;
61}
62
63QWidget *QgsAttributeTableDelegate::createEditor( QWidget *parent, const QStyleOptionViewItem &option, const QModelIndex &index ) const
64{
65 Q_UNUSED( option )
66 QgsVectorLayer *vl = layer( index.model() );
67 if ( !vl )
68 return nullptr;
69
70 const int fieldIdx = index.model()->data( index, static_cast<int>( QgsAttributeTableModel::CustomRole::FieldIndex ) ).toInt();
71 QgsAttributeEditorContext context( masterModel( index.model() )->editorContext(), QgsAttributeEditorContext::Popup );
72
73 // Update the editor form context with the feature being edited
74 const QgsFeatureId fid( index.model()->data( index, static_cast<int>( QgsAttributeTableModel::CustomRole::FeatureId ) ).toLongLong() );
75 context.setFormFeature( vl->getFeature( fid ) );
76
77 QgsEditorWidgetWrapper *eww = QgsGui::editorWidgetRegistry()->create( vl, fieldIdx, nullptr, parent, context );
78 eww->setFeature( context.formFeature() );
79
80 QWidget *w = eww->widget();
81 w->setAutoFillBackground( true );
82 w->setFocusPolicy( Qt::StrongFocus ); // to make sure QMouseEvents are propagated to the editor widget
83
84 const Qgis::FieldOrigin fieldOrigin = vl->fields().fieldOrigin( fieldIdx );
85 bool readOnly = true;
86 if ( fieldOrigin == Qgis::FieldOrigin::Join )
87 {
88 int srcFieldIndex;
89 const QgsVectorLayerJoinInfo *info = vl->joinBuffer()->joinForFieldIndex( fieldIdx, vl->fields(), srcFieldIndex );
90
91 if ( info && info->isEditable() )
92 readOnly = info->joinLayer()->editFormConfig().readOnly( srcFieldIndex );
93 }
94 else
95 readOnly = vl->editFormConfig().readOnly( fieldIdx );
96
97 eww->setEnabled( !readOnly );
98
99 return w;
100}
101
102void QgsAttributeTableDelegate::setModelData( QWidget *editor, QAbstractItemModel *model, const QModelIndex &index ) const
103{
104 QgsVectorLayer *vl = layer( model );
105 if ( !vl )
106 return;
107
108 const int fieldIdx = model->data( index, static_cast<int>( QgsAttributeTableModel::CustomRole::FieldIndex ) ).toInt();
109 const QgsFeatureId fid = model->data( index, static_cast<int>( QgsAttributeTableModel::CustomRole::FeatureId ) ).toLongLong();
110 const QVariant oldValue = model->data( index, Qt::EditRole );
111
113 if ( !eww )
114 return;
115
116 QList<int> indexes = QList<int>() << fieldIdx;
117 QVariantList newValues = QVariantList() << eww->value();
118 const QStringList additionalFields = eww->additionalFields();
119 for ( const QString &fieldName : additionalFields )
120 {
121 indexes << eww->layer()->fields().lookupField( fieldName );
122 }
123 newValues.append( eww->additionalFieldValues() );
124
125 if ( ( oldValue != newValues.at( 0 ) && newValues.at( 0 ).isValid() )
126 || QgsVariantUtils::isNull( oldValue ) != QgsVariantUtils::isNull( newValues.at( 0 ) )
127 || newValues.count() > 1 )
128 {
129 // This fixes https://github.com/qgis/QGIS/issues/24398
130 QgsFeatureRequest request( fid );
132 QgsFeature feature;
133 vl->getFeatures( request ).nextFeature( feature );
134 if ( feature.isValid() )
135 {
136 vl->beginEditCommand( tr( "Attribute changed" ) );
137 for ( int i = 0; i < newValues.count(); i++ )
138 vl->changeAttributeValue( fid, indexes.at( i ), newValues.at( i ), feature.attribute( indexes.at( i ) ) );
139 vl->endEditCommand();
140 }
141 }
142}
143
144void QgsAttributeTableDelegate::setEditorData( QWidget *editor, const QModelIndex &index ) const
145{
147 if ( !eww )
148 return;
149
150 const QVariant value = index.model()->data( index, Qt::EditRole );
151 const QStringList additionalFields = eww->additionalFields();
152
153 if ( !additionalFields.empty() )
154 {
155 const QgsAttributeTableModel *model = masterModel( index.model() );
156 if ( model )
157 {
158 const QgsFeature feat = model->feature( index );
159 QVariantList additionalFieldValues;
160 for ( const QString &fieldName : additionalFields )
161 {
162 additionalFieldValues << feat.attribute( fieldName );
163 }
164 eww->setValues( value, additionalFieldValues );
165 }
166 }
167 else
168 {
169 eww->setValues( value, QVariantList() );
170 }
171}
172
174{
175 mFeatureSelectionModel = featureSelectionModel;
176}
177
178void QgsAttributeTableDelegate::paint( QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index ) const
179{
180 const QgsAttributeTableFilterModel::ColumnType columnType = static_cast<QgsAttributeTableFilterModel::ColumnType>( index.model()->data( index, static_cast<int>( QgsAttributeTableFilterModel::CustomRole::Type ) ).toInt() );
181
183 {
184 emit actionColumnItemPainted( index );
185 }
186 else
187 {
188 const QgsFeatureId fid = index.model()->data( index, static_cast<int>( QgsAttributeTableModel::CustomRole::FeatureId ) ).toLongLong();
189
190 QStyleOptionViewItem myOpt = option;
191
192 if ( QgsVariantUtils::isNull( index.model()->data( index, Qt::EditRole ) ) )
193 {
194 myOpt.font.setItalic( true );
195 myOpt.palette.setColor( QPalette::Text, QColor( "gray" ) );
196 }
197
198 if ( mFeatureSelectionModel && mFeatureSelectionModel->isSelected( fid ) )
199 myOpt.state |= QStyle::State_Selected;
200
201 QItemDelegate::paint( painter, myOpt, index );
202
203 if ( option.state & QStyle::State_HasFocus )
204 {
205 const QRect r = option.rect.adjusted( 1, 1, -1, -1 );
206 const QPen p( QBrush( QColor( 0, 255, 127 ) ), 2 );
207 const QgsScopedQPainterState painterState( painter );
208 painter->setPen( p );
209 painter->drawRect( r );
210 }
211 }
212}
@ NoGeometry
Geometry is not required. It may still be returned if e.g. required for a filter condition.
FieldOrigin
Field origin.
Definition qgis.h:1667
@ Join
Field originates from a joined layer.
Contains context information for attribute editor widgets.
void setFormFeature(const QgsFeature &feature)
Set current feature for the currently edited form or table row.
@ Popup
A widget was opened as a popup (e.g. attribute table editor widget)
QgsFeature formFeature() const
Returns current feature from the currently edited form or table row.
void actionColumnItemPainted(const QModelIndex &index) const
Emitted when an action column item is painted.
void setModelData(QWidget *editor, QAbstractItemModel *model, const QModelIndex &index) const override
Sets data from editor back to model.
QWidget * createEditor(QWidget *parent, const QStyleOptionViewItem &option, const QModelIndex &index) const override
Used to create an editor for when the user tries to change the contents of a cell.
void setEditorData(QWidget *editor, const QModelIndex &index) const override
Sets data from model into the editor.
void paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const override
Overloads the paint method form the QItemDelegate base class.
void setFeatureSelectionModel(QgsFeatureSelectionModel *featureSelectionModel)
A proxy model for filtering an attribute table model.
@ Type
The type of a given column.
QgsAttributeTableModel * masterModel() const
Returns the table model this filter is using.
@ ColumnTypeActionButton
This column shows action buttons.
QgsVectorLayer * layer() const
Returns the layer this filter acts on.
A model backed by a QgsVectorLayerCache which is able to provide feature/attribute information to a Q...
const QgsAttributeEditorContext & editorContext() const
Returns the context in which this table is shown.
QgsFeature feature(const QModelIndex &idx) const
Returns the feature attributes at given model index.
QgsVectorLayer * layer() const
Returns the layer this model uses as backend.
@ FeatureId
Get the feature id of the feature in this row.
@ FieldIndex
Get the field index of this column.
bool readOnly(int idx) const
This returns true if the field is manually set to read only or if the field does not support editing ...
QgsEditorWidgetWrapper * create(const QString &widgetId, QgsVectorLayer *vl, int fieldIdx, const QVariantMap &config, QWidget *editor, QWidget *parent, const QgsAttributeEditorContext &context=QgsAttributeEditorContext())
Create an attribute editor widget wrapper of a given type for a given field.
Manages an editor widget.
virtual QVariant value() const =0
Will be used to access the widget's value.
virtual QVariantList additionalFieldValues() const
Will be used to access the widget's values for potential additional fields handled by the widget.
void setFeature(const QgsFeature &feature) override
Will be called when the feature changes.
virtual QStringList additionalFields() const
Returns the list of additional fields which the editor handles.
void setEnabled(bool enabled) override
Is used to enable or disable the edit functionality of the managed widget.
void setValues(const QVariant &value, const QVariantList &additionalValues)
Is called when the value of the widget or additional field values needs to be changed.
static QgsEditorWidgetWrapper * fromWidget(QWidget *widget)
Will return a wrapper for a given widget.
bool nextFeature(QgsFeature &f)
Fetch next feature and stores in f, returns true on success.
Wraps a request for features to a vector layer (or directly its vector data provider).
QgsFeatureRequest & setFlags(Qgis::FeatureRequestFlags flags)
Sets flags that affect how features will be fetched.
Item selection model for selecting features.
virtual bool isSelected(QgsFeatureId fid)
Returns the selection status of a given feature id.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:58
bool isValid() const
Returns the validity of this feature.
Q_INVOKABLE QVariant attribute(const QString &name) const
Lookup attribute value by attribute name.
Qgis::FieldOrigin fieldOrigin(int fieldIdx) const
Returns the field's origin (value from an enumeration).
Q_INVOKABLE int lookupField(const QString &fieldName) const
Looks up field's index from the field name.
static QgsEditorWidgetRegistry * editorWidgetRegistry()
Returns the global editor widget registry, used for managing all known edit widget factories.
Definition qgsgui.cpp:95
Scoped object for saving and restoring a QPainter object's state.
static bool isNull(const QVariant &variant, bool silenceNullWarnings=false)
Returns true if the specified variant should be considered a NULL value.
const QgsVectorLayerJoinInfo * joinForFieldIndex(int index, const QgsFields &fields, int &sourceFieldIndex) const
Finds the vector join for a layer field index.
Defines left outer join from our vector layer to some other vector layer.
bool isEditable() const
Returns whether joined fields may be edited through the form of the target layer.
QgsVectorLayer * joinLayer() const
Returns joined layer (may be nullptr if the reference was set by layer ID and not resolved yet)
Represents a vector layer which manages a vector based dataset.
Q_INVOKABLE bool changeAttributeValue(QgsFeatureId fid, int field, const QVariant &newValue, const QVariant &oldValue=QVariant(), bool skipDefaultValues=false, QgsVectorLayerToolsContext *context=nullptr)
Changes an attribute value for a feature (but does not immediately commit the changes).
QgsFeatureIterator getFeatures(const QgsFeatureRequest &request=QgsFeatureRequest()) const FINAL
Queries the layer for features specified in request.
void endEditCommand()
Finish edit command and add it to undo/redo stack.
QgsVectorLayerJoinBuffer * joinBuffer()
Returns the join buffer object.
void beginEditCommand(const QString &text)
Create edit command for undo/redo operations.
QgsEditFormConfig editFormConfig
Q_INVOKABLE QgsFeature getFeature(QgsFeatureId fid) const
Queries the layer for the feature with the given id.
QWidget * widget()
Access the widget managed by this wrapper.
QgsVectorLayer * layer() const
Returns the vector layer associated with the widget.
qint64 QgsFeatureId
64 bit feature ids negative numbers are used for uncommitted/newly added features