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
191
192
193
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/editform/qgsattributeeditorcontainer.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsAttributeEditorContainer : QgsAttributeEditorElement
{
%Docstring(signature="appended")
This is a container for attribute editors, used to group them visually
in the attribute form if it is set to the drag and drop designer.
%End
%TypeHeaderCode
#include "qgsattributeeditorcontainer.h"
%End
public:
QgsAttributeEditorContainer( const QString &name, QgsAttributeEditorElement *parent, const QColor &backgroundColor = QColor() );
%Docstring
Creates a new attribute editor container
:param name: The name to show as title
:param parent: The parent. May be another container.
:param backgroundColor: The optional background color of the container.
%End
~QgsAttributeEditorContainer();
virtual void addChildElement( QgsAttributeEditorElement *element /Transfer/ );
%Docstring
Add a child element to this container. This may be another container, a
field or a relation.
:param element: The element to add as child
%End
void setType( Qgis::AttributeEditorContainerType type );
%Docstring
Sets the container type.
.. seealso:: :py:func:`type`
.. versionadded:: 3.32
%End
Qgis::AttributeEditorContainerType type() const;
%Docstring
Returns the container type.
.. seealso:: :py:func:`setType`
.. versionadded:: 3.32
%End
virtual void setIsGroupBox( bool isGroupBox ) /Deprecated/;
%Docstring
Determines if this container is rendered as collapsible group box or tab
in a tabwidget
:param isGroupBox: If ``True``, this will be a group box
.. deprecated:: 3.40
Use :py:func:`~QgsAttributeEditorContainer.setType` instead.
%End
virtual bool isGroupBox() const /Deprecated/;
%Docstring
Returns if this container is going to be a group box
:return: ``True`` if it will be a group box, ``False`` if it will be a
tab
.. deprecated:: 3.40
Use :py:func:`~QgsAttributeEditorContainer.type` instead.
%End
bool collapsed() const;
%Docstring
For group box containers returns ``True`` if this group box is
collapsed.
:return: ``True`` if the group box is collapsed, ``False`` otherwise.
.. seealso:: :py:func:`collapsed`
.. seealso:: :py:func:`setCollapsed`
.. versionadded:: 3.26
%End
void setCollapsed( bool collapsed );
%Docstring
For group box containers sets if this group box is ``collapsed``.
.. seealso:: :py:func:`collapsed`
.. seealso:: :py:func:`setCollapsed`
.. versionadded:: 3.26
%End
QList<QgsAttributeEditorElement *> children() const;
%Docstring
Gets a list of the children elements of this container
:return: A list of elements
%End
virtual QList<QgsAttributeEditorElement *> findElements( Qgis::AttributeEditorType type ) const;
%Docstring
Traverses the element tree to find any element of the specified type
:param type: The type which should be searched
:return: A list of elements of the type which has been searched for
%End
void clear();
%Docstring
Clear all children from this container.
%End
void setName( const QString &name );
%Docstring
Change the name of this container.
%End
int columnCount() const;
%Docstring
Gets the number of columns in this group.
.. seealso:: :py:func:`setColumnCount`
%End
void setColumnCount( int columnCount );
%Docstring
Set the number of columns in this group.
.. seealso:: :py:func:`columnCount`
%End
virtual QgsAttributeEditorElement *clone( QgsAttributeEditorElement *parent ) const /Factory/;
%Docstring
Creates a deep copy of this element. To be implemented by subclasses.
%End
QgsOptionalExpression visibilityExpression() const;
%Docstring
The visibility expression is used in the attribute form to show or hide
this container based on an expression incorporating the field value
controlled by editor widgets.
%End
void setVisibilityExpression( const QgsOptionalExpression &visibilityExpression );
%Docstring
The visibility expression is used in the attribute form to show or hide
this container based on an expression incorporating the field value
controlled by editor widgets.
%End
QColor backgroundColor() const;
%Docstring
Returns the background color of the container.
.. seealso:: :py:func:`setBackgroundColor`
.. versionadded:: 3.8
%End
void setBackgroundColor( const QColor &backgroundColor );
%Docstring
Sets the background color to ``backgroundColor``.
.. seealso:: :py:func:`backgroundColor`
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/editform/qgsattributeeditorcontainer.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
