File: qgslayertreeviewindicator.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 (76 lines) | stat: -rw-r--r-- 2,414 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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/layertree/qgslayertreeviewindicator.h                        *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/




class QgsLayerTreeViewIndicator : QObject
{
%Docstring(signature="appended")
Indicator that can be used in a layer tree view to display icons next to
items of the layer tree. They add extra context to the item and
interactivity (using :py:func:`~clicked` signal).

Indicators can be added/removed to individual layer tree items using
:py:func:`QgsLayerTreeView.addIndicator()` and
:py:func:`QgsLayerTreeView.removeIndicator()` calls.

.. versionadded:: 3.2
%End

%TypeHeaderCode
#include "qgslayertreeviewindicator.h"
%End
  public:
    explicit QgsLayerTreeViewIndicator( QObject *parent /TransferThis/ = 0 );
%Docstring
Constructs an indicator, optionally transferring ownership to a parent
QObject
%End

    QIcon icon() const;
%Docstring
Indicator icon that will be displayed in the layer tree view
%End
    void setIcon( const QIcon &icon );
%Docstring
Sets indicator icon that will be displayed in the layer tree view
%End

    QString toolTip() const;
%Docstring
Returns tool tip text that will be shown when user hovers mouse over the
indicator
%End
    void setToolTip( const QString &tip );
%Docstring
Sets tool tip text
%End

  signals:
    void clicked( const QModelIndex &index );
%Docstring
Emitted when user clicks on the indicator
%End

    void changed();
%Docstring
Emitted when the indicator changes state (e.g. icon).

.. versionadded:: 3.10
%End

};

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