qgsadvanceddigitizingtoolsregistry.h

Go to the documentation of this file.

/***************************************************************************
    qgsadvanceddigitizingtoolsregistry.cpp
                             -------------------
    begin                : July 27 2024
    copyright            : (C) 2024 by Mathieu Pellerin
    email                : mathieu 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 QGSADVANCEDDIGITIZINGTOOLSREGSITRY_H
#define QGSADVANCEDDIGITIZINGTOOLSREGSITRY_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
 
#include <QIcon>
#include <QMap>
 
class QgsAdvancedDigitizingDockWidget;
class QgsAdvancedDigitizingTool;
class QgsMapCanvas;

class GUI_EXPORT QgsAdvancedDigitizingToolAbstractMetadata
{
  public:
    QgsAdvancedDigitizingToolAbstractMetadata( const QString &name, const QString &visibleName, const QIcon &icon = QIcon() )
      : mName( name )
      , mVisibleName( visibleName )
      , mIcon( icon )
    {}
 
    virtual ~QgsAdvancedDigitizingToolAbstractMetadata() = default;

    QString name() const { return mName; }

    QString visibleName() const { return mVisibleName; }

    QIcon icon() const { return mIcon; }

    virtual QgsAdvancedDigitizingTool *createTool( QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget ) SIP_FACTORY;
 
  protected:
    QString mName;
    QString mVisibleName;
    QIcon mIcon;
};
 
#ifndef SIP_RUN
 
typedef std::function<QgsAdvancedDigitizingTool *( QgsMapCanvas *, QgsAdvancedDigitizingDockWidget * )> QgsAdvancedDigitizingToolFunc SIP_SKIP;

class GUI_EXPORT QgsAdvancedDigitizingToolMetadata : public QgsAdvancedDigitizingToolAbstractMetadata
{
  public:
    QgsAdvancedDigitizingToolMetadata( const QString &name, const QString &visibleName, const QIcon &icon = QIcon(), const QgsAdvancedDigitizingToolFunc &toolFunction = nullptr )
      : QgsAdvancedDigitizingToolAbstractMetadata( name, visibleName, icon )
      , mToolFunc( toolFunction )
    {}

    QgsAdvancedDigitizingToolFunc toolFunction() const { return mToolFunc; }

    void setToolFunction( const QgsAdvancedDigitizingToolFunc &function ) { mToolFunc = function; }
 
    QgsAdvancedDigitizingTool *createTool( QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget ) override;
 
  protected:
    QgsAdvancedDigitizingToolFunc mToolFunc = nullptr;
};
 
#endif

class GUI_EXPORT QgsAdvancedDigitizingToolsRegistry
{
  public:
    QgsAdvancedDigitizingToolsRegistry() = default;
    ~QgsAdvancedDigitizingToolsRegistry();
 
    QgsAdvancedDigitizingToolsRegistry( const QgsAdvancedDigitizingToolsRegistry &rh ) = delete;
    QgsAdvancedDigitizingToolsRegistry &operator=( const QgsAdvancedDigitizingToolsRegistry &rh ) = delete;

    void addDefaultTools();

    bool addTool( QgsAdvancedDigitizingToolAbstractMetadata *toolMetaData SIP_TRANSFER );

    bool removeTool( const QString &name );

    QgsAdvancedDigitizingToolAbstractMetadata *toolMetadata( const QString &name );

    const QStringList toolMetadataNames() const;
 
  private:
#ifdef SIP_RUN
    QgsAdvancedDigitizingToolsRegistry( const QgsAdvancedDigitizingToolsRegistry &rh );
#endif
 
    QMap<QString, QgsAdvancedDigitizingToolAbstractMetadata *> mTools;
};
 
#endif // QGSADVANCEDDIGITIZINGTOOLSREGSITRY_H