Main class to store and transfer editor data contained in a QgsAttributesFormModel. More...

#include <qgsattributesformmodel.h>

Public Member Functions
	AttributeFormItemData ()=default

QColor	backgroundColor () const
	Returns the background color of a container.

bool	collapsed () const
	For group box containers returns if this group box is collapsed.

QgsOptionalExpression	collapsedExpression () const
	Returns the optional expression that dynamically controls the collapsed status of a group box container.

int	columnCount () const
	Returns the number of columns in a container.

Qgis::AttributeEditorContainerType	containerType () const
	Returns the container type.

int	horizontalStretch () const
	Returns the horizontal stretch factor for the element.

HtmlElementEditorConfiguration	htmlElementEditorConfiguration () const
	Returns the HTML editor configuration.

const QgsAttributeEditorElement::LabelStyle	labelStyle () const
	Returns the label style.

	operator QVariant ()
	Allows direct construction of QVariants from AttributeFormItemData.

QmlElementEditorConfiguration	qmlElementEditorConfiguration () const
	Returns the QML editor configuration.

RelationEditorConfiguration	relationEditorConfiguration () const
	Returns the relation editor configuration.

void	setBackgroundColor (const QColor &backgroundColor)
	Sets the background color of a container.

void	setCollapsed (bool collapsed)
	For group box containers sets if this group box is collapsed.

void	setCollapsedExpression (const QgsOptionalExpression &collapsedExpression)
	Sets the optional collapsedExpression that dynamically controls the collapsed status of a group box container.

void	setColumnCount (int count)
	Sets the number of columns for a container.

void	setContainerType (Qgis::AttributeEditorContainerType type)
	Sets the container type.

void	setHorizontalStretch (int stretch)
	Sets the horizontal stretch factor for the element.

void	setHtmlElementEditorConfiguration (const HtmlElementEditorConfiguration &htmlElementEditorConfiguration)
	Sets the HTML editor configuration.

void	setLabelStyle (const QgsAttributeEditorElement::LabelStyle &labelStyle)
	Sets the label style to labelStyle.

void	setQmlElementEditorConfiguration (const QmlElementEditorConfiguration &qmlElementEditorConfiguration)
	Sets the QML editor configuration.

void	setRelationEditorConfiguration (const RelationEditorConfiguration &relationEditorConfiguration)
	Sets the relation editor configuration.

void	setShowLabel (bool showLabel)
	Sets whether the label for the widget should be shown.

void	setSpacerElementEditorConfiguration (SpacerElementEditorConfiguration spacerElementEditorConfiguration)
	Sets the the spacer element configuration to spacerElementEditorConfiguration.

void	setTextElementEditorConfiguration (const TextElementEditorConfiguration &textElementEditorConfiguration)
	Sets the editor configuration for text element to textElementEditorConfiguration.

void	setVerticalStretch (int stretch)
	Sets the vertical stretch factor for the element.

void	setVisibilityExpression (const QgsOptionalExpression &visibilityExpression)
	Sets the optional visibilityExpression that dynamically controls the visibility status of a container.

bool	showLabel () const
	Returns whether the widget's label is to be shown.

SpacerElementEditorConfiguration	spacerElementEditorConfiguration () const
	Returns the spacer element configuration.

TextElementEditorConfiguration	textElementEditorConfiguration () const
	Returns the editor configuration for text element.

int	verticalStretch () const
	Returns the vertical stretch factor for the element.

QgsOptionalExpression	visibilityExpression () const
	Returns the expression to control the visibility status of a container.

Detailed Description

Main class to store and transfer editor data contained in a QgsAttributesFormModel.

Note: Prior to QGIS 3.44 this was available as QgsAttributesFormProperties::DnDTreeItemData

Since: QGIS 3.44

Definition at line 124 of file qgsattributesformmodel.h.

Constructor & Destructor Documentation

◆ AttributeFormItemData()

QgsAttributesFormData::AttributeFormItemData::AttributeFormItemData ( )

default

Member Function Documentation

◆ backgroundColor()

QColor QgsAttributesFormData::AttributeFormItemData::backgroundColor ( ) const

Returns the background color of a container.

See also: setBackgroundColor()

Definition at line 154 of file qgsattributesformmodel.cpp.

◆ collapsed()

bool QgsAttributesFormData::AttributeFormItemData::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 162 of file qgsattributesformmodel.h.

◆ collapsedExpression()

QgsOptionalExpression QgsAttributesFormData::AttributeFormItemData::collapsedExpression ( ) const

Returns the optional expression that dynamically controls the collapsed status of a group box container.

See also: collapsed(); setCollapsed(); setCollapsedExpression()

Since: QGIS 3.26

Definition at line 103 of file qgsattributesformmodel.cpp.

◆ columnCount()

int QgsAttributesFormData::AttributeFormItemData::columnCount ( ) const

inline

Returns the number of columns in a container.

