qgsmaptoolshaperegistry.h

Go to the documentation of this file.

/***************************************************************************
                         qgsmaptoolshaperegistry.h
                         ----------------------
    begin                : January 2022
    copyright            : (C) 2022 by Denis Rouzaud
    email                : [email protected]
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 QGSMAPTOOLSHAPEREGISTRY_H
#define QGSMAPTOOLSHAPEREGISTRY_H
 
#define SIP_NO_FILE
 
#include "qgis_gui.h"
#include "qgsabstractrelationeditorwidget.h"
#include "qgsmaptoolshapeabstract.h"
 
class QgsMapToolShapeMetadata;
class QgsMapToolCapture;

class GUI_EXPORT QgsMapToolShapeRegistry
{
    Q_GADGET
  public:

    QgsMapToolShapeRegistry();
 
    ~QgsMapToolShapeRegistry();

    void addMapTool( QgsMapToolShapeMetadata *mapTool SIP_TRANSFER );

    void removeMapTool( const QString &id );

    QList<QgsMapToolShapeMetadata *> mapToolMetadatas() const { return mMapTools; }

    QgsMapToolShapeMetadata *mapToolMetadata( const QString &id ) const;

    QgsMapToolShapeAbstract *mapTool( const QString &id, QgsMapToolCapture *parentTool ) const SIP_FACTORY;
 
  private:
    QList<QgsMapToolShapeMetadata *> mMapTools;
};

class GUI_EXPORT QgsMapToolShapeMetadata
{
  public:
    QgsMapToolShapeMetadata() = default;
 
    virtual ~QgsMapToolShapeMetadata() = default;

    virtual QString id() const = 0;

    virtual QString name() const = 0;

    virtual QIcon icon() const = 0;

    virtual QgsMapToolShapeAbstract::ShapeCategory category() const = 0;

    virtual QgsMapToolShapeAbstract *factory( QgsMapToolCapture *parentlTool ) const SIP_FACTORY = 0;
};
 
 
#endif // QGSMAPTOOLSHAPEREGISTRY_H