QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
Public Member Functions | List of all members
QgsGenericFeatureSelectionManager Class Reference

This selection manager synchronizes a local set of selected features with an attribute table. More...

#include <qgsgenericfeatureselectionmanager.h>

Inheritance diagram for QgsGenericFeatureSelectionManager:
Inheritance graph
[legend]

Public Member Functions

 QgsGenericFeatureSelectionManager (const QgsFeatureIds &initialSelection, QObject *parent=nullptr)
 
 QgsGenericFeatureSelectionManager (QObject *parent=nullptr)
 
void deselect (const QgsFeatureIds &ids) override
 Deselect features by feature ids. More...
 
void select (const QgsFeatureIds &ids) override
 Select features by feature ids. More...
 
int selectedFeatureCount () override
 Returns the number of features that are selected in this layer. More...
 
const QgsFeatureIdsselectedFeatureIds () const override
 Returns reference to identifiers of selected features. More...
 
void setSelectedFeatures (const QgsFeatureIds &ids) override
 Change selection to the new set of features. More...
 
- Public Member Functions inherited from QgsIFeatureSelectionManager
 QgsIFeatureSelectionManager (QObject *parent)
 
virtual void deselect (const QgsFeatureIds &ids)=0
 Deselect features by feature ids. More...
 
virtual void select (const QgsFeatureIds &ids)=0
 Select features by feature ids. More...
 
virtual int selectedFeatureCount ()=0
 Returns the number of features that are selected in this layer. More...
 
virtual const QgsFeatureIdsselectedFeatureIds () const =0
 Returns reference to identifiers of selected features. More...
 
virtual void setSelectedFeatures (const QgsFeatureIds &ids)=0
 Change selection to the new set of features. More...
 

Additional Inherited Members

- Signals inherited from QgsIFeatureSelectionManager
void selectionChanged (const QgsFeatureIds &selected, const QgsFeatureIds &deselected, bool clearAndSelect)
 Emitted when selection was changed. More...
 

Detailed Description

This selection manager synchronizes a local set of selected features with an attribute table.

If you want to synchronize the attribute table selection with the map canvas selection, you should use QgsVectorLayerSelectionManager instead.

Note
not available in Python bindings

Definition at line 32 of file qgsgenericfeatureselectionmanager.h.

Constructor & Destructor Documentation

◆ QgsGenericFeatureSelectionManager() [1/2]

QgsGenericFeatureSelectionManager::QgsGenericFeatureSelectionManager ( QObject *  parent = nullptr)
explicit

Definition at line 18 of file qgsgenericfeatureselectionmanager.cpp.

◆ QgsGenericFeatureSelectionManager() [2/2]

QgsGenericFeatureSelectionManager::QgsGenericFeatureSelectionManager ( const QgsFeatureIds initialSelection,
QObject *  parent = nullptr 
)

Definition at line 23 of file qgsgenericfeatureselectionmanager.cpp.

Member Function Documentation

◆ deselect()

void QgsGenericFeatureSelectionManager::deselect ( const QgsFeatureIds ids)
overridevirtual

Deselect features by feature ids.

Implements QgsIFeatureSelectionManager.

Definition at line 40 of file qgsgenericfeatureselectionmanager.cpp.

◆ select()

void QgsGenericFeatureSelectionManager::select ( const QgsFeatureIds ids)
overridevirtual

Select features by feature ids.

Implements QgsIFeatureSelectionManager.

Definition at line 34 of file qgsgenericfeatureselectionmanager.cpp.

◆ selectedFeatureCount()

int QgsGenericFeatureSelectionManager::selectedFeatureCount ( )
overridevirtual

Returns the number of features that are selected in this layer.

Implements QgsIFeatureSelectionManager.

Definition at line 29 of file qgsgenericfeatureselectionmanager.cpp.

◆ selectedFeatureIds()

const QgsFeatureIds & QgsGenericFeatureSelectionManager::selectedFeatureIds ( ) const
overridevirtual

Returns reference to identifiers of selected features.

Returns
A list of QgsFeatureId's
See also
setSelectedFeatures()

Implements QgsIFeatureSelectionManager.

Definition at line 55 of file qgsgenericfeatureselectionmanager.cpp.

◆ setSelectedFeatures()

void QgsGenericFeatureSelectionManager::setSelectedFeatures ( const QgsFeatureIds ids)
overridevirtual

Change selection to the new set of features.

Dismisses the current selection. Will emit the selectionChanged( const QgsFeatureIds&, const QgsFeatureIds&, bool ) signal with the clearAndSelect flag set.

Parameters
idsThe ids which will be the new selection
See also
selectedFeatureIds()

Implements QgsIFeatureSelectionManager.

Definition at line 46 of file qgsgenericfeatureselectionmanager.cpp.


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