QGIS API Documentation 3.30.0-'s-Hertogenbosch (f186b8efe0)
Public Member Functions | List of all members
QgsAttributeEditorHtmlElement Class Reference

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

#include <qgsattributeeditorhtmlelement.h>

Inheritance diagram for QgsAttributeEditorHtmlElement:
Inheritance graph
[legend]

Public Member Functions

 QgsAttributeEditorHtmlElement (const QString &name, QgsAttributeEditorElement *parent)
 Creates a new element which can display HTML. More...
 
QgsAttributeEditorElementclone (QgsAttributeEditorElement *parent) const override
 Returns a clone of this element. More...
 
QString htmlCode () const
 The Html code that will be represented within this widget. More...
 
void setHtmlCode (const QString &htmlCode)
 Sets the HTML code that will be represented within this widget to htmlCode. More...
 
- Public Member Functions inherited from QgsAttributeEditorElement
 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...
 
LabelStyle labelStyle () const
 Returns the label style. More...
 
QString name () const
 Returns the name of this element. More...
 
QgsAttributeEditorElementparent () const
 Gets the parent of this element. More...
 
void setLabelStyle (const LabelStyle &labelStyle)
 Sets the labelStyle. 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 , AeTypeHtmlElement , AeTypeAction , AeTypeTextElement ,
  AeTypeSpacerElement
}
 
- Static Public Member Functions inherited from QgsAttributeEditorElement
static QgsAttributeEditorElementcreate (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 inherited from QgsAttributeEditorElement
LabelStyle mLabelStyle
 
QString mName
 
QgsAttributeEditorElementmParent = nullptr
 
bool mShowLabel
 
AttributeEditorType mType
 

Detailed Description

An attribute editor widget that will represent arbitrary HTML code.

Since
QGIS 3.4

Definition at line 30 of file qgsattributeeditorhtmlelement.h.

Constructor & Destructor Documentation

◆ QgsAttributeEditorHtmlElement()

QgsAttributeEditorHtmlElement::QgsAttributeEditorHtmlElement ( const QString &  name,
QgsAttributeEditorElement parent 
)
inline

Creates a new element which can display HTML.

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

Definition at line 40 of file qgsattributeeditorhtmlelement.h.

Member Function Documentation

◆ clone()

QgsAttributeEditorElement * QgsAttributeEditorHtmlElement::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 19 of file qgsattributeeditorhtmlelement.cpp.

◆ htmlCode()

QString QgsAttributeEditorHtmlElement::htmlCode ( ) const

The Html code that will be represented within this widget.

Since
QGIS 3.4

Definition at line 27 of file qgsattributeeditorhtmlelement.cpp.

◆ setHtmlCode()

void QgsAttributeEditorHtmlElement::setHtmlCode ( const QString &  htmlCode)

Sets the HTML code that will be represented within this widget to htmlCode.

Definition at line 32 of file qgsattributeeditorhtmlelement.cpp.


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