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:

[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)

QObject *	child (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< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	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 QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () 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)

QThread *	thread () 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

QObject *	sender () 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::QgsAttributeEditorContainer	(	const QString &	name,
		QObject *	parent
	)

inline

Creates a new attribute editor container.

Parameters

name	The name to show as title
parent	The parent. May be another container.

Definition at line 141 of file qgseditformconfig.h.

◆ ~QgsAttributeEditorContainer()

virtual QgsAttributeEditorContainer::~QgsAttributeEditorContainer ( )

inlinevirtual

Destructor.

Definition at line 148 of file qgseditformconfig.h.

Member Function Documentation

◆ addChildElement()

void QgsAttributeEditorContainer::addChildElement ( QgsAttributeEditorElement * element )

virtual

Add a child element to this container.

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

Parameters

element The element to add as child

Definition at line 540 of file qgseditformconfig.cpp.

◆ children()

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.

◆ columnCount()

int QgsAttributeEditorContainer::columnCount ( ) const

Get the number of columns in this group.

Definition at line 501 of file qgseditformconfig.cpp.

◆ findElements()

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

virtual

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

Parameters

type	The type which should be searched

Returns: A list of elements of the type which has been searched for

Definition at line 550 of file qgseditformconfig.cpp.

◆ isGroupBox()

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.

◆ setColumnCount()

void QgsAttributeEditorContainer::setColumnCount ( int columnCount )

Set the number of columns in this group.

Definition at line 506 of file qgseditformconfig.cpp.

◆ setIsGroupBox()

virtual void QgsAttributeEditorContainer::setIsGroupBox ( bool isGroupBox )

inlinevirtual

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

Parameters

isGroupBox If true, this will be a group box

Definition at line 162 of file qgseditformconfig.h.

◆ setName()

void QgsAttributeEditorContainer::setName ( const QString & name )

Change the name of this container.

Definition at line 545 of file qgseditformconfig.cpp.

◆ setVisibilityExpression()

void QgsAttributeEditorContainer::setVisibilityExpression ( const QgsOptionalExpression & visibilityExpression )

An expression that controls the visibility of this container.

Note: Added in QGIS 2.18

Definition at line 530 of file qgseditformconfig.cpp.

◆ visibilityExpression()

QgsOptionalExpression QgsAttributeEditorContainer::visibilityExpression ( ) const

An expression that controls the visibility of this container.

Note: Added in QGIS 2.18

Definition at line 525 of file qgseditformconfig.cpp.

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

/tmp/buildd/qgis-2.18.21+99unstable/src/core/qgseditformconfig.h
/tmp/buildd/qgis-2.18.21+99unstable/src/core/qgseditformconfig.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsAttributeEditorContainer()

◆ ~QgsAttributeEditorContainer()

Member Function Documentation

◆ addChildElement()

◆ children()

◆ columnCount()

◆ findElements()

◆ isGroupBox()

◆ setColumnCount()

◆ setIsGroupBox()

◆ setName()

◆ setVisibilityExpression()

◆ visibilityExpression()