QGIS API Documentation  2.17.0-Master (f49f7ce)
Public Member Functions | List of all members
QgsAttributeEditorContainer Class Reference

This is a container for attribute editors, used to group them visually in the attribute form if it is set to the drag and drop designer. More...

#include <qgseditformconfig.h>

Inheritance diagram for QgsAttributeEditorContainer:
Inheritance graph
[legend]

Public Member Functions

 QgsAttributeEditorContainer (const QString &name, QObject *parent)
 Creates a new attribute editor container. More...
 
virtual ~QgsAttributeEditorContainer ()
 Destructor. More...
 
virtual void addChildElement (QgsAttributeEditorElement *element)
 Add a child element to this container. More...
 
QList< QgsAttributeEditorElement * > children () const
 Get a list of the children elements of this container. More...
 
int columnCount () const
 Get the number of columns in this group. More...
 
virtual QList< QgsAttributeEditorElement * > findElements (AttributeEditorType type) const
 Traverses the element tree to find any element of the specified type. More...
 
virtual bool isGroupBox () const
 Returns if this container is going to be rendered as a group box. More...
 
void setColumnCount (int columnCount)
 Set the number of columns in this group. More...
 
virtual void setIsGroupBox (bool isGroupBox)
 Determines if this container is rendered as collapsible group box or tab in a tabwidget. More...
 
void setName (const QString &name)
 Change the name of this container. More...
 
void setVisibilityExpression (const QgsOptionalExpression &visibilityExpression)
 An expression that controls the visibility of this container. More...
 
QgsOptionalExpression visibilityExpression () const
 An expression that controls the visibility of this container. More...
 
- Public Member Functions inherited from QgsAttributeEditorElement
 QgsAttributeEditorElement (AttributeEditorType type, const QString &name, QObject *parent=nullptr)
 Constructor. More...
 
virtual ~QgsAttributeEditorElement ()
 Destructor. More...
 
QString name () const
 Return the name 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...
 
- 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
 

Additional Inherited Members

- Public Types inherited from QgsAttributeEditorElement
enum  AttributeEditorType { AeTypeContainer, AeTypeField, AeTypeRelation, AeTypeInvalid }
 
- 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)
 
- Protected Attributes inherited from QgsAttributeEditorElement
QString mName
 
bool mShowLabel
 
AttributeEditorType mType
 
- Properties inherited from QObject
 objectName
 

Detailed Description

This is a container for attribute editors, used to group them visually in the attribute form if it is set to the drag and drop designer.

Definition at line 130 of file qgseditformconfig.h.

Constructor & Destructor Documentation

QgsAttributeEditorContainer::QgsAttributeEditorContainer ( const QString name,
QObject parent 
)
inline

Creates a new attribute editor container.

Parameters
nameThe name to show as title
parentThe parent. May be another container.

Definition at line 141 of file qgseditformconfig.h.

virtual QgsAttributeEditorContainer::~QgsAttributeEditorContainer ( )
inlinevirtual

Destructor.

Definition at line 148 of file qgseditformconfig.h.

Member Function Documentation

void QgsAttributeEditorContainer::addChildElement ( QgsAttributeEditorElement element)
virtual

Add a child element to this container.

This may be another container, a field or a relation.

Parameters
elementThe element to add as child

Definition at line 538 of file qgseditformconfig.cpp.

QList<QgsAttributeEditorElement*> QgsAttributeEditorContainer::children ( ) const
inline

Get a list of the children elements of this container.

Returns
A list of elements

Definition at line 176 of file qgseditformconfig.h.

int QgsAttributeEditorContainer::columnCount ( ) const

Get the number of columns in this group.

Definition at line 499 of file qgseditformconfig.cpp.

QList< QgsAttributeEditorElement * > QgsAttributeEditorContainer::findElements ( QgsAttributeEditorElement::AttributeEditorType  type) const
virtual

Traverses the element tree to find any element of the specified type.

Parameters
typeThe type which should be searched
Returns
A list of elements of the type which has been searched for

Definition at line 548 of file qgseditformconfig.cpp.

virtual bool QgsAttributeEditorContainer::isGroupBox ( ) const
inlinevirtual

Returns if this container is going to be rendered as a group box.

Returns
True if it will be a group box, false if it will be a tab

Definition at line 169 of file qgseditformconfig.h.

void QgsAttributeEditorContainer::setColumnCount ( int  columnCount)

Set the number of columns in this group.

Definition at line 504 of file qgseditformconfig.cpp.

virtual void QgsAttributeEditorContainer::setIsGroupBox ( bool  isGroupBox)
inlinevirtual

Determines if this container is rendered as collapsible group box or tab in a tabwidget.

Parameters
isGroupBoxIf true, this will be a group box

Definition at line 162 of file qgseditformconfig.h.

void QgsAttributeEditorContainer::setName ( const QString name)

Change the name of this container.

Definition at line 543 of file qgseditformconfig.cpp.

void QgsAttributeEditorContainer::setVisibilityExpression ( const QgsOptionalExpression visibilityExpression)

An expression that controls the visibility of this container.

Note
Added in QGIS 2.18

Definition at line 528 of file qgseditformconfig.cpp.

QgsOptionalExpression QgsAttributeEditorContainer::visibilityExpression ( ) const

An expression that controls the visibility of this container.

Note
Added in QGIS 2.18

Definition at line 523 of file qgseditformconfig.cpp.


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