qgslayertreenode.h

Go to the documentation of this file.

/***************************************************************************
  qgslayertreenode.h
  --------------------------------------
  Date                 : May 2014
  Copyright            : (C) 2014 by Martin Dobias
  Email                : wonder dot sk at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSLAYERTREENODE_H
#define QGSLAYERTREENODE_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsobjectcustomproperties.h"
#include "qgsreadwritecontext.h"
 
#include <QObject>
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QDomElement;
 
class QgsProject;
class QgsMapLayer;

class CORE_EXPORT QgsLayerTreeNode : public QObject
{
    Q_OBJECT
 
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( sipCpp->inherits( "QgsLayerTreeNode" ) )
    {
      sipType = sipType_QgsLayerTreeNode;
      QgsLayerTreeNode *node = qobject_cast<QgsLayerTreeNode *>( sipCpp );
      if ( QgsLayerTree::isLayer( node ) )
        sipType = sipType_QgsLayerTreeLayer;
      else if ( qobject_cast<QgsLayerTree *>( sipCpp ) )
        sipType = sipType_QgsLayerTree;
      else if ( QgsLayerTree::isGroup( node ) )
        sipType = sipType_QgsLayerTreeGroup;
      else if ( QgsLayerTree::isCustomNode( node ) )
        sipType = sipType_QgsLayerTreeCustomNode;
    }
    else
      sipType = 0;
  SIP_END
#endif
 
  public:

    enum NodeType
    {
      NodeGroup, 
      NodeLayer, 
      NodeCustom 
    };
 
    ~QgsLayerTreeNode() override;
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsLayerTreeNode: %1>"_s.arg( sipCpp->name() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End

    int __len__() const;
    % MethodCode
    sipRes = sipCpp->children().count();
    % End

    SIP_PYOBJECT __getitem__( int index ) SIP_TYPEHINT( QgsLayerTreeNode );
    % MethodCode
    const QList< QgsLayerTreeNode * > children = sipCpp->children();
    const int count = children.count();
    if ( a0 < 0 || a0 >= count )
    {
      PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
      sipIsErr = 1;
    }
    else
    {
      QgsLayerTreeNode *child = children.at( a0 );
      sipRes = sipConvertFromType( child, sipType_QgsLayerTreeNode, NULL );
    }
    % End
// clang-format on
#endif

        NodeType nodeType() const
    {
      return mNodeType;
    }

    QgsLayerTreeNode *parent() { return mParent; }
    QList<QgsLayerTreeNode *> children() { return mChildren; }
    QList<QgsLayerTreeNode *> children() const SIP_SKIP { return mChildren; }

    QList<QgsLayerTreeNode *> abandonChildren() SIP_SKIP;

    virtual QString name() const = 0;

    virtual void setName( const QString &name ) = 0;

    static QgsLayerTreeNode *readXml( QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;

    static QgsLayerTreeNode *readXml( QDomElement &element, const QgsProject *project ) SIP_FACTORY;

    virtual void writeXml( QDomElement &parentElement, const QgsReadWriteContext &context ) = 0;

    virtual QString dump() const = 0;

    virtual QgsLayerTreeNode *clone() const = 0 SIP_FACTORY;

    virtual void resolveReferences( const QgsProject *project, bool looseMatching = false ) = 0;

    bool isVisible() const;

    bool itemVisibilityChecked() const { return mChecked; }

    void setItemVisibilityChecked( bool checked );

    virtual void setItemVisibilityCheckedRecursive( bool checked );

    void setItemVisibilityCheckedParentRecursive( bool checked );

    bool isItemVisibilityCheckedRecursive() const;

    bool isItemVisibilityUncheckedRecursive() const;

    QList< QgsMapLayer * > checkedLayers() const;

    int depth() const;

    bool isExpanded() const;
    void setExpanded( bool expanded );

    void setCustomProperty( const QString &key, const QVariant &value );
    QVariant customProperty( const QString &key, const QVariant &defaultValue = QVariant() ) const;
    void removeCustomProperty( const QString &key );
    QStringList customProperties() const;
    bool takeChild( QgsLayerTreeNode *node );
 
  signals:

    void willAddChildren( QgsLayerTreeNode *node, int indexFrom, int indexTo );
    void addedChildren( QgsLayerTreeNode *node, int indexFrom, int indexTo );
    void willRemoveChildren( QgsLayerTreeNode *node, int indexFrom, int indexTo );
    void removedChildren( QgsLayerTreeNode *node, int indexFrom, int indexTo );
    void visibilityChanged( QgsLayerTreeNode *node );
    void customPropertyChanged( QgsLayerTreeNode *node, const QString &key );
    void expandedChanged( QgsLayerTreeNode *node, bool expanded );

    void nameChanged( QgsLayerTreeNode *node, QString name );
 
  protected:
    QgsLayerTreeNode( NodeType t, bool checked = true );
    QgsLayerTreeNode( const QgsLayerTreeNode &other );
 
    // low-level utility functions

    void readCommonXml( const QDomElement &element );
    void writeCommonXml( QDomElement &element );

    void insertChildrenPrivate( int index, const QList<QgsLayerTreeNode *> &nodes );
    void removeChildrenPrivate( int from, int count, bool destroy = true );
 
  protected:
    NodeType mNodeType;
    bool mChecked;
    QgsLayerTreeNode *mParent = nullptr;
    QList<QgsLayerTreeNode *> mChildren;
    bool mExpanded = true;
    QgsObjectCustomProperties mProperties;

    virtual void makeOrphan() SIP_SKIP;
 
  private:
    QgsLayerTreeNode &operator=( const QgsLayerTreeNode & ) = delete;
};
 
 
#endif // QGSLAYERTREENODE_H