#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.

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

int	columnCount () const

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

QString	displayName () const

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

HtmlElementEditorConfiguration	htmlElementEditorConfiguration () const

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

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.

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

void	setColumnCount (int count)

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

void	setDisplayName (const QString &displayName)

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

void	setHtmlElementEditorConfiguration (HtmlElementEditorConfiguration htmlElementEditorConfiguration)

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

void	setName (const QString &name)

void	setQmlElementEditorConfiguration (QmlElementEditorConfiguration qmlElementEditorConfiguration)

void	setRelationEditorConfiguration (RelationEditorConfiguration relationEditorConfiguration)

void	setShowLabel (bool showLabel)

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	setType (Type type)

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

SpacerElementEditorConfiguration	spacerElementEditorConfiguration () const
	Returns the spacer element configuration.

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

Type	type () const

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

QgsOptionalExpression	visibilityExpression () const

Detailed Description

Definition at line 101 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 104 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 120 of file qgsattributesformproperties.h.

Member Function Documentation

◆ backgroundColor()

QColor QgsAttributesFormProperties::DnDTreeItemData::backgroundColor ( ) const

Definition at line 1944 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 165 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 1893 of file qgsattributesformproperties.cpp.

◆ columnCount()

int QgsAttributesFormProperties::DnDTreeItemData::columnCount ( ) const

inline

Definition at line 138 of file qgsattributesformproperties.h.

◆ containerType()

Qgis::AttributeEditorContainerType QgsAttributesFormProperties::DnDTreeItemData::containerType ( ) const

Returns the container type.

See also: setContainerType()

Since: QGIS 3.32

Definition at line 1853 of file qgsattributesformproperties.cpp.

◆ displayName()

QString QgsAttributesFormProperties::DnDTreeItemData::displayName ( ) const

inline

Definition at line 130 of file qgsattributesformproperties.h.

◆ horizontalStretch()

int QgsAttributesFormProperties::DnDTreeItemData::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 qgsattributesformproperties.h.

◆ htmlElementEditorConfiguration()

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

Definition at line 1924 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 1863 of file qgsattributesformproperties.cpp.

◆ name()

QString QgsAttributesFormProperties::DnDTreeItemData::name ( ) const

inline

Definition at line 127 of file qgsattributesformproperties.h.

◆ operator QVariant()

QgsAttributesFormProperties::DnDTreeItemData::operator QVariant ( )

inline

Definition at line 136 of file qgsattributesformproperties.h.

◆ qmlElementEditorConfiguration()

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

Definition at line 1913 of file qgsattributesformproperties.cpp.

◆ relationEditorConfiguration()

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

Definition at line 1903 of file qgsattributesformproperties.cpp.

◆ setBackgroundColor()

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

Definition at line 1949 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 174 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 1898 of file qgsattributesformproperties.cpp.

◆ setColumnCount()

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

inline

Definition at line 139 of file qgsattributesformproperties.h.

◆ setContainerType()

void QgsAttributesFormProperties::DnDTreeItemData::setContainerType ( Qgis::AttributeEditorContainerType type )

Sets the container type.

See also: containerType()

Since: QGIS 3.32

Definition at line 1858 of file qgsattributesformproperties.cpp.

◆ setDisplayName()

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

inline

Definition at line 131 of file qgsattributesformproperties.h.

◆ setHorizontalStretch()

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

◆ setHtmlElementEditorConfiguration()

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

Definition at line 1929 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 1868 of file qgsattributesformproperties.cpp.

◆ setName()

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

inline

Definition at line 128 of file qgsattributesformproperties.h.

◆ setQmlElementEditorConfiguration()

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

Definition at line 1918 of file qgsattributesformproperties.cpp.

◆ setRelationEditorConfiguration()

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

Definition at line 1908 of file qgsattributesformproperties.cpp.

◆ setShowLabel()

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

Definition at line 1878 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 1939 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 1959 of file qgsattributesformproperties.cpp.

◆ setType()

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

inline

Definition at line 134 of file qgsattributesformproperties.h.

◆ setVerticalStretch()

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

◆ showLabel()

bool QgsAttributesFormProperties::DnDTreeItemData::showLabel ( ) const

Definition at line 1873 of file qgsattributesformproperties.cpp.

◆ spacerElementEditorConfiguration()

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

Returns the spacer element configuration.

Since: QGIS 3.30

Definition at line 1934 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 1954 of file qgsattributesformproperties.cpp.

◆ type()

Type QgsAttributesFormProperties::DnDTreeItemData::type ( ) const

inline

Definition at line 133 of file qgsattributesformproperties.h.

◆ verticalStretch()

int QgsAttributesFormProperties::DnDTreeItemData::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 qgsattributesformproperties.h.

◆ visibilityExpression()

QgsOptionalExpression QgsAttributesFormProperties::DnDTreeItemData::visibilityExpression ( ) const

Definition at line 1883 of file qgsattributesformproperties.cpp.

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

/build/qgis-3.36.0+99sid/src/gui/vector/qgsattributesformproperties.h
/build/qgis-3.36.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()

◆ containerType()

◆ displayName()

◆ horizontalStretch()

◆ htmlElementEditorConfiguration()

◆ labelStyle()

◆ name()

◆ operator QVariant()

◆ qmlElementEditorConfiguration()

◆ relationEditorConfiguration()

◆ setBackgroundColor()

◆ setCollapsed()

◆ setCollapsedExpression()

◆ setColumnCount()

◆ setContainerType()

◆ setDisplayName()

◆ setHorizontalStretch()

◆ setHtmlElementEditorConfiguration()

◆ setLabelStyle()

◆ setName()

◆ setQmlElementEditorConfiguration()

◆ setRelationEditorConfiguration()

◆ setShowLabel()

◆ setSpacerElementEditorConfiguration()

◆ setTextElementEditorConfiguration()

◆ setType()

◆ setVerticalStretch()

◆ setVisibilityExpression()

◆ showLabel()

◆ spacerElementEditorConfiguration()

◆ textElementEditorConfiguration()

◆ type()

◆ verticalStretch()

◆ visibilityExpression()