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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/editorwidgets/qgssearchwidgettoolbutton.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
%ModuleHeaderCode
#include "qgssearchwidgettoolbutton.h"
%End
class QgsSearchWidgetToolButton : QToolButton
{
%Docstring(signature="appended")
A tool button widget which is displayed next to search widgets in forms,
and allows for controlling how the widget behaves and how the
filtering/searching operates.
%End
%TypeHeaderCode
#include "qgssearchwidgettoolbutton.h"
%End
%ConvertToSubClassCode
if ( qobject_cast<QgsSearchWidgetToolButton *>( sipCpp ) )
sipType = sipType_QgsSearchWidgetToolButton;
else
sipType = nullptr;
%End
public:
explicit QgsSearchWidgetToolButton( QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsSearchWidgetToolButton.
:param parent: parent object
%End
void setAvailableFlags( QgsSearchWidgetWrapper::FilterFlags flags );
%Docstring
Sets the available filter flags to show in the widget. Any active flags
(see :py:func:`~QgsSearchWidgetToolButton.activeFlags`) which are not
present in the new available filter flags will be cleared;
:param flags: available flags to show in widget
.. seealso:: :py:func:`availableFlags`
.. seealso:: :py:func:`setActiveFlags`
.. seealso:: :py:func:`setDefaultFlags`
%End
void setDefaultFlags( QgsSearchWidgetWrapper::FilterFlags flags );
%Docstring
Sets the default filter flags to show in the widget.
:param flags: default flags to show in widget
.. seealso:: :py:func:`setAvailableFlags`
.. seealso:: :py:func:`setActiveFlags`
%End
QgsSearchWidgetWrapper::FilterFlags availableFlags() const;
%Docstring
Returns the available filter flags shown in the widget.
.. seealso:: :py:func:`setAvailableFlags`
.. seealso:: :py:func:`activeFlags`
%End
void setActiveFlags( QgsSearchWidgetWrapper::FilterFlags flags );
%Docstring
Sets the current active filter flags for the widget. Any flags which are
not present in the available filter flags (see
:py:func:`~QgsSearchWidgetToolButton.availableFlags`) will not be set.
:param flags: active flags to show in widget
.. seealso:: :py:func:`toggleFlag`
.. seealso:: :py:func:`activeFlags`
.. seealso:: :py:func:`setAvailableFlags`
%End
void toggleFlag( QgsSearchWidgetWrapper::FilterFlag flag );
%Docstring
Toggles an individual active filter flag for the widget. Any flags which
are not present in the available filter flags (see
:py:func:`~QgsSearchWidgetToolButton.availableFlags`) will be ignore.
Other flags may be cleared if they conflict with the newly toggled flag.
:param flag: flag to toggle
.. seealso:: :py:func:`setActiveFlags`
.. seealso:: :py:func:`activeFlags`
%End
QgsSearchWidgetWrapper::FilterFlags activeFlags() const;
%Docstring
Returns the active filter flags shown in the widget.
.. seealso:: :py:func:`setActiveFlags`
.. seealso:: :py:func:`toggleFlag`
.. seealso:: :py:func:`availableFlags`
%End
bool isActive() const;
%Docstring
Returns ``True`` if the widget is set to be included in the search.
.. seealso:: :py:func:`setInactive`
.. seealso:: :py:func:`setActive`
%End
public slots:
void setInactive();
%Docstring
Sets the search widget as inactive, ie do not search the corresponding
field.
.. seealso:: :py:func:`isActive`
.. seealso:: :py:func:`setActive`
%End
void setActive();
%Docstring
Sets the search widget as active by selecting the first available search
type.
.. seealso:: :py:func:`isActive`
.. seealso:: :py:func:`setInactive`
%End
signals:
void activeFlagsChanged( QgsSearchWidgetWrapper::FilterFlags flags );
%Docstring
Emitted when the active flags selected in the widget is changed
:param flags: active flags
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/editorwidgets/qgssearchwidgettoolbutton.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
