QGIS API Documentation  3.3.0-Master (208571a)
Public Types | Public Member Functions | Protected Attributes | List of all members
QgsAttributeEditorElement Class Referenceabstract

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

#include <qgsattributeeditorelement.h>

Inheritance diagram for QgsAttributeEditorElement:
Inheritance graph
[legend]

Public Types

enum  AttributeEditorType {
  AeTypeContainer, AeTypeField, AeTypeRelation, AeTypeInvalid,
  AeTypeQmlElement
}
 

Public Member Functions

 QgsAttributeEditorElement (AttributeEditorType type, const QString &name, QgsAttributeEditorElement *parent=nullptr)
 Constructor. More...
 
virtual ~QgsAttributeEditorElement ()=default
 
virtual QgsAttributeEditorElementclone (QgsAttributeEditorElement *parent) const =0
 Returns a clone of this element. More...
 
QString name () const
 Returns the name of this element. More...
 
QgsAttributeEditorElementparent () 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...
 

Protected Attributes

QString mName
 
QgsAttributeEditorElementmParent = nullptr
 
bool mShowLabel
 
AttributeEditorType mType
 

Detailed Description

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 ca 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.

Member Enumeration Documentation

◆ AttributeEditorType

Enumerator
AeTypeContainer 

A container.

AeTypeField 

A field.

AeTypeRelation 

A relation.

AeTypeInvalid 

Invalid.

AeTypeQmlElement 

A QML element.

Definition at line 59 of file qgsattributeeditorelement.h.

Constructor & Destructor Documentation

◆ QgsAttributeEditorElement()

QgsAttributeEditorElement::QgsAttributeEditorElement ( AttributeEditorType  type,
const QString &  name,
QgsAttributeEditorElement parent = nullptr 
)
inline

Constructor.

Parameters
typeThe type of the new element. Should never
name
parent

Definition at line 75 of file qgsattributeeditorelement.h.

◆ ~QgsAttributeEditorElement()

virtual QgsAttributeEditorElement::~QgsAttributeEditorElement ( )
virtualdefault

Member Function Documentation

◆ clone()

virtual QgsAttributeEditorElement* QgsAttributeEditorElement::clone ( QgsAttributeEditorElement parent) const
pure virtual

Returns a clone of this element.

To be implemented by subclasses.

Since
QGIS 3.0

Implemented in QgsAttributeEditorQmlElement, QgsAttributeEditorRelation, QgsAttributeEditorField, and QgsAttributeEditorContainer.

◆ name()

QString QgsAttributeEditorElement::name ( ) const
inline

Returns the name of this element.

Returns
The name for this element

Definition at line 89 of file qgsattributeeditorelement.h.

◆ parent()

QgsAttributeEditorElement* QgsAttributeEditorElement::parent ( ) const
inline

Gets the parent of this element.

Since
QGIS 3.0

Definition at line 103 of file qgsattributeeditorelement.h.

◆ setShowLabel()

void QgsAttributeEditorElement::setShowLabel ( bool  showLabel)

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

Since
QGIS 2.18

Definition at line 117 of file qgsattributeeditorelement.cpp.

◆ showLabel()

bool QgsAttributeEditorElement::showLabel ( ) const

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

Since
QGIS 2.18

Definition at line 112 of file qgsattributeeditorelement.cpp.

◆ toDomElement()

QDomElement QgsAttributeEditorElement::toDomElement ( QDomDocument &  doc) const

Gets the XML Dom element to save this element.

Parameters
docThe QDomDocument which is used to create new XML elements
Returns
A DOM element to serialize this element

Definition at line 102 of file qgsattributeeditorelement.cpp.

◆ type()

AttributeEditorType QgsAttributeEditorElement::type ( ) const
inline

The type of this element.

Returns
The type

Definition at line 96 of file qgsattributeeditorelement.h.

Member Data Documentation

◆ mName

QString QgsAttributeEditorElement::mName
protected

Definition at line 138 of file qgsattributeeditorelement.h.

◆ mParent

QgsAttributeEditorElement* QgsAttributeEditorElement::mParent = nullptr
protected

Definition at line 139 of file qgsattributeeditorelement.h.

◆ mShowLabel

bool QgsAttributeEditorElement::mShowLabel
protected

Definition at line 140 of file qgsattributeeditorelement.h.

◆ mType

AttributeEditorType QgsAttributeEditorElement::mType
protected

Definition at line 137 of file qgsattributeeditorelement.h.


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