QGIS API Documentation 3.41.0-Master (3c143d501a8)
|
An attribute editor widget that will represent arbitrary HTML code. More...
#include <qgsattributeeditorhtmlelement.h>
Public Member Functions | |
QgsAttributeEditorHtmlElement (const QString &name, QgsAttributeEditorElement *parent) | |
Creates a new element which can display HTML. | |
QgsAttributeEditorElement * | clone (QgsAttributeEditorElement *parent) const override |
Returns a clone of this element. | |
QString | htmlCode () const |
The Html code that will be represented within this widget. | |
void | setHtmlCode (const QString &htmlCode) |
Sets the HTML code that will be represented within this widget to htmlCode. | |
Public Member Functions inherited from QgsAttributeEditorElement | |
QgsAttributeEditorElement (Qgis::AttributeEditorType type, const QString &name, QgsAttributeEditorElement *parent=nullptr) | |
Constructor. | |
virtual | ~QgsAttributeEditorElement ()=default |
int | horizontalStretch () const |
Returns the horizontal stretch factor for the element. | |
LabelStyle | labelStyle () const |
Returns the label style. | |
QString | name () const |
Returns the name of this element. | |
QgsAttributeEditorElement * | parent () const |
Gets the parent of this element. | |
void | setHorizontalStretch (int stretch) |
Sets the horizontal stretch factor for the element. | |
void | setLabelStyle (const LabelStyle &labelStyle) |
Sets the labelStyle. | |
void | setShowLabel (bool showLabel) |
Controls if this element should be labeled with a title (field, relation or groupname). | |
void | setVerticalStretch (int stretch) |
Sets the vertical stretch factor for the element. | |
bool | showLabel () const |
Controls if this element should be labeled with a title (field, relation or groupname). | |
QDomElement | toDomElement (QDomDocument &doc) const |
Gets the XML Dom element to save this element. | |
Qgis::AttributeEditorType | type () const |
The type of this element. | |
int | verticalStretch () const |
Returns the vertical stretch factor for the element. | |
Additional Inherited Members | |
Static Public Member Functions inherited from QgsAttributeEditorElement | |
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. | |
Protected Attributes inherited from QgsAttributeEditorElement | |
int | mHorizontalStretch = 0 |
LabelStyle | mLabelStyle |
QString | mName |
QgsAttributeEditorElement * | mParent = nullptr |
bool | mShowLabel = true |
Qgis::AttributeEditorType | mType = Qgis::AttributeEditorType::Invalid |
int | mVerticalStretch = 0 |
An attribute editor widget that will represent arbitrary HTML code.
Definition at line 30 of file qgsattributeeditorhtmlelement.h.
|
inline |
Creates a new element which can display HTML.
name | The name of the widget |
parent | The parent (used as container) |
Definition at line 40 of file qgsattributeeditorhtmlelement.h.
|
overridevirtual |
Returns a clone of this element.
To be implemented by subclasses.
Implements QgsAttributeEditorElement.
Definition at line 19 of file qgsattributeeditorhtmlelement.cpp.
QString QgsAttributeEditorHtmlElement::htmlCode | ( | ) | const |
The Html code that will be represented within this widget.
Definition at line 27 of file qgsattributeeditorhtmlelement.cpp.
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.