qgsdevtoolsmodelnode.h

Go to the documentation of this file.

/***************************************************************************
    qgsdevtoolsmodelnode.h
    -------------------------
    begin                : March 2020
    copyright            : (C) 2020 by Nyall Dawson
    email                : nyall dot dawson 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 QGSDEVTOOLSMODELNODE_H
#define QGSDEVTOOLSMODELNODE_H
 
#define SIP_NO_FILE
 
#include <deque>
#include <memory>
 
#include "qgis_gui.h"
 
#include <QColor>
#include <QElapsedTimer>
#include <QUrl>
#include <QVariant>
 
class QAction;
class QgsDevToolsModelGroup;

class GUI_EXPORT QgsDevToolsModelNode
{
  public:
    virtual ~QgsDevToolsModelNode();

    QgsDevToolsModelGroup *parent() { return mParent; }

    virtual QVariant data( int role = Qt::DisplayRole ) const = 0;

    virtual int childCount() const = 0;

    virtual QList<QAction *> actions( QObject *parent );

    virtual QVariant toVariant() const;
 
  protected:
    QgsDevToolsModelNode();
 
  private:
    QgsDevToolsModelGroup *mParent = nullptr;
    friend class QgsDevToolsModelGroup;
};

class GUI_EXPORT QgsDevToolsModelGroup : public QgsDevToolsModelNode
{
  public:
    ~QgsDevToolsModelGroup() override;

    QgsDevToolsModelGroup( QgsDevToolsModelGroup &&other ) noexcept = default;

    QgsDevToolsModelGroup &operator=( QgsDevToolsModelGroup &&other ) noexcept = default;
 
  public:
    QgsDevToolsModelNode *addChild( std::unique_ptr<QgsDevToolsModelNode> child );

    int indexOf( QgsDevToolsModelNode *child ) const;

    QgsDevToolsModelNode *childAt( int index );

    void clear();
 
    int childCount() const final { return mChildren.size(); }
    QVariant data( int role = Qt::DisplayRole ) const override;
    QVariant toVariant() const override;
 
  protected:
    QgsDevToolsModelGroup( const QString &title );

    void addKeyValueNode( const QString &key, const QString &value, const QColor &color = QColor() );
 
  protected:
    std::deque<std::unique_ptr<QgsDevToolsModelNode>> mChildren;
 
  private:
    // Prevent copying
    QgsDevToolsModelGroup( const QgsDevToolsModelGroup & ) = delete;
    QgsDevToolsModelGroup &operator=( const QgsDevToolsModelGroup & ) = delete;
 
    QString mGroupTitle;
};

class GUI_EXPORT QgsDevToolsModelValueNode : public QgsDevToolsModelNode
{
  public:
    QgsDevToolsModelValueNode( const QString &key, const QString &value, const QColor &color = QColor() );

    QString key() const { return mKey; }

    QString value() const { return mValue; }
 
    QVariant data( int role = Qt::DisplayRole ) const final;
    int childCount() const final { return 0; }
    QList<QAction *> actions( QObject *parent ) final;
 
  private:
    QString mKey;
    QString mValue;
    QColor mColor;
};
 
#endif // QGSDEVTOOLSMODELNODE_H