QGIS API Documentation 3.41.0-Master (092dc69654e)
|
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. More...
#include <qgsattributeeditorcontainer.h>
Public Member Functions | |
QgsAttributeEditorContainer (const QString &name, QgsAttributeEditorElement *parent, const QColor &backgroundColor=QColor()) | |
Creates a new attribute editor container. | |
~QgsAttributeEditorContainer () override | |
virtual void | addChildElement (QgsAttributeEditorElement *element) |
Add a child element to this container. | |
QColor | backgroundColor () const |
Returns the background color of the container. | |
QList< QgsAttributeEditorElement * > | children () const |
Gets a list of the children elements of this container. | |
void | clear () |
Clear all children from this container. | |
QgsAttributeEditorElement * | clone (QgsAttributeEditorElement *parent) const override |
Creates a deep copy of this element. | |
bool | collapsed () const |
For group box containers returns true if this group box is collapsed. | |
QgsOptionalExpression | collapsedExpression () const |
The collapsed expression is used in the attribute form to set the collapsed status of the group box container container based on an expression incorporating the field value controlled by editor widgets. | |
int | columnCount () const |
Gets the number of columns in this group. | |
virtual QList< QgsAttributeEditorElement * > | findElements (Qgis::AttributeEditorType type) const |
Traverses the element tree to find any element of the specified type. | |
virtual Q_DECL_DEPRECATED bool | isGroupBox () const |
Returns if this container is going to be a group box. | |
void | setBackgroundColor (const QColor &backgroundColor) |
Sets the background color to backgroundColor. | |
void | setCollapsed (bool collapsed) |
For group box containers sets if this group box is collapsed. | |
void | setCollapsedExpression (const QgsOptionalExpression &collapsedExpression) |
The collapsed expression is used in the attribute form to set the collapsed status of the group box of this container based on an expression incorporating the field value controlled by editor widgets. | |
void | setColumnCount (int columnCount) |
Set the number of columns in this group. | |
virtual Q_DECL_DEPRECATED void | setIsGroupBox (bool isGroupBox) |
Determines if this container is rendered as collapsible group box or tab in a tabwidget. | |
void | setName (const QString &name) |
Change the name of this container. | |
void | setType (Qgis::AttributeEditorContainerType type) |
Sets the container type. | |
void | setVisibilityExpression (const QgsOptionalExpression &visibilityExpression) |
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. | |
Qgis::AttributeEditorContainerType | type () const |
Returns the container type. | |
QgsOptionalExpression | visibilityExpression () const |
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. | |
Public Member Functions inherited from QgsAttributeEditorElement | |
QgsAttributeEditorElement (Qgis::AttributeEditorType type, const QString &name, QgsAttributeEditorElement *parent=nullptr) | |
Constructor. | |
virtual | ~QgsAttributeEditorElement ()=default |
int | horizontalStretch () const |
Returns the horizontal stretch factor for the element. | |
LabelStyle | labelStyle () const |
Returns the label style. | |
QString | name () const |
Returns the name of this element. | |
QgsAttributeEditorElement * | parent () const |
Gets the parent of this element. | |
void | setHorizontalStretch (int stretch) |
Sets the horizontal stretch factor for the element. | |
void | setLabelStyle (const LabelStyle &labelStyle) |
Sets the labelStyle. | |
void | setShowLabel (bool showLabel) |
Controls if this element should be labeled with a title (field, relation or groupname). | |
void | setVerticalStretch (int stretch) |
Sets the vertical stretch factor for the element. | |
bool | showLabel () const |
Controls if this element should be labeled with a title (field, relation or groupname). | |
QDomElement | toDomElement (QDomDocument &doc) const |
Gets the XML Dom element to save this element. | |
Qgis::AttributeEditorType | type () const |
The type of this element. | |
int | verticalStretch () const |
Returns the vertical stretch factor for the element. | |
Additional Inherited Members | |
Static Public Member Functions inherited from QgsAttributeEditorElement | |
static QgsAttributeEditorElement * | create (const QDomElement &element, const QString &layerId, const QgsFields &fields, const QgsReadWriteContext &context, QgsAttributeEditorElement *parent=nullptr) |
Constructs the editor element from the given element. | |
Protected Attributes inherited from QgsAttributeEditorElement | |
int | mHorizontalStretch = 0 |
LabelStyle | mLabelStyle |
QString | mName |
QgsAttributeEditorElement * | mParent = nullptr |
bool | mShowLabel = true |
Qgis::AttributeEditorType | mType = Qgis::AttributeEditorType::Invalid |
int | mVerticalStretch = 0 |
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.
Definition at line 28 of file qgsattributeeditorcontainer.h.
|
inline |
Creates a new attribute editor container.
name | The name to show as title |
parent | The parent. May be another container. |
backgroundColor | The optional background color of the container. |
Definition at line 39 of file qgsattributeeditorcontainer.h.
|
override |
Definition at line 20 of file qgsattributeeditorcontainer.cpp.
|
virtual |
Add a child element to this container.
This may be another container, a field or a relation.
element | The element to add as child |
Definition at line 25 of file qgsattributeeditorcontainer.cpp.
QColor QgsAttributeEditorContainer::backgroundColor | ( | ) | const |
Returns the background color of the container.
Definition at line 74 of file qgsattributeeditorcontainer.cpp.
|
inline |
Gets a list of the children elements of this container.
Definition at line 110 of file qgsattributeeditorcontainer.h.
void QgsAttributeEditorContainer::clear | ( | ) |
Clear all children from this container.
Definition at line 107 of file qgsattributeeditorcontainer.cpp.
|
overridevirtual |
Creates a deep copy of this element.
To be implemented by subclasses.
Implements QgsAttributeEditorElement.
Definition at line 123 of file qgsattributeeditorcontainer.cpp.
|
inline |
For group box containers returns true
if this group box is collapsed.
true
if the group box is collapsed, false
otherwise. Definition at line 94 of file qgsattributeeditorcontainer.h.
QgsOptionalExpression QgsAttributeEditorContainer::collapsedExpression | ( | ) | const |
The collapsed expression is used in the attribute form to set the collapsed status of the group box container container based on an expression incorporating the field value controlled by editor widgets.
This property is ignored if the container is not a group box.
Definition at line 61 of file qgsattributeeditorcontainer.cpp.
int QgsAttributeEditorContainer::columnCount | ( | ) | const |
Gets the number of columns in this group.
Definition at line 113 of file qgsattributeeditorcontainer.cpp.
|
virtual |
Traverses the element tree to find any element of the specified type.
type | The type which should be searched |
Definition at line 84 of file qgsattributeeditorcontainer.cpp.
|
virtual |
Returns if this container is going to be a group box.
true
if it will be a group box, false
if it will be a tabDefinition at line 38 of file qgsattributeeditorcontainer.cpp.
void QgsAttributeEditorContainer::setBackgroundColor | ( | const QColor & | backgroundColor | ) |
Sets the background color to backgroundColor.
Definition at line 79 of file qgsattributeeditorcontainer.cpp.
|
inline |
For group box containers sets if this group box is collapsed.
Definition at line 103 of file qgsattributeeditorcontainer.h.
void QgsAttributeEditorContainer::setCollapsedExpression | ( | const QgsOptionalExpression & | collapsedExpression | ) |
The collapsed expression is used in the attribute form to set the collapsed status of the group box of this container based on an expression incorporating the field value controlled by editor widgets.
This property is ignored if the container is not a group box.
Definition at line 66 of file qgsattributeeditorcontainer.cpp.
void QgsAttributeEditorContainer::setColumnCount | ( | int | columnCount | ) |
Set the number of columns in this group.
Definition at line 118 of file qgsattributeeditorcontainer.cpp.
|
virtual |
Determines if this container is rendered as collapsible group box or tab in a tabwidget.
isGroupBox | If true , this will be a group box |
Definition at line 30 of file qgsattributeeditorcontainer.cpp.
void QgsAttributeEditorContainer::setName | ( | const QString & | name | ) |
Change the name of this container.
Definition at line 43 of file qgsattributeeditorcontainer.cpp.
|
inline |
Sets the container type.
Definition at line 59 of file qgsattributeeditorcontainer.h.
void QgsAttributeEditorContainer::setVisibilityExpression | ( | const QgsOptionalExpression & | visibilityExpression | ) |
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.
Definition at line 53 of file qgsattributeeditorcontainer.cpp.
|
inline |
Returns the container type.
Definition at line 67 of file qgsattributeeditorcontainer.h.
QgsOptionalExpression QgsAttributeEditorContainer::visibilityExpression | ( | ) | const |
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.
Definition at line 48 of file qgsattributeeditorcontainer.cpp.