QGIS API Documentation  3.4.15-Madeira (e83d02e274)
Public Member Functions | List of all members
QgsAttributeEditorQmlElement Class Reference

An attribute editor widget that will represent arbitrary QML code. More...

#include <qgsattributeeditorelement.h>

Inheritance diagram for QgsAttributeEditorQmlElement:
Inheritance graph
[legend]

Public Member Functions

 QgsAttributeEditorQmlElement (const QString &name, QgsAttributeEditorElement *parent)
 Creates a new element which can display QML. More...
 
QgsAttributeEditorElement * clone (QgsAttributeEditorElement *parent) const override
 Returns a clone of this element. More...
 
QString qmlCode () const
 The QML code that will be represented within this widget. More...
 
void setQmlCode (const QString &qmlCode)
 The QML code that will be represented within this widget. More...
 
- Public Member Functions inherited from QgsAttributeEditorElement
 QgsAttributeEditorElement (AttributeEditorType type, const QString &name, QgsAttributeEditorElement *parent=nullptr)
 Constructor. More...
 
virtual ~QgsAttributeEditorElement ()=default
 
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...
 

Additional Inherited Members

- Public Types inherited from QgsAttributeEditorElement
enum  AttributeEditorType {
  AeTypeContainer, AeTypeField, AeTypeRelation, AeTypeInvalid,
  AeTypeQmlElement
}
 
- Protected Attributes inherited from QgsAttributeEditorElement
QString mName
 
QgsAttributeEditorElement * mParent = nullptr
 
bool mShowLabel
 
AttributeEditorType mType
 

Detailed Description

An attribute editor widget that will represent arbitrary QML code.

Since
QGIS 3.4

Definition at line 421 of file qgsattributeeditorelement.h.

Constructor & Destructor Documentation

QgsAttributeEditorQmlElement::QgsAttributeEditorQmlElement ( const QString &  name,
QgsAttributeEditorElement *  parent 
)
inline

Creates a new element which can display QML.

Parameters
nameThe name of the widget
parentThe parent (used as container)

Definition at line 431 of file qgsattributeeditorelement.h.

Member Function Documentation

QgsAttributeEditorElement * QgsAttributeEditorQmlElement::clone ( QgsAttributeEditorElement *  parent) const
overridevirtual

Returns a clone of this element.

To be implemented by subclasses.

Since
QGIS 3.0

Implements QgsAttributeEditorElement.

Definition at line 154 of file qgsattributeeditorelement.cpp.

QString QgsAttributeEditorQmlElement::qmlCode ( ) const

The QML code that will be represented within this widget.

Since
QGIS 3.4

Definition at line 162 of file qgsattributeeditorelement.cpp.

void QgsAttributeEditorQmlElement::setQmlCode ( const QString &  qmlCode)

The QML code that will be represented within this widget.

Parameters
qmlCode

Definition at line 167 of file qgsattributeeditorelement.cpp.


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