QGIS API Documentation
3.22.4-Białowieża (ce8e65e95e)
|
This is an abstract base class for any elements of a drag and drop form. More...
#include <qgsattributeeditorelement.h>
Public Types | |
enum | AttributeEditorType { AeTypeContainer , AeTypeField , AeTypeRelation , AeTypeInvalid , AeTypeQmlElement , AeTypeHtmlElement , AeTypeAction } |
Public Member Functions | |
QgsAttributeEditorElement (AttributeEditorType type, const QString &name, QgsAttributeEditorElement *parent=nullptr) | |
Constructor. More... | |
virtual | ~QgsAttributeEditorElement ()=default |
virtual QgsAttributeEditorElement * | clone (QgsAttributeEditorElement *parent) const =0 |
Returns a clone of this element. More... | |
QString | name () const |
Returns the name of this element. More... | |
QgsAttributeEditorElement * | parent () const |
Gets the parent of this element. More... | |
void | setShowLabel (bool showLabel) |
Controls if this element should be labeled with a title (field, relation or groupname). More... | |
bool | showLabel () const |
Controls if this element should be labeled with a title (field, relation or groupname). More... | |
QDomElement | toDomElement (QDomDocument &doc) const |
Gets the XML Dom element to save this element. More... | |
AttributeEditorType | type () const |
The type of this element. More... | |
Static Public Member Functions | |
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. More... | |
Protected Attributes | |
QString | mName |
QgsAttributeEditorElement * | mParent = nullptr |
bool | mShowLabel |
AttributeEditorType | mType |
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.
Definition at line 36 of file qgsattributeeditorelement.h.
Definition at line 62 of file qgsattributeeditorelement.h.
|
inline |
Constructor.
type | The type of the new element. |
name | |
parent |
Definition at line 80 of file qgsattributeeditorelement.h.
|
virtualdefault |
|
pure virtual |
Returns a clone of this element.
To be implemented by subclasses.
Implemented in QgsAttributeEditorRelation, QgsAttributeEditorQmlElement, QgsAttributeEditorHtmlElement, QgsAttributeEditorField, QgsAttributeEditorContainer, and QgsAttributeEditorAction.
|
static |
Constructs the editor element from the given element.
Definition at line 47 of file qgsattributeeditorelement.cpp.
|
inline |
Returns the name of this element.
Definition at line 101 of file qgsattributeeditorelement.h.
|
inline |
Gets the parent of this element.
Definition at line 115 of file qgsattributeeditorelement.h.
void QgsAttributeEditorElement::setShowLabel | ( | bool | showLabel | ) |
Controls if this element should be labeled with a title (field, relation or groupname).
Definition at line 42 of file qgsattributeeditorelement.cpp.
bool QgsAttributeEditorElement::showLabel | ( | ) | const |
Controls if this element should be labeled with a title (field, relation or groupname).
Definition at line 37 of file qgsattributeeditorelement.cpp.
QDomElement QgsAttributeEditorElement::toDomElement | ( | QDomDocument & | doc | ) | const |
Gets the XML Dom element to save this element.
doc | The QDomDocument which is used to create new XML elements |
Definition at line 28 of file qgsattributeeditorelement.cpp.
|
inline |
The type of this element.
Definition at line 108 of file qgsattributeeditorelement.h.
|
protected |
Definition at line 149 of file qgsattributeeditorelement.h.
|
protected |
Definition at line 150 of file qgsattributeeditorelement.h.
|
protected |
Definition at line 151 of file qgsattributeeditorelement.h.
|
protected |
Definition at line 148 of file qgsattributeeditorelement.h.