qgslabelingengineruleregistry.h

Go to the documentation of this file.

/***************************************************************************
    qgslabelingengineruleregistry.h
    ---------------------
  Date                 : August 2024
  Copyright            : (C) 2024 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 QGSLABELINGENGINERULEREGISTRY_H
#define QGSLABELINGENGINERULEREGISTRY_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
 
class QgsAbstractLabelingEngineRule;

class CORE_EXPORT QgsLabelingEngineRuleRegistry
{
  public:
    QgsLabelingEngineRuleRegistry();
    ~QgsLabelingEngineRuleRegistry();

    QgsLabelingEngineRuleRegistry( const QgsLabelingEngineRuleRegistry &other ) = delete;
    QgsLabelingEngineRuleRegistry &operator=( const QgsLabelingEngineRuleRegistry &other ) = delete;

    QStringList ruleIds() const;

    QString displayType( const QString &id ) const;

    bool isAvailable( const QString &id ) const;

    QgsAbstractLabelingEngineRule *create( const QString &id ) const SIP_TRANSFERBACK;

    bool addRule( QgsAbstractLabelingEngineRule *rule SIP_TRANSFER );

    void removeRule( const QString &id );
 
  private:
#ifdef SIP_RUN
    QgsLabelingEngineRuleRegistry( const QgsLabelingEngineRuleRegistry &other );
#endif
 
    std::map< QString, std::unique_ptr< QgsAbstractLabelingEngineRule > > mRules;
};
 
#endif // QGSLABELINGENGINERULEREGISTRY_H