#include <qgsattributesformproperties.h>

Inheritance diagram for QgsAttributesFormProperties::DnDTreeItemData:

Public Types
enum	Type { Field , Relation , Container , QmlWidget , HtmlWidget , WidgetType , Action , TextWidget , SpacerWidget }

Public Member Functions
	DnDTreeItemData ()=default

	DnDTreeItemData (Type type, const QString &name, const QString &displayName, const QColor &backgroundColor=QColor())

QColor	backgroundColor () const

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

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

int	columnCount () const

QString	displayName () const

HtmlElementEditorConfiguration	htmlElementEditorConfiguration () const

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

QString	name () const

	operator QVariant ()

QmlElementEditorConfiguration	qmlElementEditorConfiguration () const

RelationEditorConfiguration	relationEditorConfiguration () const

void	setBackgroundColor (const QColor &backgroundColor)

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

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

void	setColumnCount (int count)

void	setDisplayName (const QString &displayName)

void	setHtmlElementEditorConfiguration (HtmlElementEditorConfiguration htmlElementEditorConfiguration)

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

void	setName (const QString &name)

void	setQmlElementEditorConfiguration (QmlElementEditorConfiguration qmlElementEditorConfiguration)

void	setRelationEditorConfiguration (RelationEditorConfiguration relationEditorConfiguration)

void	setShowAsGroupBox (bool showAsGroupBox)

void	setShowLabel (bool showLabel)

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

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

void	setType (Type type)

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

bool	showAsGroupBox () const

bool	showLabel () const

SpacerElementEditorConfiguration	spacerElementEditorConfiguration () const
	Returns the spacer element configuration. More...

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

Type	type () const

QgsOptionalExpression	visibilityExpression () const

Detailed Description

Definition at line 109 of file qgsattributesformproperties.h.

Member Enumeration Documentation

◆ Type

enum QgsAttributesFormProperties::DnDTreeItemData::Type

Enumerator
Field
Relation
Container	Container for the form.
QmlWidget
HtmlWidget
WidgetType	In the widget tree, the type of widget.
Action	Layer action.
TextWidget	Text widget type,. Since QGIS 3.30
SpacerWidget	Spacer widget type,. Since QGIS 3.30

Definition at line 112 of file qgsattributesformproperties.h.

Constructor & Destructor Documentation

◆ DnDTreeItemData() [1/2]

QgsAttributesFormProperties::DnDTreeItemData::DnDTreeItemData ( )

default

◆ DnDTreeItemData() [2/2]

QgsAttributesFormProperties::DnDTreeItemData::DnDTreeItemData	(	Type	type,
		const QString &	name,
		const QString &	displayName,
		const QColor &	backgroundColor = `QColor()`
	)

inline

Definition at line 128 of file qgsattributesformproperties.h.

Member Function Documentation

◆ backgroundColor()

QColor QgsAttributesFormProperties::DnDTreeItemData::backgroundColor ( ) const

Definition at line 1826 of file qgsattributesformproperties.cpp.

◆ collapsed()

bool QgsAttributesFormProperties::DnDTreeItemData::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 160 of file qgsattributesformproperties.h.

◆ collapsedExpression()

QgsOptionalExpression QgsAttributesFormProperties::DnDTreeItemData::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 1775 of file qgsattributesformproperties.cpp.

◆ columnCount()

int QgsAttributesFormProperties::DnDTreeItemData::columnCount ( ) const

inline

Definition at line 146 of file qgsattributesformproperties.h.

◆ displayName()

QString QgsAttributesFormProperties::DnDTreeItemData::displayName ( ) const

inline

Definition at line 138 of file qgsattributesformproperties.h.

◆ htmlElementEditorConfiguration()

QgsAttributesFormProperties::HtmlElementEditorConfiguration QgsAttributesFormProperties::DnDTreeItemData::htmlElementEditorConfiguration ( ) const

Definition at line 1806 of file qgsattributesformproperties.cpp.

◆ labelStyle()