Definition at line 133 of file qgsattributesformmodel.h.

◆ containerType()

Qgis::AttributeEditorContainerType QgsAttributesFormData::AttributeFormItemData::containerType ( ) const

Returns the container type.

See also: setContainerType()

Since: QGIS 3.32

Definition at line 63 of file qgsattributesformmodel.cpp.

◆ horizontalStretch()

int QgsAttributesFormData::AttributeFormItemData::horizontalStretch ( ) const

inline

Returns the horizontal stretch factor for the element.

See also: setHorizontalStretch(); verticalStretch()

Since: QGIS 3.32

Definition at line 201 of file qgsattributesformmodel.h.

◆ htmlElementEditorConfiguration()

QgsAttributesFormData::HtmlElementEditorConfiguration QgsAttributesFormData::AttributeFormItemData::htmlElementEditorConfiguration ( ) const

Returns the HTML editor configuration.

See also: setHtmlElementEditorConfiguration()

Definition at line 134 of file qgsattributesformmodel.cpp.

◆ labelStyle()

const QgsAttributeEditorElement::LabelStyle QgsAttributesFormData::AttributeFormItemData::labelStyle ( ) const

Returns the label style.

See also: setLabelStyle()

Since: QGIS 3.26

Definition at line 73 of file qgsattributesformmodel.cpp.

◆ operator QVariant()

QgsAttributesFormData::AttributeFormItemData::operator QVariant ( )

inline

Allows direct construction of QVariants from AttributeFormItemData.

Definition at line 130 of file qgsattributesformmodel.h.

◆ qmlElementEditorConfiguration()

QgsAttributesFormData::QmlElementEditorConfiguration QgsAttributesFormData::AttributeFormItemData::qmlElementEditorConfiguration ( ) const

Returns the QML editor configuration.

See also: setQmlElementEditorConfiguration()

Definition at line 123 of file qgsattributesformmodel.cpp.

◆ relationEditorConfiguration()

QgsAttributesFormData::RelationEditorConfiguration QgsAttributesFormData::AttributeFormItemData::relationEditorConfiguration ( ) const

Returns the relation editor configuration.

See also: setRelationEditorConfiguration()

Definition at line 113 of file qgsattributesformmodel.cpp.

◆ setBackgroundColor()

void QgsAttributesFormData::AttributeFormItemData::setBackgroundColor ( const QColor & backgroundColor )

Sets the background color of a container.

See also: backgroundColor()

Definition at line 159 of file qgsattributesformmodel.cpp.

◆ setCollapsed()

void QgsAttributesFormData::AttributeFormItemData::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 171 of file qgsattributesformmodel.h.

◆ setCollapsedExpression()

void QgsAttributesFormData::AttributeFormItemData::setCollapsedExpression ( const QgsOptionalExpression & collapsedExpression )

Sets the optional collapsedExpression that dynamically controls the collapsed status of a group box container.

See also: collapsed(); setCollapsed(); collapsedExpression()

Since: QGIS 3.26

Definition at line 108 of file qgsattributesformmodel.cpp.

◆ setColumnCount()

void QgsAttributesFormData::AttributeFormItemData::setColumnCount ( int count )

inline

Sets the number of columns for a container.

Definition at line 136 of file qgsattributesformmodel.h.

◆ setContainerType()

void QgsAttributesFormData::AttributeFormItemData::setContainerType ( Qgis::AttributeEditorContainerType type )

Sets the container type.

See also: containerType()

Since: QGIS 3.32

Definition at line 68 of file qgsattributesformmodel.cpp.

◆ setHorizontalStretch()

void QgsAttributesFormData::AttributeFormItemData::setHorizontalStretch ( int stretch )

inline

Sets the horizontal stretch factor for the element.

See also: horizontalStretch(); setVerticalStretch()

Since: QGIS 3.32

Definition at line 211 of file qgsattributesformmodel.h.

◆ setHtmlElementEditorConfiguration()

void QgsAttributesFormData::AttributeFormItemData::setHtmlElementEditorConfiguration ( const HtmlElementEditorConfiguration & htmlElementEditorConfiguration )

Sets the HTML editor configuration.

See also: htmlElementEditorConfiguration()

Definition at line 139 of file qgsattributesformmodel.cpp.

◆ setLabelStyle()

void QgsAttributesFormData::AttributeFormItemData::setLabelStyle ( const QgsAttributeEditorElement::LabelStyle & labelStyle )

Sets the label style to labelStyle.

See also: labelStyle()

Since: QGIS 3.26

Definition at line 78 of file qgsattributesformmodel.cpp.

◆ setQmlElementEditorConfiguration()

void QgsAttributesFormData::AttributeFormItemData::setQmlElementEditorConfiguration ( const QmlElementEditorConfiguration & qmlElementEditorConfiguration )

Sets the QML editor configuration.

See also: qmlElementEditorConfiguration()

