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: Qgis.AttributeEditorType, name: str, parent:
QgsAttributeEditorElement
= None) Constructor- Parameters:
type – The type of the new element.
name –
parent –
QgsAttributeEditorElement(
QgsAttributeEditorElement
)Enums
Bases:
enum.IntEnum
Methods
Returns a clone of this element.
Constructs the editor element from the given element
Returns the horizontal stretch factor for the element.
Returns the label style.
Returns the name of this element
Gets the parent of this element.
Sets the horizontal
stretch
factor for the element.Sets the
labelStyle
.Controls if this element should be labeled with a title (field, relation or groupname).
Sets the vertical
stretch
factor for the element.Controls if this element should be labeled with a title (field, relation or groupname).
Gets the XML Dom element to save this element.
The type of this element
Returns the vertical stretch factor for the element.
- class AttributeEditorType(value)¶
Bases:
enum.IntEnum
Attribute editor types.
Note
Prior to QGIS 3.32 this was available as
QgsAttributeEditorElement
.AttributeEditorType.New in version 3.32.
AeTypeContainer
: A containerAeTypeField
: A fieldAeTypeRelation
: A relationAeTypeQmlElement
: A QML elementAeTypeHtmlElement
: A HTML elementAeTypeAction
: A layer action element (since QGIS 3.22)AeTypeTextElement
: A text element (since QGIS 3.30)AeTypeSpacerElement
: A spacer element (since QGIS 3.30)AeTypeInvalid
: Invalid
- 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.
- Parameters:
parent (QgsAttributeEditorElement) –
- Return type:
- 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:
element (QDomElement) –
layerId (str) –
fields (QgsFields) –
context (QgsReadWriteContext) –
parent (
QgsAttributeEditorElement
= None) –
- Return type:
- horizontalStretch(self) int ¶
Returns the horizontal stretch factor for the element.
See also
See also
New in version 3.32.
- Return type:
int
- labelStyle(self) QgsAttributeEditorElement.LabelStyle ¶
Returns the label style.
See also
New in version 3.26.
- Return type:
- 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.
- Return type:
- setHorizontalStretch(self, stretch: int)¶
Sets the horizontal
stretch
factor for the element.See also
See also
New in version 3.32.
- Parameters:
stretch (int) –
- setLabelStyle(self, labelStyle: QgsAttributeEditorElement.LabelStyle)¶
Sets the
labelStyle
.See also
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).
- Parameters:
showLabel (bool) –
- setVerticalStretch(self, stretch: int)¶
Sets the vertical
stretch
factor for the element.See also
See also
New in version 3.32.
- Parameters:
stretch (int) –
- showLabel(self) bool ¶
Controls if this element should be labeled with a title (field, relation or groupname).
- 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) Qgis.AttributeEditorType ¶
The type of this element
- Return type:
- Returns:
The type
- verticalStretch(self) int ¶
Returns the vertical stretch factor for the element.
See also
See also
New in version 3.32.
- Return type:
int