qgshistoryentrynode.h

Go to the documentation of this file.

/***************************************************************************
                            qgshistoryentrynode.h
                            --------------------------
    begin                : April 2023
    copyright            : (C) 2023 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 QGSHISTORYENTRYNODE_H
#define QGSHISTORYENTRYNODE_H
 
#include <deque>
#include <memory>
 
#include "qgis.h"
#include "qgis_gui.h"
#include "qgis_sip.h"
 
#include <QString>
#include <QVariantMap>
 
class QWidget;
class QAction;
class QMenu;
class QgsHistoryEntryGroup;
class QgsHistoryWidgetContext;

class GUI_EXPORT QgsHistoryEntryNode
{
  public:
    QgsHistoryEntryNode() = default;
    virtual ~QgsHistoryEntryNode();
 
    QgsHistoryEntryNode( const QgsHistoryEntryNode &other ) = delete;
    QgsHistoryEntryNode &operator=( const QgsHistoryEntryNode &other ) = delete;

    QgsHistoryEntryGroup *parent() { return mParent; }

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

    virtual int childCount() const;

    virtual QString html( const QgsHistoryWidgetContext &context ) const;

    virtual QWidget *createWidget( const QgsHistoryWidgetContext &context ) SIP_FACTORY;

    virtual bool doubleClicked( const QgsHistoryWidgetContext &context );

    virtual void populateContextMenu( QMenu *menu, const QgsHistoryWidgetContext &context );

    virtual bool matchesString( const QString &searchString ) const;
 
  private:
#ifdef SIP_RUN
    QgsHistoryEntryNode( const QgsHistoryEntryNode &other );
#endif
 
    QgsHistoryEntryGroup *mParent = nullptr;
 
    friend class QgsHistoryEntryGroup;
};
 

class GUI_EXPORT QgsHistoryEntryGroup : public QgsHistoryEntryNode
{
  public:
    QgsHistoryEntryGroup() = default;
    ~QgsHistoryEntryGroup() override;
 
    QgsHistoryEntryGroup( const QgsHistoryEntryGroup &other ) = delete;
    QgsHistoryEntryGroup &operator=( const QgsHistoryEntryGroup &other ) = delete;

    void addChild( QgsHistoryEntryNode *child SIP_TRANSFER );

    void insertChild( int index, QgsHistoryEntryNode *child SIP_TRANSFER );

    int indexOf( QgsHistoryEntryNode *child ) const;

    QgsHistoryEntryNode *childAt( int index );

    void removeChildAt( int index );

    void clear();
 
    int childCount() const final;
 
  protected:
    std::deque<std::unique_ptr<QgsHistoryEntryNode>> mChildren SIP_SKIP;
 
  private:
#ifdef SIP_RUN
    QgsHistoryEntryGroup( const QgsHistoryEntryGroup &other );
#endif
};
 
#endif // QGSHISTORYENTRYNODE_H