QGIS API Documentation  2.12.0-Lyon
Public Types | Public Member Functions | Protected Attributes | List of all members
QgsAttributeEditorElement Class Referenceabstract

This is an abstract base class for any elements of a drag and drop form. More...

#include <qgsvectorlayer.h>

Inheritance diagram for QgsAttributeEditorElement:
Inheritance graph
[legend]

Public Types

enum  AttributeEditorType { AeTypeContainer, AeTypeField, AeTypeRelation, AeTypeInvalid }
 

Public Member Functions

 QgsAttributeEditorElement (AttributeEditorType type, const QString &name, QObject *parent=NULL)
 Constructor. More...
 
virtual ~QgsAttributeEditorElement ()
 Destructor. More...
 
QString name () const
 Return the name of this element. More...
 
virtual QDomElement toDomElement (QDomDocument &doc) const =0
 Is reimplemented in classes inheriting from this to serialize it. More...
 
AttributeEditorType type () const
 The type of this element. More...
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual  ~QObject ()
 
bool blockSignals (bool block)
 
QObjectchild (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArraydynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObjectparent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThreadthread () const
 

Protected Attributes

QString mName
 
AttributeEditorType mType
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObjectsender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

This is an abstract base class for any elements of a drag and drop form.

This can either be a container which will be represented on the screen as a tab widget or ca collapsible group box. Or it can be a field which will then be represented based on the QgsEditorWidgetV2 type and configuration. Or it can be a relation and embed the form of several children of another layer.

Definition at line 82 of file qgsvectorlayer.h.

Member Enumeration Documentation

Enumerator
AeTypeContainer 

A container.

AeTypeField 

A field.

AeTypeRelation 

A relation.

AeTypeInvalid 

Invalid.

Definition at line 87 of file qgsvectorlayer.h.

Constructor & Destructor Documentation

QgsAttributeEditorElement::QgsAttributeEditorElement ( AttributeEditorType  type,
const QString name,
QObject parent = NULL 
)
inline

Constructor.

Parameters
typeThe type of the new element. Should never
name
parent

Definition at line 102 of file qgsvectorlayer.h.

virtual QgsAttributeEditorElement::~QgsAttributeEditorElement ( )
inlinevirtual

Destructor.

Definition at line 106 of file qgsvectorlayer.h.

Member Function Documentation

QString QgsAttributeEditorElement::name ( ) const
inline

Return the name of this element.

Returns
The name for this element

Definition at line 113 of file qgsvectorlayer.h.

virtual QDomElement QgsAttributeEditorElement::toDomElement ( QDomDocument doc) const
pure virtual

Is reimplemented in classes inheriting from this to serialize it.

Parameters
docThe QDomDocument which is used to create new XML elements
Returns
An DOM element which represents this element

Implemented in QgsAttributeEditorRelation, QgsAttributeEditorField, and QgsAttributeEditorContainer.

AttributeEditorType QgsAttributeEditorElement::type ( ) const
inline

The type of this element.

Returns
The type

Definition at line 120 of file qgsvectorlayer.h.

Member Data Documentation

QString QgsAttributeEditorElement::mName
protected

Definition at line 133 of file qgsvectorlayer.h.

AttributeEditorType QgsAttributeEditorElement::mType
protected

Definition at line 132 of file qgsvectorlayer.h.


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