QGIS API Documentation 3.99.0-Master (21b3aa880ba)
Loading...
Searching...
No Matches
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
17
18#include "qgsactionmanager.h"
25#include "qgsgui.h"
26#include "qgsrendercontext.h"
30
31#include <QComboBox>
32#include <QItemDelegate>
33#include <QLineEdit>
34#include <QPainter>
35#include <QToolButton>
36
37#include "moc_qgsattributetabledelegate.cpp"
38
39QgsVectorLayer *QgsAttributeTableDelegate::layer( const QAbstractItemModel *model )
40{
41 const QgsAttributeTableModel *tm = qobject_cast<const QgsAttributeTableModel *>( model );
42 if ( tm )
43 return tm->layer();
44
45 const QgsAttributeTableFilterModel *fm = qobject_cast<const QgsAttributeTableFilterModel *>( model );
46 if ( fm )
47 return fm->layer();
48
49 return nullptr;
50}
51
52const QgsAttributeTableModel *QgsAttributeTableDelegate::masterModel( const QAbstractItemModel *model )
53{
54 const QgsAttributeTableModel *tm = qobject_cast<const QgsAttributeTableModel *>( model );
55 if ( tm )
56 return tm;
57
58 const QgsAttributeTableFilterModel *fm = qobject_cast<const QgsAttributeTableFilterModel *>( model );
59 if ( fm )
60 return fm->masterModel();
61
62 return nullptr;
63}
64
65QWidget *QgsAttributeTableDelegate::createEditor( QWidget *parent, const QStyleOptionViewItem &option, const QModelIndex &index ) const
66{
67 Q_UNUSED( option )
68 QgsVectorLayer *vl = layer( index.model() );
69 if ( !vl )
70 return nullptr;
71
72 const int fieldIdx = index.model()->data( index, static_cast<int>( QgsAttributeTableModel::CustomRole::FieldIndex ) ).toInt();
73 QgsAttributeEditorContext context( masterModel( index.model() )->editorContext(), QgsAttributeEditorContext::Popup );
74
75 // Update the editor form context with the feature being edited
76 const QgsFeatureId fid( index.model()->data( index, static_cast<int>( QgsAttributeTableModel::CustomRole::FeatureId ) ).toLongLong() );
77 context.setFormFeature( vl->getFeature( fid ) );
78
79 QgsEditorWidgetWrapper *eww = QgsGui::editorWidgetRegistry()->create( vl, fieldIdx, nullptr, parent, context );
80 eww->setFeature( context.formFeature() );
81
82 QWidget *w = eww->widget();
83 w->setAutoFillBackground( true );
84 w->setFocusPolicy( Qt::StrongFocus ); // to make sure QMouseEvents are propagated to the editor widget
85
86 const Qgis::FieldOrigin fieldOrigin = vl->fields().fieldOrigin( fieldIdx );
87 bool readOnly = true;
88 if ( fieldOrigin == Qgis::FieldOrigin::Join )
89 {
90 int srcFieldIndex;
91 const QgsVectorLayerJoinInfo *info = vl->joinBuffer()->joinForFieldIndex( fieldIdx, vl->fields(), srcFieldIndex );
92
93 if ( info && info->isEditable() )
94 readOnly = info->joinLayer()->editFormConfig().readOnly( srcFieldIndex );
95 }
96 else
97 readOnly = vl->editFormConfig().readOnly( fieldIdx );
98
99 eww->setEnabled( !readOnly );
100
101 return w;
102}
103
104void QgsAttributeTableDelegate::setModelData( QWidget *editor, QAbstractItemModel *model, const QModelIndex &index ) const
105{
106 QgsVectorLayer *vl = layer( model );
107 if ( !vl )
108 return;
109
110 const int fieldIdx = model->data( index, static_cast<int>( QgsAttributeTableModel::CustomRole::FieldIndex ) ).toInt();
111 const QgsFeatureId fid = model->data( index, static_cast<int>( QgsAttributeTableModel::CustomRole::FeatureId ) ).toLongLong();
112 const QVariant oldValue = model->data( index, Qt::EditRole );
113
115 if ( !eww )
116 return;
117
118 QList<int> indexes = QList<int>() << fieldIdx;
119 QVariantList newValues = QVariantList() << eww->value();
120 const QStringList additionalFields = eww->additionalFields();
121 for ( const QString &fieldName : additionalFields )
122 {
123 indexes << eww->layer()->fields().lookupField( fieldName );
124 }
125 newValues.append( eww->additionalFieldValues() );
126
127 if ( ( oldValue != newValues.at( 0 ) && newValues.at( 0 ).isValid() )
128 || QgsVariantUtils::isNull( oldValue ) != QgsVariantUtils::isNull( newValues.at( 0 ) )
129 || newValues.count() > 1 )
130 {
131 // This fixes https://github.com/qgis/QGIS/issues/24398
132 QgsFeatureRequest request( fid );
134 QgsFeature feature;
135 vl->getFeatures( request ).nextFeature( feature );
136 if ( feature.isValid() )
137 {
138 vl->beginEditCommand( tr( "Attribute changed" ) );
139 for ( int i = 0; i < newValues.count(); i++ )
140 vl->changeAttributeValue( fid, indexes.at( i ), newValues.at( i ), feature.attribute( indexes.at( i ) ) );
141 vl->endEditCommand();
142 }
143 }
144}
145
146void QgsAttributeTableDelegate::setEditorData( QWidget *editor, const QModelIndex &index ) const
147{
149 if ( !eww )
150 return;
151
152 const QVariant value = index.model()->data( index, Qt::EditRole );
153 const QStringList additionalFields = eww->additionalFields();
154
155 if ( !additionalFields.empty() )
156 {
157 const QgsAttributeTableModel *model = masterModel( index.model() );
158 if ( model )
159 {
160 const QgsFeature feat = model->feature( index );
161 QVariantList additionalFieldValues;
162 for ( const QString &fieldName : additionalFields )
163 {
164 additionalFieldValues << feat.attribute( fieldName );
165 }
166 eww->setValues( value, additionalFieldValues );
167 }
168 }
169 else
170 {
171 eww->setValues( value, QVariantList() );
172 }
173}
174
176{
177 mFeatureSelectionModel = featureSelectionModel;
178}
179
180void QgsAttributeTableDelegate::paint( QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index ) const
181{
182 const QgsAttributeTableFilterModel::ColumnType columnType = static_cast<QgsAttributeTableFilterModel::ColumnType>( index.model()->data( index, static_cast<int>( QgsAttributeTableFilterModel::CustomRole::Type ) ).toInt() );
183
185 {
186 emit actionColumnItemPainted( index );
187 }
188 else
189 {
190 const QgsFeatureId fid = index.model()->data( index, static_cast<int>( QgsAttributeTableModel::CustomRole::FeatureId ) ).toLongLong();
191
192 QStyleOptionViewItem myOpt = option;
193
194 if ( QgsVariantUtils::isNull( index.model()->data( index, Qt::EditRole ) ) )
195 {
196 myOpt.font.setItalic( true );
197 myOpt.palette.setColor( QPalette::Text, QColor( "gray" ) );
198 }
199
200 if ( mFeatureSelectionModel && mFeatureSelectionModel->isSelected( fid ) )
201 myOpt.state |= QStyle::State_Selected;
202
203 QItemDelegate::paint( painter, myOpt, index );
204
205 if ( option.state & QStyle::State_HasFocus )
206 {
207 const QRect r = option.rect.adjusted( 1, 1, -1, -1 );
208 const QPen p( QBrush( QColor( 0, 255, 127 ) ), 2 );
209 const QgsScopedQPainterState painterState( painter );
210 painter->setPen( p );
211 painter->drawRect( r );
212 }
213 }
214}
@ NoGeometry
Geometry is not required. It may still be returned if e.g. required for a filter condition.
Definition qgis.h:2196
FieldOrigin
Field origin.
Definition qgis.h:1704
@ Join
Field originates from a joined layer.
Definition qgis.h:1707
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)
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...
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.
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:106
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).
void endEditCommand()
Finish edit command and add it to undo/redo stack.
QgsVectorLayerJoinBuffer * joinBuffer()
Returns the join buffer object.
QgsFeatureIterator getFeatures(const QgsFeatureRequest &request=QgsFeatureRequest()) const final
Queries the layer for features specified in request.
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