Skip to content

Commit

Permalink
[layertree] QgsLayerTreeGroup doxymentation
Browse files Browse the repository at this point in the history
  • Loading branch information
wonder-sk committed Jun 17, 2014
1 parent b134c25 commit 378de25
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 8 deletions.
31 changes: 27 additions & 4 deletions python/core/layertree/qgslayertreegroup.sip
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
/**
* 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.
*
* @note added in 2.4
*/
class QgsLayerTreeGroup : QgsLayerTreeNode
Expand All @@ -12,40 +14,61 @@ class QgsLayerTreeGroup : QgsLayerTreeNode
public:
QgsLayerTreeGroup( const QString& name = QString(), Qt::CheckState checked = Qt::Checked );

//! Get group's name
QString name() const;
//! Set group's name
void setName( const QString& n );

//! Insert a new group node with given name at specified position. Newly created node is owned by this group.
QgsLayerTreeGroup* insertGroup( int index, const QString& name );
//! Append a new group node with given name. Newly created node is owned by this group.
QgsLayerTreeGroup* addGroup( const QString& name );
//! Insert a new layer node for given map layer at specified position. Newly created node is owned by this group.
QgsLayerTreeLayer* insertLayer( int index, QgsMapLayer* layer );
//! Append a new layer node for given map layer. Newly created node is owned by this group.
QgsLayerTreeLayer* addLayer( QgsMapLayer* layer );

//! Insert existing nodes at specified position. The nodes must not have a parent yet. The nodes will be owned by this group.
void insertChildNodes( int index, QList<QgsLayerTreeNode*> nodes /Transfer/ );
//! Insert existing node at specified position. The node must not have a parent yet. The node will be owned by this group.
void insertChildNode( int index, QgsLayerTreeNode* node /Transfer/ );
//! Append an existing node. The node must not have a parent yet. The node will be owned by this group.
void addChildNode( QgsLayerTreeNode* node /Transfer/ );

//! Remove a child node from this group. The node will be deleted.
void removeChildNode( QgsLayerTreeNode* node );

//! Remove map layer's node from this group. The node will be deleted.
void removeLayer( QgsMapLayer* layer );

//! Remove child nodes from index "from". The nodes will be deleted.
void removeChildren( int from, int count );

//! Remove all child nodes. The nodes will be deleted.
void removeAllChildren();

//! Find layer node representing the map layer specified by its ID. Searches recursively the whole sub-tree.
QgsLayerTreeLayer* findLayer( const QString& layerId );
//! Find all layer nodes. Searches recursively the whole sub-tree.
QList<QgsLayerTreeLayer*> findLayers() const;
//! Find layer IDs used in all layer nodes. Searches recursively the whole sub-tree.
QStringList findLayerIds() const;
//! Find group node with specified name. Searches recursively the whole sub-tree.
QgsLayerTreeGroup* findGroup( const QString& name );

//! Read group (tree) from XML element <layer-tree-group> and return the newly created group (or null on error)
static QgsLayerTreeGroup* readXML( QDomElement& element ) /Factory/;
//! Write group (tree) as XML element <layer-tree-group> and add it to the given parent element
virtual void writeXML( QDomElement& parentElement );

//! Read children from XML and append them to the group.
void readChildrenFromXML( QDomElement& element );

//! Return text representation of the tree. For debugging purposes only.
virtual QString dump() const;

//! Return a clone of the group. The children are cloned too.
virtual QgsLayerTreeNode* clone() const /Factory/;

//! Return the check state of the group node
Qt::CheckState isVisible() const;
//! Set check state of the group node - will also update children
void setVisible( Qt::CheckState state );

private:
Expand Down
7 changes: 7 additions & 0 deletions src/core/layertree/qgslayertreegroup.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,13 @@ QgsLayerTreeGroup::QgsLayerTreeGroup( const QgsLayerTreeGroup& other )
}


