QgsAttributeEditorContainer Class Reference

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>

Inheritance diagram for QgsAttributeEditorContainer:

Public Member Functions
	QgsAttributeEditorContainer (const QString &name, QgsAttributeEditorElement *parent, const QColor &backgroundColor=QColor())
	Creates a new attribute editor container. More...
	~QgsAttributeEditorContainer () override
virtual void	addChildElement (QgsAttributeEditorElement *element)
	Add a child element to this container. More...
QColor	backgroundColor () const
	backgroundColor More...
QList< QgsAttributeEditorElement * >	children () const
	Gets a list of the children elements of this container. More...
void	clear ()
	Clear all children from this container. More...
QgsAttributeEditorElement *	clone (QgsAttributeEditorElement *parent) const override
	Creates a deep copy of this element. More...
bool	collapsed () const
	For group box containers returns if this group box is collapsed. More...
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. More...
int	columnCount () const
	Gets the number of columns in this group. More...
virtual QList< QgsAttributeEditorElement * >	findElements (AttributeEditorType type) const
	Traverses the element tree to find any element of the specified type. More...
virtual bool	isGroupBox () const
	Returns if this container is going to be a group box. More...
void	setBackgroundColor (const QColor &backgroundColor)
	Sets the background color to backgroundColor. More...
void	setCollapsed (bool collapsed)
	For group box containers sets if this group box is collapsed. More...
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. More...
void	setColumnCount (int columnCount)
	Set the number of columns in this group. More...
virtual void	setIsGroupBox (bool isGroupBox)
	Determines if this container is rendered as collapsible group box or tab in a tabwidget. More...
void	setName (const QString &name)
	Change the name of this container. More...
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. More...
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. More...
Public Member Functions inherited from QgsAttributeEditorElement
	QgsAttributeEditorElement (AttributeEditorType type, const QString &name, QgsAttributeEditorElement *parent=nullptr)
	Constructor. More...
virtual	~QgsAttributeEditorElement ()=default
virtual QgsAttributeEditorElement *	clone (QgsAttributeEditorElement *parent) const =0
	Returns a clone of this element. More...
LabelStyle	labelStyle () const
	Returns the label style. More...
QString	name () const
	Returns the name of this element. More...
QgsAttributeEditorElement *	parent () const
	Gets the parent of this element. More...
void	setLabelStyle (const LabelStyle &labelStyle)
	Sets the labelStyle. More...
void	setShowLabel (bool showLabel)
	Controls if this element should be labeled with a title (field, relation or groupname). More...
bool	showLabel () const
	Controls if this element should be labeled with a title (field, relation or groupname). More...
QDomElement	toDomElement (QDomDocument &doc) const
	Gets the XML Dom element to save this element. More...
AttributeEditorType	type () const
	The type of this element. More...

Additional Inherited Members
Public Types inherited from QgsAttributeEditorElement
enum	AttributeEditorType {   AeTypeContainer , AeTypeField , AeTypeRelation , AeTypeInvalid ,   AeTypeQmlElement , AeTypeHtmlElement , AeTypeAction }
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. More...
Protected Attributes inherited from QgsAttributeEditorElement
LabelStyle	mLabelStyle
QString	mName
QgsAttributeEditorElement *	mParent = nullptr
bool	mShowLabel
AttributeEditorType	mType

Detailed Description

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 27 of file qgsattributeeditorcontainer.h.

Constructor & Destructor Documentation

QgsAttributeEditorContainer()

QgsAttributeEditorContainer::QgsAttributeEditorContainer ( const QString &  name, QgsAttributeEditorElement *  parent, const QColor &  backgroundColor = QColor()  )

inline

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.

Definition at line 38 of file qgsattributeeditorcontainer.h.

~QgsAttributeEditorContainer()

QgsAttributeEditorContainer::~QgsAttributeEditorContainer ( )

override

Definition at line 20 of file qgsattributeeditorcontainer.cpp.

Member Function Documentation

addChildElement()

void QgsAttributeEditorContainer::addChildElement ( QgsAttributeEditorElement *  element )

virtual

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

Definition at line 25 of file qgsattributeeditorcontainer.cpp.

