QGIS API Documentation
2.10.1-Pisa
|
Layer tree group node serves as a container for layers and further groups. More...
#include <qgslayertreegroup.h>
Public Member Functions | |
QgsLayerTreeGroup (const QString &name=QString(), Qt::CheckState checked=Qt::Checked) | |
QgsLayerTreeGroup (const QgsLayerTreeGroup &other) | |
void | addChildNode (QgsLayerTreeNode *node) |
Append an existing node. The node must not have a parent yet. The node will be owned by this group. More... | |
QgsLayerTreeGroup * | addGroup (const QString &name) |
Append a new group node with given name. Newly created node is owned by this group. More... | |
QgsLayerTreeLayer * | addLayer (QgsMapLayer *layer) |
Append a new layer node for given map layer. Newly created node is owned by this group. More... | |
virtual QgsLayerTreeNode * | clone () const override |
Return a clone of the group. The children are cloned too. More... | |
virtual QString | dump () const override |
Return text representation of the tree. For debugging purposes only. More... | |
QgsLayerTreeGroup * | findGroup (const QString &name) |
Find group node with specified name. Searches recursively the whole sub-tree. More... | |
QgsLayerTreeLayer * | findLayer (const QString &layerId) const |
Find layer node representing the map layer specified by its ID. Searches recursively the whole sub-tree. More... | |
QStringList | findLayerIds () const |
Find layer IDs used in all layer nodes. Searches recursively the whole sub-tree. More... | |
QList< QgsLayerTreeLayer * > | findLayers () const |
Find all layer nodes. Searches recursively the whole sub-tree. More... | |
void | insertChildNode (int index, QgsLayerTreeNode *node) |
Insert existing node at specified position. The node must not have a parent yet. The node will be owned by this group. More... | |
void | insertChildNodes (int index, QList< QgsLayerTreeNode * > nodes) |
Insert existing nodes at specified position. The nodes must not have a parent yet. The nodes will be owned by this group. More... | |
QgsLayerTreeGroup * | insertGroup (int index, const QString &name) |
Insert a new group node with given name at specified position. Newly created node is owned by this group. More... | |
QgsLayerTreeLayer * | insertLayer (int index, QgsMapLayer *layer) |
Insert a new layer node for given map layer at specified position. Newly created node is owned by this group. More... | |
Qt::CheckState | isVisible () const |
Return the check state of the group node. More... | |
QString | name () const |
Get group's name. More... | |
void | readChildrenFromXML (QDomElement &element) |
Read children from XML and append them to the group. More... | |
void | removeAllChildren () |
Remove all child nodes. The nodes will be deleted. More... | |
void | removeChildNode (QgsLayerTreeNode *node) |
Remove a child node from this group. The node will be deleted. More... | |
void | removeChildren (int from, int count) |
Remove child nodes from index "from". The nodes will be deleted. More... | |
void | removeChildrenGroupWithoutLayers () |
Remove all child group nodes without layers. The groupnodes will be deleted. More... | |
void | removeLayer (QgsMapLayer *layer) |
Remove map layer's node from this group. The node will be deleted. More... | |
void | setName (const QString &n) |
Set group's name. More... | |
void | setVisible (Qt::CheckState state) |
Set check state of the group node - will also update children. More... | |
virtual void | writeXML (QDomElement &parentElement) override |
Write group (tree) as XML element <layer-tree-group> and add it to the given parent element. More... | |
Public Member Functions inherited from QgsLayerTreeNode | |
~QgsLayerTreeNode () | |
QList< QgsLayerTreeNode * > | children () |
Get list of children of the node. Children are owned by the parent. More... | |
QStringList | customProperties () const |
Return list of keys stored in custom properties. More... | |
QVariant | customProperty (const QString &key, const QVariant &defaultValue=QVariant()) const |
Read a custom property from layer. More... | |
bool | isExpanded () const |
Return whether the node should be shown as expanded or collapsed in GUI. More... | |
NodeType | nodeType () |
Find out about type of the node. It is usually shorter to use convenience functions from QgsLayerTree namespace for that. More... | |
QgsLayerTreeNode * | parent () |
Get pointer to the parent. If parent is a null pointer, the node is a root node. More... | |
void | removeCustomProperty (const QString &key) |
Remove a custom property from layer. More... | |
void | setCustomProperty (const QString &key, const QVariant &value) |
Set a custom property for the node. More... | |
void | setExpanded (bool expanded) |
Set whether the node should be shown as expanded or collapsed in GUI. More... | |
bool | takeChild (QgsLayerTreeNode *node) |
Remove a child from a node. 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 ®Exp) 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 |
Static Public Member Functions | |
static QgsLayerTreeGroup * | readXML (QDomElement &element) |
Read group (tree) from XML element <layer-tree-group> and return the newly created group (or null on error) More... | |
Static Public Member Functions inherited from QgsLayerTreeNode | |
static QgsLayerTreeNode * | readXML (QDomElement &element) |
Read layer tree from XML. Returns new instance. More... | |
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 Slots | |
void | layerDestroyed () |
void | nodeVisibilityChanged (QgsLayerTreeNode *node) |
Protected Member Functions | |
void | updateVisibilityFromChildren () |
Protected Member Functions inherited from QgsLayerTreeNode | |
QgsLayerTreeNode (NodeType t) | |
QgsLayerTreeNode (const QgsLayerTreeNode &other) | |
void | insertChildrenPrivate (int index, QList< QgsLayerTreeNode * > nodes) |
Low-level insertion of children to the node. The children must not have any parent yet! More... | |
void | readCommonXML (QDomElement &element) |
void | removeChildrenPrivate (int from, int count, bool destroy=true) |
Low-level removal of children from the node. More... | |
void | writeCommonXML (QDomElement &element) |
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) |
Protected Attributes | |
bool | mChangingChildVisibility |
Qt::CheckState | mChecked |
QString | mName |
Protected Attributes inherited from QgsLayerTreeNode | |
QList< QgsLayerTreeNode * > | mChildren |
list of children - node is responsible for their deletion More... | |
bool | mExpanded |
whether the node should be shown in GUI as expanded More... | |
NodeType | mNodeType |
type of the node - determines which subclass is used More... | |
QgsLayerTreeNode * | mParent |
pointer to the parent node - null in case of root node More... | |
QgsObjectCustomProperties | mProperties |
custom properties attached to the node More... | |
Additional Inherited Members | |
Public Types inherited from QgsLayerTreeNode | |
enum | NodeType { NodeGroup, NodeLayer } |
Enumeration of possible tree node types. More... | |
Signals inherited from QgsLayerTreeNode | |
void | addedChildren (QgsLayerTreeNode *node, int indexFrom, int indexTo) |
Emitted when one or more nodes have been added to a node within the tree. More... | |
void | customPropertyChanged (QgsLayerTreeNode *node, QString key) |
Emitted when a custom property of a node within the tree has been changed or removed. More... | |
void | expandedChanged (QgsLayerTreeNode *node, bool expanded) |
Emitted when the collapsed/expanded state of a node within the tree has been changed. More... | |
void | removedChildren (QgsLayerTreeNode *node, int indexFrom, int indexTo) |
Emitted when one or more nodes has been removed from a node within the tree. More... | |
void | visibilityChanged (QgsLayerTreeNode *node, Qt::CheckState state) |
Emitted when check state of a node within the tree has been changed. More... | |
void | willAddChildren (QgsLayerTreeNode *node, int indexFrom, int indexTo) |
Emitted when one or more nodes will be added to a node within the tree. More... | |
void | willRemoveChildren (QgsLayerTreeNode *node, int indexFrom, int indexTo) |
Emitted when one or more nodes will be removed from a node within the tree. More... | |
Static Protected Member Functions inherited from QObject | |
QByteArray | normalizeSignalSlot (const char *signalSlot) |
Properties inherited from QObject | |
objectName | |
Layer tree group node serves as a container for layers and further groups.
Group names do not need to be unique within one tree nor within one parent.
Definition at line 31 of file qgslayertreegroup.h.
QgsLayerTreeGroup::QgsLayerTreeGroup | ( | const QString & | name = QString() , |
Qt::CheckState | checked = Qt::Checked |
||
) |
Definition at line 27 of file qgslayertreegroup.cpp.
QgsLayerTreeGroup::QgsLayerTreeGroup | ( | const QgsLayerTreeGroup & | other | ) |
Definition at line 36 of file qgslayertreegroup.cpp.
void QgsLayerTreeGroup::addChildNode | ( | QgsLayerTreeNode * | node | ) |
Append an existing node. The node must not have a parent yet. The node will be owned by this group.
Definition at line 95 of file qgslayertreegroup.cpp.
QgsLayerTreeGroup * QgsLayerTreeGroup::addGroup | ( | const QString & | name | ) |
Append a new group node with given name. Newly created node is owned by this group.
Definition at line 53 of file qgslayertreegroup.cpp.
QgsLayerTreeLayer * QgsLayerTreeGroup::addLayer | ( | QgsMapLayer * | layer | ) |
Append a new layer node for given map layer. Newly created node is owned by this group.
Definition at line 70 of file qgslayertreegroup.cpp.
|
overridevirtual |
Return a clone of the group. The children are cloned too.
Implements QgsLayerTreeNode.
Definition at line 266 of file qgslayertreegroup.cpp.
|
overridevirtual |
Return text representation of the tree. For debugging purposes only.
Implements QgsLayerTreeNode.
Definition at line 255 of file qgslayertreegroup.cpp.
QgsLayerTreeGroup * QgsLayerTreeGroup::findGroup | ( | const QString & | name | ) |
Find group node with specified name. Searches recursively the whole sub-tree.
Definition at line 184 of file qgslayertreegroup.cpp.
QgsLayerTreeLayer * QgsLayerTreeGroup::findLayer | ( | const QString & | layerId | ) | const |
Find layer node representing the map layer specified by its ID. Searches recursively the whole sub-tree.
Definition at line 151 of file qgslayertreegroup.cpp.
QStringList QgsLayerTreeGroup::findLayerIds | ( | ) | const |
Find layer IDs used in all layer nodes. Searches recursively the whole sub-tree.
Definition at line 296 of file qgslayertreegroup.cpp.
QList< QgsLayerTreeLayer * > QgsLayerTreeGroup::findLayers | ( | ) | const |
Find all layer nodes. Searches recursively the whole sub-tree.
Definition at line 171 of file qgslayertreegroup.cpp.
void QgsLayerTreeGroup::insertChildNode | ( | int | index, |
QgsLayerTreeNode * | node | ||
) |
Insert existing node at specified position. The node must not have a parent yet. The node will be owned by this group.
Definition at line 80 of file qgslayertreegroup.cpp.
void QgsLayerTreeGroup::insertChildNodes | ( | int | index, |
QList< QgsLayerTreeNode * > | nodes | ||
) |
Insert existing nodes at specified position. The nodes must not have a parent yet. The nodes will be owned by this group.
Definition at line 87 of file qgslayertreegroup.cpp.
QgsLayerTreeGroup * QgsLayerTreeGroup::insertGroup | ( | int | index, |
const QString & | name | ||
) |
Insert a new group node with given name at specified position. Newly created node is owned by this group.
Definition at line 46 of file qgslayertreegroup.cpp.
QgsLayerTreeLayer * QgsLayerTreeGroup::insertLayer | ( | int | index, |
QgsMapLayer * | layer | ||
) |
Insert a new layer node for given map layer at specified position. Newly created node is owned by this group.
Definition at line 60 of file qgslayertreegroup.cpp.
|
inline |
Return the check state of the group node.
Definition at line 93 of file qgslayertreegroup.h.
|
protectedslot |
Definition at line 310 of file qgslayertreegroup.cpp.
|
inline |
Get group's name.
Definition at line 39 of file qgslayertreegroup.h.
|
protectedslot |
Definition at line 316 of file qgslayertreegroup.cpp.
void QgsLayerTreeGroup::readChildrenFromXML | ( | QDomElement & | element | ) |
Read children from XML and append them to the group.
Definition at line 239 of file qgslayertreegroup.cpp.
|
static |
Read group (tree) from XML element <layer-tree-group> and return the newly created group (or null on error)
Definition at line 204 of file qgslayertreegroup.cpp.
void QgsLayerTreeGroup::removeAllChildren | ( | ) |
Remove all child nodes. The nodes will be deleted.
Definition at line 146 of file qgslayertreegroup.cpp.
void QgsLayerTreeGroup::removeChildNode | ( | QgsLayerTreeNode * | node | ) |
Remove a child node from this group. The node will be deleted.
Definition at line 100 of file qgslayertreegroup.cpp.
void QgsLayerTreeGroup::removeChildren | ( | int | from, |
int | count | ||
) |
Remove child nodes from index "from". The nodes will be deleted.
Definition at line 123 of file qgslayertreegroup.cpp.
void QgsLayerTreeGroup::removeChildrenGroupWithoutLayers | ( | ) |
Remove all child group nodes without layers. The groupnodes will be deleted.
Definition at line 130 of file qgslayertreegroup.cpp.
void QgsLayerTreeGroup::removeLayer | ( | QgsMapLayer * | layer | ) |
Remove map layer's node from this group. The node will be deleted.
Definition at line 107 of file qgslayertreegroup.cpp.
|
inline |
Set group's name.
Definition at line 41 of file qgslayertreegroup.h.
void QgsLayerTreeGroup::setVisible | ( | Qt::CheckState | state | ) |
Set check state of the group node - will also update children.
Definition at line 271 of file qgslayertreegroup.cpp.
|
protected |
Definition at line 322 of file qgslayertreegroup.cpp.
|
overridevirtual |
Write group (tree) as XML element <layer-tree-group> and add it to the given parent element.
Implements QgsLayerTreeNode.
Definition at line 223 of file qgslayertreegroup.cpp.
|
protected |
Definition at line 108 of file qgslayertreegroup.h.
|
protected |
Definition at line 106 of file qgslayertreegroup.h.
|
protected |
Definition at line 105 of file qgslayertreegroup.h.