const QgsAttributeEditorElement::LabelStyle QgsAttributesFormProperties::DnDTreeItemData::labelStyle ( ) const

Returns the label style.

See also: setLabelStyle()

Since: QGIS 3.26

Definition at line 1745 of file qgsattributesformproperties.cpp.

◆ name()

QString QgsAttributesFormProperties::DnDTreeItemData::name ( ) const

inline

Definition at line 135 of file qgsattributesformproperties.h.

◆ operator QVariant()

QgsAttributesFormProperties::DnDTreeItemData::operator QVariant ( )

inline

Definition at line 144 of file qgsattributesformproperties.h.

◆ qmlElementEditorConfiguration()

QgsAttributesFormProperties::QmlElementEditorConfiguration QgsAttributesFormProperties::DnDTreeItemData::qmlElementEditorConfiguration ( ) const

Definition at line 1795 of file qgsattributesformproperties.cpp.

◆ relationEditorConfiguration()

QgsAttributesFormProperties::RelationEditorConfiguration QgsAttributesFormProperties::DnDTreeItemData::relationEditorConfiguration ( ) const

Definition at line 1785 of file qgsattributesformproperties.cpp.

◆ setBackgroundColor()

void QgsAttributesFormProperties::DnDTreeItemData::setBackgroundColor ( const QColor & backgroundColor )

Definition at line 1831 of file qgsattributesformproperties.cpp.

◆ setCollapsed()

void QgsAttributesFormProperties::DnDTreeItemData::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 169 of file qgsattributesformproperties.h.

◆ setCollapsedExpression()

void QgsAttributesFormProperties::DnDTreeItemData::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 1780 of file qgsattributesformproperties.cpp.

◆ setColumnCount()

void QgsAttributesFormProperties::DnDTreeItemData::setColumnCount ( int count )

inline

Definition at line 147 of file qgsattributesformproperties.h.

◆ setDisplayName()

void QgsAttributesFormProperties::DnDTreeItemData::setDisplayName ( const QString & displayName )

inline

Definition at line 139 of file qgsattributesformproperties.h.

◆ setHtmlElementEditorConfiguration()

void QgsAttributesFormProperties::DnDTreeItemData::setHtmlElementEditorConfiguration ( QgsAttributesFormProperties::HtmlElementEditorConfiguration htmlElementEditorConfiguration )

Definition at line 1811 of file qgsattributesformproperties.cpp.

◆ setLabelStyle()

void QgsAttributesFormProperties::DnDTreeItemData::setLabelStyle ( const QgsAttributeEditorElement::LabelStyle & labelStyle )

Sets the label style to labelStyle.

See also: labelStyle()

Since: QGIS 3.26

Definition at line 1750 of file qgsattributesformproperties.cpp.

◆ setName()

void QgsAttributesFormProperties::DnDTreeItemData::setName ( const QString & name )

inline

Definition at line 136 of file qgsattributesformproperties.h.

◆ setQmlElementEditorConfiguration()

void QgsAttributesFormProperties::DnDTreeItemData::setQmlElementEditorConfiguration ( QgsAttributesFormProperties::QmlElementEditorConfiguration qmlElementEditorConfiguration )

Definition at line 1800 of file qgsattributesformproperties.cpp.

◆ setRelationEditorConfiguration()

void QgsAttributesFormProperties::DnDTreeItemData::setRelationEditorConfiguration ( QgsAttributesFormProperties::RelationEditorConfiguration relationEditorConfiguration )

Definition at line 1790 of file qgsattributesformproperties.cpp.

◆ setShowAsGroupBox()

void QgsAttributesFormProperties::DnDTreeItemData::setShowAsGroupBox ( bool showAsGroupBox )

Definition at line 1740 of file qgsattributesformproperties.cpp.

◆ setShowLabel()

void QgsAttributesFormProperties::DnDTreeItemData::setShowLabel ( bool showLabel )

Definition at line 1760 of file qgsattributesformproperties.cpp.