backgroundColor()

QColor QgsAttributeEditorContainer::backgroundColor

(

)

const

backgroundColor

Returns

background color of the container

Since

QGIS 3.8

Definition at line 61 of file qgsattributeeditorcontainer.cpp.

children()

QList< QgsAttributeEditorElement * > QgsAttributeEditorContainer::children ( ) const

inline

Gets a list of the children elements of this container.

Returns

A list of elements

Definition at line 93 of file qgsattributeeditorcontainer.h.

clear()

void QgsAttributeEditorContainer::clear

(

)

Clear all children from this container.

Definition at line 94 of file qgsattributeeditorcontainer.cpp.

clone()

QgsAttributeEditorElement * QgsAttributeEditorContainer::clone ( QgsAttributeEditorElement *  parent ) const

overridevirtual

Creates a deep copy of this element.

To be implemented by subclasses.

Since

QGIS 3.0

Implements QgsAttributeEditorElement.

Definition at line 110 of file qgsattributeeditorcontainer.cpp.

collapsed()

bool QgsAttributeEditorContainer::collapsed ( ) const

inline

For group box containers returns if this group box is collapsed.

Returns

true if the group box is collapsed, false otherwise.

See also

collapsed()

setCollapsed()

Since

QGIS 3.26

Definition at line 77 of file qgsattributeeditorcontainer.h.

collapsedExpression()

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.

Note

Not available in Python bindings

See also

setCollapsedExpression()

Since

QGIS 3.26

Definition at line 48 of file qgsattributeeditorcontainer.cpp.

columnCount()

int QgsAttributeEditorContainer::columnCount

(

)

const

Gets the number of columns in this group.

Definition at line 100 of file qgsattributeeditorcontainer.cpp.

findElements()

QList< QgsAttributeEditorElement * > QgsAttributeEditorContainer::findElements ( QgsAttributeEditorElement::AttributeEditorType  type ) const

virtual

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

Definition at line 71 of file qgsattributeeditorcontainer.cpp.

isGroupBox()

virtual bool QgsAttributeEditorContainer::isGroupBox ( ) const

inlinevirtual

Returns if this container is going to be a group box.

Returns

true if it will be a group box, false if it will be a tab

Definition at line 67 of file qgsattributeeditorcontainer.h.

setBackgroundColor()

void QgsAttributeEditorContainer::setBackgroundColor

(

const QColor &

backgroundColor

)

Sets the background color to backgroundColor.

Definition at line 66 of file qgsattributeeditorcontainer.cpp.

setCollapsed()

void QgsAttributeEditorContainer::setCollapsed ( bool  collapsed )

inline

For group box containers sets if this group box is collapsed.

See also

collapsed()

setCollapsed()

Since

QGIS 3.26

Definition at line 86 of file qgsattributeeditorcontainer.h.

setCollapsedExpression()

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.

Note

Not available in Python bindings

See also

collapsedExpression()

Since

QGIS 3.26

Definition at line 53 of file qgsattributeeditorcontainer.cpp.

setColumnCount()

void QgsAttributeEditorContainer::setColumnCount

(

int

columnCount

)

Set the number of columns in this group.

Definition at line 105 of file qgsattributeeditorcontainer.cpp.

setIsGroupBox()

virtual void QgsAttributeEditorContainer::setIsGroupBox ( bool  isGroupBox )

inlinevirtual

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

Definition at line 60 of file qgsattributeeditorcontainer.h.

setName()

void QgsAttributeEditorContainer::setName

(

const QString &

name

)

Change the name of this container.

Definition at line 30 of file qgsattributeeditorcontainer.cpp.

setVisibilityExpression()

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.

Since

QGIS 3.0

Definition at line 40 of file qgsattributeeditorcontainer.cpp.

visibilityExpression()

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.

Since

QGIS 3.0

Definition at line 35 of file qgsattributeeditorcontainer.cpp.

---

The documentation for this class was generated from the following files:

• /build/qgis-3.28.0+99sid/src/core/editform/qgsattributeeditorcontainer.h
• /build/qgis-3.28.0+99sid/src/core/editform/qgsattributeeditorcontainer.cpp