QGIS API Documentation  3.37.0-Master (a5b4d9743e8)
Public Slots | Signals | Public Member Functions | List of all members
QgsFeatureSelectionModel Class Reference

#include <qgsfeatureselectionmodel.h>

Inheritance diagram for QgsFeatureSelectionModel:
Inheritance graph
[legend]

Public Slots

void select (const QItemSelection &selection, QItemSelectionModel::SelectionFlags command) override
 Overwritten to do NOTHING (we handle selection ourselves) More...
 
void select (const QModelIndex &index, QItemSelectionModel::SelectionFlags command) override
 Overwritten to do NOTHING (we handle selection ourselves) More...
 
virtual void selectFeatures (const QItemSelection &selection, QItemSelectionModel::SelectionFlags command)
 Select features on this table. More...
 
virtual void setFeatureSelectionManager (QgsIFeatureSelectionManager *featureSelectionManager)
 

Signals

void requestRepaint ()
 Request a repaint of the visible items of connected views. More...
 
void requestRepaint (const QModelIndexList &indexes)
 Request a repaint of a list of model indexes. More...
 

Public Member Functions

 QgsFeatureSelectionModel (QAbstractItemModel *model, QgsFeatureModel *featureModel, QgsIFeatureSelectionManager *featureSelectionHandler, QObject *parent)
 
void enableSync (bool enable)
 Enables or disables synchronisation to the QgsVectorLayer When synchronisation is disabled, any selection change will be buffered inside this selection model. More...
 
virtual bool isSelected (const QModelIndex &index)
 Returns the selection status of a given QModelIndex. More...
 
virtual bool isSelected (QgsFeatureId fid)
 Returns the selection status of a given feature id. More...
 

Detailed Description

Definition at line 31 of file qgsfeatureselectionmodel.h.

Constructor & Destructor Documentation

◆ QgsFeatureSelectionModel()

QgsFeatureSelectionModel::QgsFeatureSelectionModel ( QAbstractItemModel *  model,
QgsFeatureModel featureModel,
QgsIFeatureSelectionManager featureSelectionHandler,
QObject *  parent 
)
explicit

Definition at line 22 of file qgsfeatureselectionmodel.cpp.

Member Function Documentation

◆ enableSync()

void QgsFeatureSelectionModel::enableSync ( bool  enable)

Enables or disables synchronisation to the QgsVectorLayer When synchronisation is disabled, any selection change will be buffered inside this selection model.

When enabled, any buffered changes are communicated to the layer and the buffer is emptied. Mainly to be used for performance reasons, because selection change on the layer can cost time as it repaints the layer.

Parameters
enableThe synchronisation status to set.

Definition at line 31 of file qgsfeatureselectionmodel.cpp.

◆ isSelected() [1/2]

bool QgsFeatureSelectionModel::isSelected ( const QModelIndex &  index)
virtual

Returns the selection status of a given QModelIndex.

Parameters
indexThe index to determine the selection status of
Returns
The selection status

Definition at line 67 of file qgsfeatureselectionmodel.cpp.

◆ isSelected() [2/2]

bool QgsFeatureSelectionModel::isSelected ( QgsFeatureId  fid)
virtual

Returns the selection status of a given feature id.

Parameters
fidThe featureid to determine the selection status of
Returns
The selection status

Definition at line 53 of file qgsfeatureselectionmodel.cpp.

◆ requestRepaint [1/2]

void QgsFeatureSelectionModel::requestRepaint ( )
signal

Request a repaint of the visible items of connected views.

Views using this model should connect to and properly process this signal.

◆ requestRepaint [2/2]

void QgsFeatureSelectionModel::requestRepaint ( const QModelIndexList &  indexes)
signal

Request a repaint of a list of model indexes.

Views using this model should connect to and properly process this signal.

Parameters
indexesThe model indexes which need to be repainted

◆ select [1/2]

void QgsFeatureSelectionModel::select ( const QItemSelection &  selection,
QItemSelectionModel::SelectionFlags  command 
)
inlineoverrideslot

Overwritten to do NOTHING (we handle selection ourselves)

See also
selectFeatures( const QItemSelection&, SelectionFlags )

Definition at line 97 of file qgsfeatureselectionmodel.h.

◆ select [2/2]

void QgsFeatureSelectionModel::select ( const QModelIndex &  index,
QItemSelectionModel::SelectionFlags  command 
)
inlineoverrideslot

Overwritten to do NOTHING (we handle selection ourselves)

See also
selectFeatures( const QItemSelection&, SelectionFlags )

Definition at line 90 of file qgsfeatureselectionmodel.h.

◆ selectFeatures

void QgsFeatureSelectionModel::selectFeatures ( const QItemSelection &  selection,
QItemSelectionModel::SelectionFlags  command 
)
virtualslot

Select features on this table.

Is to be used in favor of the stock select methods.

Parameters
selectionThe QItemSelection which will be selected
commandThe command to apply. Select, Deselect and ClearAndSelect are processed.

Definition at line 72 of file qgsfeatureselectionmodel.cpp.

◆ setFeatureSelectionManager

void QgsFeatureSelectionModel::setFeatureSelectionManager ( QgsIFeatureSelectionManager featureSelectionManager)
virtualslot

Definition at line 156 of file qgsfeatureselectionmodel.cpp.


The documentation for this class was generated from the following files: