Class: QgsAttributeEditorContainer

class qgis.core.QgsAttributeEditorContainer(name: str, parent: QgsAttributeEditorElement, backgroundColor: Union[QColor, Qt.GlobalColor, QGradient] = QColor())

Bases: qgis._core.QgsAttributeEditorElement

Creates a new attribute editor container

Parameters:
  • name – The name to show as title
  • parent – The parent. May be another container.
  • backgroundColor – The optional background color of the container.

QgsAttributeEditorContainer(QgsAttributeEditorContainer)

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.

Enums

Methods

addChildElement Add a child element to this container.
backgroundColor backgroundColor
children Gets a list of the children elements of this container
clear Clear all children from this container.
clone Creates a deep copy of this element.
columnCount Gets the number of columns in this group
findElements Traverses the element tree to find any element of the specified type
isGroupBox Returns if this container is going to be rendered as a group box
setBackgroundColor Sets the background color to backgroundColor
setColumnCount Set the number of columns in this group
setIsGroupBox Determines if this container is rendered as collapsible group box or tab in a tabwidget
setName Change the name of this container
setVisibilityExpression 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.
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.

Signals

Attributes

addChildElement(self, element: QgsAttributeEditorElement)

Add a child element to this container. This may be another container, a field or a relation.

Parameters:element – The element to add as child
backgroundColor(self) → QColor

backgroundColor

Returns:background color of the container

New in version 3.8.

children(self) → object

Gets a list of the children elements of this container

Returns:A list of elements
clear(self)

Clear all children from this container.

clone(self, parent: QgsAttributeEditorElement) → QgsAttributeEditorElement

Creates a deep copy of this element. To be implemented by subclasses.

New in version 3.0.

columnCount(self) → int

Gets the number of columns in this group

findElements(self, type: QgsAttributeEditorElement.AttributeEditorType) → List[QgsAttributeEditorElement]

Traverses the element tree to find any element of the specified type

Parameters:type – The type which should be searched
Returns:A list of elements of the type which has been searched for
isGroupBox(self) → bool

Returns if this container is going to be rendered as a group box

Returns:True if it will be a group box, False if it will be a tab
setBackgroundColor(self, backgroundColor: Union[QColor, Qt.GlobalColor, QGradient])

Sets the background color to backgroundColor

setColumnCount(self, columnCount: int)

Set the number of columns in this group

setIsGroupBox(self, isGroupBox: bool)

Determines if this container is rendered as collapsible group box or tab in a tabwidget

Parameters:isGroupBox – If True, this will be a group box
setName(self, name: str)

Change the name of this container

setVisibilityExpression(self, visibilityExpression: QgsOptionalExpression)

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.

New in version 3.0.

visibilityExpression(self) → QgsOptionalExpression

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.

New in version 3.0.