QGIS API Documentation  2.99.0-Master (0cba29c)
Public Member Functions | List of all members
QgsAttributeEditorField Class Reference

This element will load a field's widget onto the form. More...

#include <qgsattributeeditorelement.h>

Inheritance diagram for QgsAttributeEditorField:
Inheritance graph
[legend]

Public Member Functions

 QgsAttributeEditorField (const QString &name, int idx, QgsAttributeEditorElement *parent)
 Creates a new attribute editor element which represents a field. More...
 
virtual QgsAttributeEditorElementclone (QgsAttributeEditorElement *parent) const override
 Returns a clone of this element. More...
 
int idx () const
 Return the index of the field. More...
 
- Public Member Functions inherited from QgsAttributeEditorElement
 QgsAttributeEditorElement (AttributeEditorType type, const QString &name, QgsAttributeEditorElement *parent=nullptr)
 Constructor. More...
 
virtual ~QgsAttributeEditorElement ()=default
 
QString name () const
 Return the name of this element. More...
 
QgsAttributeEditorElementparent () const
 Get 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
 Get 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 }
 
- Protected Attributes inherited from QgsAttributeEditorElement
QString mName
 
QgsAttributeEditorElementmParent = nullptr
 
bool mShowLabel
 
AttributeEditorType mType
 

Detailed Description

This element will load a field's widget onto the form.

Definition at line 278 of file qgsattributeeditorelement.h.

Constructor & Destructor Documentation

◆ QgsAttributeEditorField()

QgsAttributeEditorField::QgsAttributeEditorField ( const QString &  name,
int  idx,
QgsAttributeEditorElement parent 
)
inline

Creates a new attribute editor element which represents a field.

Parameters
nameThe name of the element
idxThe index of the field which should be embedded
parentThe parent of this widget (used as container)

Definition at line 289 of file qgsattributeeditorelement.h.

Member Function Documentation

◆ clone()

QgsAttributeEditorElement * QgsAttributeEditorField::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 70 of file qgsattributeeditorelement.cpp.

◆ idx()

int QgsAttributeEditorField::idx ( ) const
inline

Return the index of the field.

Returns

Definition at line 298 of file qgsattributeeditorelement.h.


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