An attribute editor widget that will represent arbitrary text code. More...

#include <qgsattributeeditortextelement.h>

Inheritance diagram for QgsAttributeEditorTextElement:

Public Member Functions
	QgsAttributeEditorTextElement (const QString &name, QgsAttributeEditorElement *parent)
	Creates a new element which can display text.

QgsAttributeEditorElement *	clone (QgsAttributeEditorElement *parent) const override
	Returns a clone of this element.

void	setText (const QString &text)
	Sets the text that will be represented within this widget to text.

QString	text () const
	The Text that will be represented within this widget.

Public Member Functions inherited from QgsAttributeEditorElement
	QgsAttributeEditorElement (Qgis::AttributeEditorType type, const QString &name, QgsAttributeEditorElement *parent=nullptr)
	Constructor.

virtual	~QgsAttributeEditorElement ()=default

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

LabelStyle	labelStyle () const
	Returns the label style.

QString	name () const
	Returns the name of this element.

QgsAttributeEditorElement *	parent () const
	Gets the parent of this element.

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

void	setLabelStyle (const LabelStyle &labelStyle)
	Sets the labelStyle.

void	setShowLabel (bool showLabel)
	Controls if this element should be labeled with a title (field, relation or groupname).

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

bool	showLabel () const
	Controls if this element should be labeled with a title (field, relation or groupname).

QDomElement	toDomElement (QDomDocument &doc) const
	Gets the XML Dom element to save this element.

Qgis::AttributeEditorType	type () const
	The type of this element.

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

Additional Inherited Members
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.

Protected Attributes inherited from QgsAttributeEditorElement
int	mHorizontalStretch = 0

LabelStyle	mLabelStyle

QString	mName

QgsAttributeEditorElement *	mParent = nullptr

bool	mShowLabel = true

Qgis::AttributeEditorType	mType = Qgis::AttributeEditorType::Invalid

int	mVerticalStretch = 0

Detailed Description

An attribute editor widget that will represent arbitrary text code.

Since: QGIS 3.30

Definition at line 30 of file qgsattributeeditortextelement.h.

Constructor & Destructor Documentation

◆ QgsAttributeEditorTextElement()

QgsAttributeEditorTextElement::QgsAttributeEditorTextElement	(	const QString &	name,
		QgsAttributeEditorElement *	parent
	)

inline

Creates a new element which can display text.

Parameters

name	The name of the widget
parent	The parent (used as container)

Definition at line 40 of file qgsattributeeditortextelement.h.

Member Function Documentation

◆ clone()

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

overridevirtual

Returns a clone of this element.

To be implemented by subclasses.

Implements QgsAttributeEditorElement.

Definition at line 19 of file qgsattributeeditortextelement.cpp.

◆ setText()

void QgsAttributeEditorTextElement::setText ( const QString & text )

Sets the text that will be represented within this widget to text.

Definition at line 32 of file qgsattributeeditortextelement.cpp.

◆ text()

QString QgsAttributeEditorTextElement::text ( ) const

The Text that will be represented within this widget.

Definition at line 27 of file qgsattributeeditortextelement.cpp.

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

/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/core/editform/qgsattributeeditortextelement.h
/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/core/editform/qgsattributeeditortextelement.cpp

Public Member Functions