Definition at line 128 of file qgsattributesformmodel.cpp.

◆ setRelationEditorConfiguration()

void QgsAttributesFormData::AttributeFormItemData::setRelationEditorConfiguration ( const RelationEditorConfiguration & relationEditorConfiguration )

Sets the relation editor configuration.

See also: relationEditorConfiguration()

Definition at line 118 of file qgsattributesformmodel.cpp.

◆ setShowLabel()

void QgsAttributesFormData::AttributeFormItemData::setShowLabel ( bool showLabel )

Sets whether the label for the widget should be shown.

Definition at line 88 of file qgsattributesformmodel.cpp.

◆ setSpacerElementEditorConfiguration()

void QgsAttributesFormData::AttributeFormItemData::setSpacerElementEditorConfiguration ( SpacerElementEditorConfiguration spacerElementEditorConfiguration )

Sets the the spacer element configuration to spacerElementEditorConfiguration.

Since: QGIS 3.30

Definition at line 149 of file qgsattributesformmodel.cpp.

◆ setTextElementEditorConfiguration()

void QgsAttributesFormData::AttributeFormItemData::setTextElementEditorConfiguration ( const TextElementEditorConfiguration & textElementEditorConfiguration )

Sets the editor configuration for text element to textElementEditorConfiguration.

Since: QGIS 3.30

Definition at line 169 of file qgsattributesformmodel.cpp.

◆ setVerticalStretch()

void QgsAttributesFormData::AttributeFormItemData::setVerticalStretch ( int stretch )

inline

Sets the vertical stretch factor for the element.

See also: verticalStretch(); setHorizontalStretch()

Since: QGIS 3.32

Definition at line 231 of file qgsattributesformmodel.h.

◆ setVisibilityExpression()

void QgsAttributesFormData::AttributeFormItemData::setVisibilityExpression ( const QgsOptionalExpression & visibilityExpression )

Sets the optional visibilityExpression that dynamically controls the visibility status of a container.

See also: visibilityExpression()

Since: QGIS 3.26

Definition at line 98 of file qgsattributesformmodel.cpp.

◆ showLabel()

bool QgsAttributesFormData::AttributeFormItemData::showLabel ( ) const

Returns whether the widget's label is to be shown.

Definition at line 83 of file qgsattributesformmodel.cpp.

◆ spacerElementEditorConfiguration()

QgsAttributesFormData::SpacerElementEditorConfiguration QgsAttributesFormData::AttributeFormItemData::spacerElementEditorConfiguration ( ) const

Returns the spacer element configuration.

Since: QGIS 3.30

Definition at line 144 of file qgsattributesformmodel.cpp.

◆ textElementEditorConfiguration()

QgsAttributesFormData::TextElementEditorConfiguration QgsAttributesFormData::AttributeFormItemData::textElementEditorConfiguration ( ) const

Returns the editor configuration for text element.

Since: QGIS 3.30

Definition at line 164 of file qgsattributesformmodel.cpp.

◆ verticalStretch()

int QgsAttributesFormData::AttributeFormItemData::verticalStretch ( ) const

inline

Returns the vertical stretch factor for the element.

See also: setVerticalStretch(); horizontalStretch()

Since: QGIS 3.32

Definition at line 221 of file qgsattributesformmodel.h.

◆ visibilityExpression()

QgsOptionalExpression QgsAttributesFormData::AttributeFormItemData::visibilityExpression ( ) const

Returns the expression to control the visibility status of a container.

See also: setVisibilityExpression()

Definition at line 93 of file qgsattributesformmodel.cpp.

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

/build/qgis-3.43.0+git20250514+56aa1fd18d7+99sid/src/gui/vector/qgsattributesformmodel.h
/build/qgis-3.43.0+git20250514+56aa1fd18d7+99sid/src/gui/vector/qgsattributesformmodel.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AttributeFormItemData()

Member Function Documentation

◆ backgroundColor()

◆ collapsed()

◆ collapsedExpression()

◆ columnCount()

◆ containerType()

◆ horizontalStretch()

◆ htmlElementEditorConfiguration()

◆ labelStyle()

◆ operator QVariant()

◆ qmlElementEditorConfiguration()

◆ relationEditorConfiguration()

◆ setBackgroundColor()

◆ setCollapsed()

◆ setCollapsedExpression()

◆ setColumnCount()

◆ setContainerType()

◆ setHorizontalStretch()

◆ setHtmlElementEditorConfiguration()

◆ setLabelStyle()

◆ setQmlElementEditorConfiguration()

◆ setRelationEditorConfiguration()

◆ setShowLabel()

◆ setSpacerElementEditorConfiguration()

◆ setTextElementEditorConfiguration()

◆ setVerticalStretch()

◆ setVisibilityExpression()

◆ showLabel()

◆ spacerElementEditorConfiguration()

◆ textElementEditorConfiguration()

◆ verticalStretch()

◆ visibilityExpression()