qgslayertreecustomnode.h

Go to the documentation of this file.

/***************************************************************************
                       qgslayertreecustomnode.h
                       ------------------------
    begin                : July 2025
    copyright            : (C) 2025 by Germán Carrillo
    email                : german at opengis dot ch
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 QGSLAYERTREECUSTOMNODE_H
#define QGSLAYERTREECUSTOMNODE_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgslayertreenode.h"
 
#include <QObject>
#include <QString>
 
using namespace Qt::StringLiterals;

class CORE_EXPORT QgsLayerTreeCustomNode : public QgsLayerTreeNode
{
    Q_OBJECT
  public:
    explicit QgsLayerTreeCustomNode( const QString &nodeId, const QString &nodeName = QString(), bool checked = true );
 
#ifndef SIP_RUN
    QgsLayerTreeCustomNode( const QgsLayerTreeCustomNode &other );
#endif
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsLayerTreeCustomNode: %1>"_s.arg( sipCpp->name() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
        QString id() const override
    {
      return mId;
    }

    Q_DECL_DEPRECATED QString nodeId() const SIP_DEPRECATED { return mId; }

    QString name() const override;

    void setName( const QString &name ) override;

    static QgsLayerTreeCustomNode *readXml( const QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY; // cppcheck-suppress duplInheritedMember

    void writeXml( QDomElement &parentElement, const QgsReadWriteContext &context ) override;
 
    QString dump() const override;
 
    QgsLayerTreeCustomNode *clone() const override SIP_FACTORY;
 
    void resolveReferences( const QgsProject *project, bool looseMatching = false ) override;
 
  private:
#ifdef SIP_RUN

    QgsLayerTreeCustomNode( const QgsLayerTreeCustomNode &other );
#endif
 
    QgsLayerTreeCustomNode &operator=( const QgsLayerTreeCustomNode & ) = delete;
 
    QString mId;
    QString mName;
};
 
#endif // QGSLAYERTREECUSTOMNODE_H