This element will load a layer action onto the form. More...

#include <qgsattributeeditoraction.h>

Inheritance diagram for QgsAttributeEditorAction:

Public Member Functions
	QgsAttributeEditorAction (const QgsAction &action, QgsAttributeEditorElement *parent)
	Creates a new element which can display a layer action.

	QgsAttributeEditorAction (const QUuid &uuid, QgsAttributeEditorElement *parent)
	Creates a new element which can display a layer action, this constructor allows to create a QgsAttributeEditorAction when actions are not yet loaded.

const QgsAction &	action (const QgsVectorLayer *layer) const
	Returns the (possibly lazy loaded) action for the given layer.

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

void	setAction (const QgsAction &newAction)
	Set the action to newAction.

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

This element will load a layer action onto the form.

Since: QGIS 3.22

Definition at line 28 of file qgsattributeeditoraction.h.

Constructor & Destructor Documentation

◆ QgsAttributeEditorAction() [1/2]

QgsAttributeEditorAction::QgsAttributeEditorAction	(	const QgsAction &	action,
		QgsAttributeEditorElement *	parent
	)

Creates a new element which can display a layer action.

Parameters

action	The action
parent	The parent (used as container)

Definition at line 20 of file qgsattributeeditoraction.cpp.

◆ QgsAttributeEditorAction() [2/2]

QgsAttributeEditorAction::QgsAttributeEditorAction	(	const QUuid &	uuid,
		QgsAttributeEditorElement *	parent
	)

Creates a new element which can display a layer action, this constructor allows to create a QgsAttributeEditorAction when actions are not yet loaded.

Parameters

uuid	The action unique identifier (UUID).
parent	The parent (used as container).

Definition at line 26 of file qgsattributeeditoraction.cpp.

Member Function Documentation

◆ action()

const QgsAction & QgsAttributeEditorAction::action ( const QgsVectorLayer * layer ) const

Returns the (possibly lazy loaded) action for the given layer.

Definition at line 39 of file qgsattributeeditoraction.cpp.

◆ clone()

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

overridevirtual

Returns a clone of this element.

To be implemented by subclasses.

Implements QgsAttributeEditorElement.

Definition at line 32 of file qgsattributeeditoraction.cpp.

◆ setAction()

void QgsAttributeEditorAction::setAction ( const QgsAction & newAction )

Set the action to newAction.

Definition at line 49 of file qgsattributeeditoraction.cpp.

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

/build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/core/editform/qgsattributeeditoraction.h
/build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/core/editform/qgsattributeeditoraction.cpp

Public Member Functions

Additional Inherited Members