◆ setSpacerElementEditorConfiguration()

void QgsAttributesFormProperties::DnDTreeItemData::setSpacerElementEditorConfiguration ( SpacerElementEditorConfiguration spacerElementEditorConfiguration )

Sets the the spacer element configuration to spacerElementEditorConfiguration.

Since: QGIS 3.30

Definition at line 1821 of file qgsattributesformproperties.cpp.

◆ setTextElementEditorConfiguration()

void QgsAttributesFormProperties::DnDTreeItemData::setTextElementEditorConfiguration ( const TextElementEditorConfiguration & textElementEditorConfiguration )

Sets the editor configuration for text element to textElementEditorConfiguration.

Since: QGIS 3.30

Definition at line 1841 of file qgsattributesformproperties.cpp.

◆ setType()

void QgsAttributesFormProperties::DnDTreeItemData::setType ( Type type )

inline

Definition at line 142 of file qgsattributesformproperties.h.

◆ setVisibilityExpression()

void QgsAttributesFormProperties::DnDTreeItemData::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 1770 of file qgsattributesformproperties.cpp.

◆ showAsGroupBox()

bool QgsAttributesFormProperties::DnDTreeItemData::showAsGroupBox ( ) const

Definition at line 1735 of file qgsattributesformproperties.cpp.

◆ showLabel()

bool QgsAttributesFormProperties::DnDTreeItemData::showLabel ( ) const

Definition at line 1755 of file qgsattributesformproperties.cpp.

◆ spacerElementEditorConfiguration()

QgsAttributesFormProperties::SpacerElementEditorConfiguration QgsAttributesFormProperties::DnDTreeItemData::spacerElementEditorConfiguration ( ) const

Returns the spacer element configuration.

Since: QGIS 3.30

Definition at line 1816 of file qgsattributesformproperties.cpp.

◆ textElementEditorConfiguration()

QgsAttributesFormProperties::TextElementEditorConfiguration QgsAttributesFormProperties::DnDTreeItemData::textElementEditorConfiguration ( ) const

Returns the editor configuration for text element.

Since: QGIS 3.30

Definition at line 1836 of file qgsattributesformproperties.cpp.

◆ type()

Type QgsAttributesFormProperties::DnDTreeItemData::type ( ) const

inline

Definition at line 141 of file qgsattributesformproperties.h.

◆ visibilityExpression()

QgsOptionalExpression QgsAttributesFormProperties::DnDTreeItemData::visibilityExpression ( ) const

Definition at line 1765 of file qgsattributesformproperties.cpp.

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

/build/qgis-3.30.0+99sid/src/gui/vector/qgsattributesformproperties.h
/build/qgis-3.30.0+99sid/src/gui/vector/qgsattributesformproperties.cpp

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ Type

Constructor & Destructor Documentation

◆ DnDTreeItemData() [1/2]

◆ DnDTreeItemData() [2/2]

Member Function Documentation

◆ backgroundColor()

◆ collapsed()

◆ collapsedExpression()

◆ columnCount()

◆ displayName()

◆ htmlElementEditorConfiguration()

◆ labelStyle()

◆ name()

◆ operator QVariant()

◆ qmlElementEditorConfiguration()

◆ relationEditorConfiguration()

◆ setBackgroundColor()

◆ setCollapsed()

◆ setCollapsedExpression()

◆ setColumnCount()

◆ setDisplayName()

◆ setHtmlElementEditorConfiguration()

◆ setLabelStyle()

◆ setName()

◆ setQmlElementEditorConfiguration()

◆ setRelationEditorConfiguration()

◆ setShowAsGroupBox()

◆ setShowLabel()

◆ setSpacerElementEditorConfiguration()

◆ setTextElementEditorConfiguration()

◆ setType()

◆ setVisibilityExpression()

◆ showAsGroupBox()

◆ showLabel()

◆ spacerElementEditorConfiguration()

◆ textElementEditorConfiguration()

◆ type()

◆ visibilityExpression()