File: qgsifeatureselectionmanager.sip.in

package info (click to toggle)
qgis 3.40.10%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,183,672 kB
  • sloc: cpp: 1,595,771; python: 372,544; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 161
file content (83 lines) | stat: -rw-r--r-- 2,893 bytes parent folder | download | duplicates (12)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/attributetable/qgsifeatureselectionmanager.h                 *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/




class QgsIFeatureSelectionManager : QObject
{
%Docstring(signature="appended")
Is an interface class to abstract feature selection handling.

e.g. :py:class:`QgsVectorLayer` implements this interface to manage its
selections.
%End

%TypeHeaderCode
#include "qgsifeatureselectionmanager.h"
%End
  public:
    QgsIFeatureSelectionManager( QObject *parent /TransferThis/ );
    virtual int selectedFeatureCount() = 0;
%Docstring
Returns the number of features that are selected in this layer.
%End

    virtual void select( const QgsFeatureIds &ids ) = 0;
%Docstring
Select features by feature ``ids``.
%End

    virtual void deselect( const QgsFeatureIds &ids ) = 0;
%Docstring
Deselect features by feature ``ids``.
%End

    virtual void setSelectedFeatures( const QgsFeatureIds &ids ) = 0;
%Docstring
Change selection to the new set of features. Dismisses the current
selection. Will emit the
:py:func:`~QgsIFeatureSelectionManager.selectionChanged` signal with the
clearAndSelect flag set.

:param ids: The ids which will be the new selection

.. seealso:: :py:func:`selectedFeatureIds`
%End

    virtual const QgsFeatureIds &selectedFeatureIds() const = 0;
%Docstring
Returns reference to identifiers of selected features

:return: A list of selected :py:class:`QgsFeatureId`

.. seealso:: :py:func:`setSelectedFeatures`
%End

  signals:

    void selectionChanged( const QgsFeatureIds &selected, const QgsFeatureIds &deselected, bool clearAndSelect );
%Docstring
Emitted when selection was changed.

:param selected: Newly selected feature ids
:param deselected: Ids of all features which have previously been
                   selected but are not any more
:param clearAndSelect: In case this is set to ``True``, the old
                       selection was dismissed and the new selection
                       corresponds to selected
%End
};

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/attributetable/qgsifeatureselectionmanager.h                 *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/