qgscalloutsregistry.h

Go to the documentation of this file.

/***************************************************************************
    qgscalloutsregistry.h
    ---------------------
    begin                : July 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 QGSCALLOUTSREGISTRY_H
#define QGSCALLOUTSREGISTRY_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgsreadwritecontext.h"
 
#include <QIcon>
 
class QgsPathResolver;
class QgsMapLayer;
class QgsCalloutWidget SIP_EXTERNAL;
class QgsCallout;
class QDomElement;

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

    QString name() const { return mName; }

    QString visibleName() const { return mVisibleName; }

    QIcon icon() const { return mIcon; }

    void setIcon( const QIcon &icon ) { mIcon = icon; }

    virtual QgsCallout *createCallout( const QVariantMap &properties, const QgsReadWriteContext &context ) = 0 SIP_FACTORY;

    virtual QgsCalloutWidget *createCalloutWidget( QgsMapLayer * );
 
  protected:
    QString mName;
    QString mVisibleName;
    QIcon mIcon;
};
 
typedef QgsCallout *( *QgsCalloutCreateFunc )( const QVariantMap &, const QgsReadWriteContext & ) SIP_SKIP;
typedef QgsCalloutWidget *( *QgsCalloutWidgetFunc )( QgsMapLayer * ) SIP_SKIP;

class CORE_EXPORT QgsCalloutMetadata : public QgsCalloutAbstractMetadata
{
  public:
#ifndef SIP_RUN
    QgsCalloutMetadata( const QString &name, const QString &visibleName, const QIcon &icon, QgsCalloutCreateFunc pfCreate, QgsCalloutWidgetFunc pfWidget = nullptr )
      : QgsCalloutAbstractMetadata( name, visibleName, icon )
      , mCreateFunc( pfCreate )
      , mWidgetFunc( pfWidget )
    {}

    QgsCalloutCreateFunc createFunction() const { return mCreateFunc; }
    QgsCalloutWidgetFunc widgetFunction() const { return mWidgetFunc; }

    void setWidgetFunction( QgsCalloutWidgetFunc f ) { mWidgetFunc = f; }
#endif
 
    QgsCallout *createCallout( const QVariantMap &properties, const QgsReadWriteContext &context ) override SIP_FACTORY;
    QgsCalloutWidget *createCalloutWidget( QgsMapLayer *vl ) override SIP_FACTORY;
 
  protected:
    QgsCalloutCreateFunc mCreateFunc;
    QgsCalloutWidgetFunc mWidgetFunc;
 
  private:
#ifdef SIP_RUN
    QgsCalloutMetadata();
#endif
};
 

class CORE_EXPORT QgsCalloutRegistry
{
  public:
    QgsCalloutRegistry();
    ~QgsCalloutRegistry();
 
    QgsCalloutRegistry( const QgsCalloutRegistry &rh ) = delete;
    QgsCalloutRegistry &operator=( const QgsCalloutRegistry &rh ) = delete;

    QgsCalloutAbstractMetadata *calloutMetadata( const QString &type ) const;

    bool addCalloutType( QgsCalloutAbstractMetadata *metadata SIP_TRANSFER );

    QgsCallout *createCallout( const QString &type, const QVariantMap &properties = QVariantMap(), const QgsReadWriteContext &context = QgsReadWriteContext() ) const SIP_FACTORY;

    QgsCallout *createCallout( const QString &type, const QDomElement &element, const QgsReadWriteContext &context ) const SIP_FACTORY;

    QStringList calloutTypes() const;

    static QgsCallout *defaultCallout() SIP_FACTORY;
 
  private:
#ifdef SIP_RUN
    QgsCalloutRegistry( const QgsCalloutRegistry &rh );
#endif
 
    QMap<QString, QgsCalloutAbstractMetadata *> mMetadata;
};
 
#endif // QGSCALLOUTSREGISTRY_H