Class: QgsAttributeEditorElement

class qgis.core.QgsAttributeEditorElement

Bases: sip.wrapper

This is an abstract base class for any elements of a drag and drop form.

This can either be a container which will be represented on the screen as a tab widget or a collapsible group box. Or it can be a field which will then be represented based on the QgsEditorWidget type and configuration. Or it can be a relation and embed the form of several children of another layer.

QgsAttributeEditorElement(type: QgsAttributeEditorElement.AttributeEditorType, name: str, parent: QgsAttributeEditorElement = None) Constructor

Parameters:
  • type – The type of the new element.

  • name

  • parent

QgsAttributeEditorElement(QgsAttributeEditorElement)

Methods

clone

Returns a clone of this element.

create

Constructs the editor element from the given element

labelStyle

Returns the label style.

name

Returns the name of this element

parent

Gets the parent of this element.

setLabelStyle

Sets the labelStyle.

setShowLabel

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

showLabel

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

toDomElement

Gets the XML Dom element to save this element.

type

The type of this element

Attributes

AeTypeAction

AeTypeContainer

AeTypeField

AeTypeHtmlElement

AeTypeInvalid

AeTypeQmlElement

AeTypeRelation

AeTypeAction = 6
AeTypeContainer = 0
AeTypeField = 1
AeTypeHtmlElement = 5
AeTypeInvalid = 3
AeTypeQmlElement = 4
AeTypeRelation = 2
class AttributeEditorType

Bases: int

class LabelStyle
class LabelStyle(QgsAttributeEditorElement.LabelStyle)

Bases: sip.wrapper

color
font
overrideColor
overrideFont
clone(self, parent: QgsAttributeEditorElement) QgsAttributeEditorElement

Returns a clone of this element. To be implemented by subclasses.

New in version 3.0.

Parameters:

parent (QgsAttributeEditorElement) –

Return type:

QgsAttributeEditorElement

create(element: QDomElement, layerId: str, fields: QgsFields, context: QgsReadWriteContext, parent: QgsAttributeEditorElement = None) QgsAttributeEditorElement

Constructs the editor element from the given element

New in version 3.18.

Parameters:
Return type:

QgsAttributeEditorElement

labelStyle(self) QgsAttributeEditorElement.LabelStyle

Returns the label style.

See also

setLabelStyle()

New in version 3.26.

Return type:

QgsAttributeEditorElement.LabelStyle

name(self) str

Returns the name of this element

Return type:

str

Returns:

The name for this element

parent(self) QgsAttributeEditorElement

Gets the parent of this element.

New in version 3.0.

Return type:

QgsAttributeEditorElement

setLabelStyle(self, labelStyle: QgsAttributeEditorElement.LabelStyle)

Sets the labelStyle.

See also

labelStyle()

New in version 3.26.

Parameters:

labelStyle (QgsAttributeEditorElement.LabelStyle) –

setShowLabel(self, showLabel: bool)

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

New in version 2.18.

Parameters:

showLabel (bool) –

showLabel(self) bool

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

New in version 2.18.

Return type:

bool

toDomElement(self, doc: QDomDocument) QDomElement

Gets the XML Dom element to save this element.

Parameters:

doc (QDomDocument) – The QDomDocument which is used to create new XML elements

Return type:

QDomElement

Returns:

A DOM element to serialize this element

type(self) QgsAttributeEditorElement.AttributeEditorType

The type of this element

Return type:

QgsAttributeEditorElement.AttributeEditorType

Returns:

The type