File: qgscheckablecombobox.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 (190 lines) | stat: -rw-r--r-- 4,519 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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/qgscheckablecombobox.h                                       *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/







class QgsCheckableComboBox : QComboBox
{
%Docstring(signature="appended")
QComboBox subclass which allows selecting multiple items.
%End

%TypeHeaderCode
#include "qgscheckablecombobox.h"
%End
  public:
    QgsCheckableComboBox( QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsCheckableComboBox.
%End

    QString separator() const;
%Docstring
Returns separator used to separate items in the display text.

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

    void setSeparator( const QString &separator );
%Docstring
Set separator used to separate items in the display text.

:param separator: separator to use

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

    QString defaultText() const;
%Docstring
Returns default text which will be displayed in the widget when no items
selected.

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

    void setDefaultText( const QString &text );
%Docstring
Set default text which will be displayed in the widget when no items
selected.

:param text: default text

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

    void addItemWithCheckState( const QString &text, Qt::CheckState state, const QVariant &userData = QVariant() );
%Docstring
Adds an item to the combobox with the given ``text``, check ``state``
(stored in the Qt.CheckStateRole) and containing the specified
``userData`` (stored in the Qt.UserRole). The item is appended to the
list of existing items.

.. versionadded:: 3.16
%End

    QStringList checkedItems() const;
%Docstring
Returns currently checked items.

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

    QVariantList checkedItemsData() const;
%Docstring
Returns userData (stored in the Qt.UserRole) associated with currently
checked items.

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

    Qt::CheckState itemCheckState( int index ) const;
%Docstring
Returns the checked state of the item identified by index

:param index: item index

.. seealso:: :py:func:`setItemCheckState`

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

    void setItemCheckState( int index, Qt::CheckState state );
%Docstring
Sets the item check state to state

:param index: item index
:param state: check state

.. seealso:: :py:func:`itemCheckState`

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

    void toggleItemCheckState( int index );
%Docstring
Toggles the item check state

:param index: item index

.. seealso:: :py:func:`itemCheckState`

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


    virtual void hidePopup();

%Docstring
Hides the list of items in the combobox if it is currently visible and
resets the internal state.
%End

    virtual bool eventFilter( QObject *object, QEvent *event );

%Docstring
Filters events to enable context menu
%End

  signals:

    void checkedItemsChanged( const QStringList &items );
%Docstring
Emitted whenever the checked items list changed.
%End

  public slots:

    void setCheckedItems( const QStringList &items );
%Docstring
Set items which should be checked/selected.

:param items: items to select

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

  protected:
    virtual void resizeEvent( QResizeEvent *event );

%Docstring
Handler for widget resizing
%End

  protected slots:

    void showContextMenu( QPoint pos );
%Docstring
Display context menu which allows selecting/deselecting all items at
once.
%End

    void selectAllOptions();
%Docstring
Selects all items.
%End

    void deselectAllOptions();
%Docstring
Removes selection from all items.
%End

  protected:

};

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