QgsLayerTreeGroup* QgsLayerTreeGroup::insertGroup( int index, const QString& name )
{
QgsLayerTreeGroup* grp = new QgsLayerTreeGroup( name );
insertChildNode( index, grp );
return grp;
}

QgsLayerTreeGroup* QgsLayerTreeGroup::addGroup( const QString &name )
{
QgsLayerTreeGroup* grp = new QgsLayerTreeGroup( name );
Expand Down
31 changes: 27 additions & 4 deletions src/core/layertree/qgslayertreegroup.h
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ class QgsLayerTreeLayer;
/**
* 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.
*
* @note added in 2.4
*/
class CORE_EXPORT QgsLayerTreeGroup : public QgsLayerTreeNode
Expand All @@ -33,40 +35,61 @@ class CORE_EXPORT QgsLayerTreeGroup : public QgsLayerTreeNode
QgsLayerTreeGroup( const QString& name = QString(), Qt::CheckState checked = Qt::Checked );
QgsLayerTreeGroup( const QgsLayerTreeGroup& other );

//! Get group's name
QString name() const { return mName; }
//! Set group's name
void setName( const QString& n ) { mName = n; }

//! Insert a new group node with given name at specified position. Newly created node is owned by this group.
QgsLayerTreeGroup* insertGroup( int index, const QString& name );
//! Append a new group node with given name. Newly created node is owned by this group.
QgsLayerTreeGroup* addGroup( const QString& name );
//! Insert a new layer node for given map layer at specified position. Newly created node is owned by this group.
QgsLayerTreeLayer* insertLayer( int index, QgsMapLayer* layer );
//! Append a new layer node for given map layer. Newly created node is owned by this group.
QgsLayerTreeLayer* addLayer( QgsMapLayer* layer );

//! Insert existing nodes at specified position. The nodes must not have a parent yet. The nodes will be owned by this group.
void insertChildNodes( int index, QList<QgsLayerTreeNode*> nodes );
//! Insert existing node at specified position. The node must not have a parent yet. The node will be owned by this group.
void insertChildNode( int index, QgsLayerTreeNode* node );
//! Append an existing node. The node must not have a parent yet. The node will be owned by this group.
void addChildNode( QgsLayerTreeNode* node );

//! Remove a child node from this group. The node will be deleted.
void removeChildNode( QgsLayerTreeNode* node );

//! Remove map layer's node from this group. The node will be deleted.
void removeLayer( QgsMapLayer* layer );

//! Remove child nodes from index "from". The nodes will be deleted.
void removeChildren( int from, int count );

//! Remove all child nodes. The nodes will be deleted.
void removeAllChildren();

//! Find layer node representing the map layer specified by its ID. Searches recursively the whole sub-tree.
QgsLayerTreeLayer* findLayer( const QString& layerId );
//! Find all layer nodes. Searches recursively the whole sub-tree.
QList<QgsLayerTreeLayer*> findLayers() const;
//! Find layer IDs used in all layer nodes. Searches recursively the whole sub-tree.
QStringList findLayerIds() const;
//! Find group node with specified name. Searches recursively the whole sub-tree.
QgsLayerTreeGroup* findGroup( const QString& name );

//! Read group (tree) from XML element <layer-tree-group> and return the newly created group (or null on error)
static QgsLayerTreeGroup* readXML( QDomElement& element );
//! Write group (tree) as XML element <layer-tree-group> and add it to the given parent element
virtual void writeXML( QDomElement& parentElement );

//! Read children from XML and append them to the group.
void readChildrenFromXML( QDomElement& element );

//! Return text representation of the tree. For debugging purposes only.
virtual QString dump() const;

//! Return a clone of the group. The children are cloned too.
virtual QgsLayerTreeNode* clone() const;

//! Return the check state of the group node
Qt::CheckState isVisible() const { return mChecked; }
//! Set check state of the group node - will also update children
void setVisible( Qt::CheckState state );

protected slots:
Expand Down

0 comments on commit 378de25

Please sign in to comment.