QGIS API Documentation 3.41.0-Master (af5edcb665c)
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
QgsAttributesFormProperties::DnDTreeItemData Class Reference
gui library

#include <qgsattributesformproperties.h>

Inheritance diagram for QgsAttributesFormProperties::DnDTreeItemData:
Inheritance graph
[legend]

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
 Returns the HTML editor configuration.
 
const QgsAttributeEditorElement::LabelStyle labelStyle () const
 Returns the label style.
 
QString name () const
 
 operator QVariant ()
 
QmlElementEditorConfiguration qmlElementEditorConfiguration () const
 Returns the QML editor configuration.
 
RelationEditorConfiguration relationEditorConfiguration () const
 Returns the relation editor configuration.
 
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 (const HtmlElementEditorConfiguration &htmlElementEditorConfiguration)
 Sets the HTML editor configuration.
 
void setLabelStyle (const QgsAttributeEditorElement::LabelStyle &labelStyle)
 Sets the label style to labelStyle.
 
void setName (const QString &name)
 
void setQmlElementEditorConfiguration (const QmlElementEditorConfiguration &qmlElementEditorConfiguration)
 Sets the QML editor configuration.
 
void setRelationEditorConfiguration (const RelationEditorConfiguration &relationEditorConfiguration)
 Sets the relation editor configuration.
 
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 100 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 103 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 119 of file qgsattributesformproperties.h.

Member Function Documentation

◆ backgroundColor()

QColor QgsAttributesFormProperties::DnDTreeItemData::backgroundColor ( ) const

Definition at line 1943 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 164 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 1892 of file qgsattributesformproperties.cpp.

◆ columnCount()

int QgsAttributesFormProperties::DnDTreeItemData::columnCount ( ) const
inline

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

◆ displayName()

QString QgsAttributesFormProperties::DnDTreeItemData::displayName ( ) const
inline

Definition at line 129 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 200 of file qgsattributesformproperties.h.

◆ htmlElementEditorConfiguration()

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

Returns the HTML editor configuration.

See also
setHtmlElementEditorConfiguration()

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

◆ name()

QString QgsAttributesFormProperties::DnDTreeItemData::name ( ) const
inline

Definition at line 126 of file qgsattributesformproperties.h.

◆ operator QVariant()

QgsAttributesFormProperties::DnDTreeItemData::operator QVariant ( )
inline

Definition at line 135 of file qgsattributesformproperties.h.

◆ qmlElementEditorConfiguration()

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

Returns the QML editor configuration.

See also
setQmlElementEditorConfiguration()

Definition at line 1912 of file qgsattributesformproperties.cpp.

◆ relationEditorConfiguration()

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

Returns the relation editor configuration.

See also
setRelationEditorConfiguration()

Definition at line 1902 of file qgsattributesformproperties.cpp.

◆ setBackgroundColor()

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

Definition at line 1948 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 173 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 1897 of file qgsattributesformproperties.cpp.

◆ setColumnCount()

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

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

◆ setDisplayName()

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

Definition at line 130 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 210 of file qgsattributesformproperties.h.

◆ setHtmlElementEditorConfiguration()

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

Sets the HTML editor configuration.

See also
htmlElementEditorConfiguration()

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

◆ setName()

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

Definition at line 127 of file qgsattributesformproperties.h.

◆ setQmlElementEditorConfiguration()

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

Sets the QML editor configuration.

See also
qmlElementEditorConfiguration()

Definition at line 1917 of file qgsattributesformproperties.cpp.

◆ setRelationEditorConfiguration()

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

Sets the relation editor configuration.

See also
relationEditorConfiguration()

Definition at line 1907 of file qgsattributesformproperties.cpp.

◆ setShowLabel()

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

Definition at line 1877 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 1938 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 1958 of file qgsattributesformproperties.cpp.

◆ setType()

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

Definition at line 133 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 230 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 1887 of file qgsattributesformproperties.cpp.

◆ showLabel()

bool QgsAttributesFormProperties::DnDTreeItemData::showLabel ( ) const

Definition at line 1872 of file qgsattributesformproperties.cpp.

◆ spacerElementEditorConfiguration()

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

Returns the spacer element configuration.

Since
QGIS 3.30

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

◆ type()

Type QgsAttributesFormProperties::DnDTreeItemData::type ( ) const
inline

Definition at line 132 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 220 of file qgsattributesformproperties.h.

◆ visibilityExpression()

QgsOptionalExpression QgsAttributesFormProperties::DnDTreeItemData::visibilityExpression ( ) const

Definition at line 1882 of file qgsattributesformproperties.cpp.

The documentation for this class was generated from the following files:
Generated on Thu Dec 26 2024 02:19:01 for QGIS API Documentation by doxygen 1.9.8