qgsannotationitemregistry.h

Go to the documentation of this file.

/***************************************************************************
                            qgsannotationitemregistry.h
                            ------------------------
    begin                : October 2019
    copyright            : (C) 2019 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 QGSANNOTATIONITEMREGISTRY_H
#define QGSANNOTATIONITEMREGISTRY_H

#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsapplication.h"
#include "qgspathresolver.h"
#include <QGraphicsItem> //for QGraphicsItem::UserType
#include <QIcon>
#include <functional>

class QgsAnnotationItem;
class QDomElement;
class QgsReadWriteContext;

class CORE_EXPORT QgsAnnotationItemAbstractMetadata
{
  public:

    QgsAnnotationItemAbstractMetadata( const QString &type, const QString &visibleName, const QString &visiblePluralName = QString() )
      : mType( type )
      , mVisibleName( visibleName )
      , mVisibleNamePlural( visiblePluralName.isEmpty() ? visibleName : visiblePluralName )
    {}

    virtual ~QgsAnnotationItemAbstractMetadata() = default;

    QString type() const { return mType; }

    QString visibleName() const { return mVisibleName; }

    QString visiblePluralName() const { return mVisibleNamePlural; }

    virtual QgsAnnotationItem *createItem() = 0 SIP_FACTORY;

  private:

    QString mType;
    QString mVisibleName;
    QString mVisibleNamePlural;
};

typedef std::function<QgsAnnotationItem *()> QgsAnnotationItemCreateFunc SIP_SKIP;

#ifndef SIP_RUN

class CORE_EXPORT QgsAnnotationItemMetadata : public QgsAnnotationItemAbstractMetadata
{
  public:

    QgsAnnotationItemMetadata( const QString &type, const QString &visibleName, const QString &visiblePluralName,
                               const QgsAnnotationItemCreateFunc &pfCreate )
      : QgsAnnotationItemAbstractMetadata( type, visibleName, visiblePluralName )
      , mCreateFunc( pfCreate )
    {}

    QgsAnnotationItemCreateFunc createFunction() const { return mCreateFunc; }

    QgsAnnotationItem *createItem() override { return mCreateFunc ? mCreateFunc() : nullptr; }

  protected:
    QgsAnnotationItemCreateFunc mCreateFunc = nullptr;

};

#endif


class CORE_EXPORT QgsAnnotationItemRegistry : public QObject
{
    Q_OBJECT

  public:

    QgsAnnotationItemRegistry( QObject *parent = nullptr );

    ~QgsAnnotationItemRegistry() override;

    bool populate();

    QgsAnnotationItemRegistry( const QgsAnnotationItemRegistry &rh ) = delete;
    QgsAnnotationItemRegistry &operator=( const QgsAnnotationItemRegistry &rh ) = delete;

    QgsAnnotationItemAbstractMetadata *itemMetadata( const QString &type ) const;

    bool addItemType( QgsAnnotationItemAbstractMetadata *metadata SIP_TRANSFER );

    QgsAnnotationItem *createItem( const QString &type ) const SIP_FACTORY;

    QMap< QString, QString> itemTypes() const;

  signals:

    void typeAdded( const QString &type, const QString &name );

  private:
#ifdef SIP_RUN
    QgsAnnotationItemRegistry( const QgsAnnotationItemRegistry &rh );
#endif

    QMap<QString, QgsAnnotationItemAbstractMetadata *> mMetadata;

};

#endif //QGSANNOTATIONITEMREGISTRY_H