qgslayertree.h

Go to the documentation of this file.

/***************************************************************************
  qgslayertree.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 QGSLAYERTREE_H
#define QGSLAYERTREE_H
 
#include "qgslayertreecustomnode.h"
#include "qgslayertreegroup.h"
#include "qgslayertreelayer.h"
#include "qgslayertreenode.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;

class CORE_EXPORT QgsLayerTree : public QgsLayerTreeGroup
{
    Q_OBJECT
 
  public:
    static inline bool isGroup( QgsLayerTreeNode *node ) { return node && node->nodeType() == QgsLayerTreeNode::NodeGroup; }

    static inline bool isLayer( const QgsLayerTreeNode *node ) { return node && node->nodeType() == QgsLayerTreeNode::NodeLayer; }

    static inline bool isCustomNode( const QgsLayerTreeNode *node ) { return node && node->nodeType() == QgsLayerTreeNode::NodeCustom; }

    static inline QgsLayerTreeGroup *toGroup( QgsLayerTreeNode *node ) SIP_SKIP { return qobject_cast<QgsLayerTreeGroup *>( node ); }

    static inline QgsLayerTreeLayer *toLayer( QgsLayerTreeNode *node ) SIP_SKIP { return qobject_cast<QgsLayerTreeLayer *>( node ); }

    static inline const QgsLayerTreeLayer *toLayer( const QgsLayerTreeNode *node ) SIP_SKIP { return qobject_cast< const QgsLayerTreeLayer *>( node ); }

    static inline QgsLayerTreeCustomNode *toCustomNode( QgsLayerTreeNode *node ) SIP_SKIP { return qobject_cast<QgsLayerTreeCustomNode *>( node ); }

    QgsLayerTree();
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    // override parent QgsLayerTreeGroup __repr__ and resort back to default repr for QgsLayerTree -- there's no extra useful context we can show
    QString str = u"<qgis._core.QgsLayerTree object at 0x%1>"_s.arg( reinterpret_cast<quintptr>( sipCpp ), 2 * QT_POINTER_SIZE, 16, '0'_L1 );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif

        QList<QgsMapLayer *> customLayerOrder() const;

    void setCustomLayerOrder( const QList<QgsMapLayer *> &customLayerOrder );

    void setCustomLayerOrder( const QStringList &customLayerOrder ) SIP_PYNAME( setCustomLayerOrderByIds );

    QList<QgsMapLayer *> layerOrder() const;

    bool hasCustomLayerOrder() const;

    void setHasCustomLayerOrder( bool hasCustomLayerOrder );

    QList<QgsLayerTreeNode *> layerAndCustomNodeOrder() const;

    static std::unique_ptr< QgsLayerTree > readXml( const QDomElement &element, const QgsReadWriteContext &context ); // cppcheck-suppress duplInheritedMember

    void readLayerOrderFromXml( const QDomElement &doc );
 
    void writeXml( QDomElement &parentElement, const QgsReadWriteContext &context ) override;
 
    QgsLayerTree *clone() const override SIP_FACTORY;

    void clear();
 
  signals:

    void customLayerOrderChanged();

    void layerOrderChanged();

    void hasCustomLayerOrderChanged( bool hasCustomLayerOrder );
 
  private slots:
    void nodeAddedChildren( QgsLayerTreeNode *node, int indexFrom, int indexTo );
    void nodeRemovedChildren();
 
  private:
    QgsLayerTree( const QgsLayerTree &other );
 
    void init();
 
    void addMissingLayers();
    QgsWeakMapLayerPointerList mCustomLayerOrder;
    bool mHasCustomLayerOrder = false;
 
    QgsLayerTree &operator=( const QgsLayerTree & ) = delete;
};
 
#endif // QGSLAYERTREE_H