An attribute editor widget that will represent arbitrary text code. More...
#include <qgsattributeeditortextelement.h>
Inheritance diagram for QgsAttributeEditorTextElement:
Public Member Functions | |
| QgsAttributeEditorTextElement (const QString &name, QgsAttributeEditorElement *parent) | |
| Creates a new element which can display text. More... | |
| QgsAttributeEditorElement * | clone (QgsAttributeEditorElement *parent) const override |
| Returns a clone of this element. More... | |
| void | setText (const QString &text) |
| Sets the text that will be represented within this widget to text. More... | |
| QString | text () const |
| The Text that will be represented within this widget. More... | |
 Public Member Functions inherited from QgsAttributeEditorElement | |
| QgsAttributeEditorElement (Qgis::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... | |
| int | horizontalStretch () const |
| Returns the horizontal stretch factor for the element. More... | |
| LabelStyle | labelStyle () const |
| Returns the label style. More... | |
| QString | name () const |
| Returns the name of this element. More... | |
| QgsAttributeEditorElement * | parent () const |
| Gets the parent of this element. More... | |
| void | setHorizontalStretch (int stretch) |
| Sets the horizontal stretch factor for the 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... | |
| void | setVerticalStretch (int stretch) |
| Sets the vertical stretch factor for the element. 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... | |
| Qgis::AttributeEditorType | type () const |
| The type of this element. More... | |
| int | verticalStretch () const |
| Returns the vertical stretch factor for the element. More... | |
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. More... | |
| 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 |
Detailed Description
An attribute editor widget that will represent arbitrary text code.
- Since
- QGIS 3.30
Definition at line 30 of file qgsattributeeditortextelement.h.
Constructor & Destructor Documentation
◆ QgsAttributeEditorTextElement()
|
inline |
Creates a new element which can display text.
- Parameters
-
name The name of the widget parent The parent (used as container)
Definition at line 40 of file qgsattributeeditortextelement.h.
Member Function Documentation
◆ clone()
|
overridevirtual |
Returns a clone of this element.
To be implemented by subclasses.
Implements QgsAttributeEditorElement.
Definition at line 19 of file qgsattributeeditortextelement.cpp.
◆ setText()
| void QgsAttributeEditorTextElement::setText | ( | const QString & | text | ) |
Sets the text that will be represented within this widget to text.
Definition at line 32 of file qgsattributeeditortextelement.cpp.
◆ text()
| QString QgsAttributeEditorTextElement::text | ( | ) | const |
The Text that will be represented within this widget.
Definition at line 27 of file qgsattributeeditortextelement.cpp.
The documentation for this class was generated from the following files:
- /build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/core/editform/qgsattributeeditortextelement.h
- /build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/core/editform/qgsattributeeditortextelement.cpp
