qgsvectorlayerlabeling.h

Go to the documentation of this file.

/***************************************************************************
    qgsvectorlayerlabeling.h
    ---------------------
    begin                : September 2015
    copyright            : (C) 2015 by Martin Dobias
    email                : wonder dot sk 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 QGSVECTORLAYERLABELING_H
#define QGSVECTORLAYERLABELING_H
 
#include <memory>
 
#include "qgis.h"
 
#include <QDomNode>
#include <QString>
#include <QStringList>
 
class QDomDocument;
class QDomElement;
 
class QgsPalLayerSettings;
class QgsReadWriteContext;
class QgsVectorLayer;
class QgsVectorLayerLabelProvider;
class QgsStyleEntityVisitorInterface;
class QgsSldExportContext;

class CORE_EXPORT QgsAbstractVectorLayerLabeling
{
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( sipCpp->type() == "simple" )
      sipType = sipType_QgsVectorLayerSimpleLabeling;
    else if ( sipCpp->type() == "rule-based" )
      sipType = sipType_QgsRuleBasedLabeling;
    else
      sipType = 0;
  SIP_END
#endif
 
  public:
 
    QgsAbstractVectorLayerLabeling() = default;
    virtual ~QgsAbstractVectorLayerLabeling() = default;

    virtual QString type() const = 0;

    virtual QgsAbstractVectorLayerLabeling *clone() const = 0 SIP_FACTORY;

    virtual QgsVectorLayerLabelProvider *provider( QgsVectorLayer *layer ) const SIP_SKIP
    {
      Q_UNUSED( layer )
      return nullptr;
    }

    virtual QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) const = 0;

    virtual QStringList subProviders() const { return QStringList( QString() ); }

    virtual QgsPalLayerSettings settings( const QString &providerId = QString() ) const = 0;

    virtual void setSettings( QgsPalLayerSettings *settings SIP_TRANSFER, const QString &providerId = QString() ) = 0;

    virtual bool requiresAdvancedEffects() const = 0;

    virtual bool hasNonDefaultCompositionMode() const = 0;

    virtual void multiplyOpacity( double opacityFactor ) { Q_UNUSED( opacityFactor ); };
 
 
    // static stuff

    static QgsAbstractVectorLayerLabeling *create( const QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;

    Q_DECL_DEPRECATED virtual void toSld( QDomNode &parent, const QVariantMap &props ) const SIP_DEPRECATED;

    virtual bool toSld( QDomNode &parent, QgsSldExportContext &context ) const;

    virtual bool accept( QgsStyleEntityVisitorInterface *visitor ) const;

    static QgsPalLayerSettings defaultSettingsForLayer( const QgsVectorLayer *layer );
 
  protected:
    Q_DECL_DEPRECATED virtual void writeTextSymbolizer( QDomNode &parent, QgsPalLayerSettings &settings, const QVariantMap &props ) const SIP_DEPRECATED;

    virtual bool writeTextSymbolizer( QDomNode &parent, QgsPalLayerSettings &settings, QgsSldExportContext &context ) const;
 
  private:
    Q_DISABLE_COPY( QgsAbstractVectorLayerLabeling )
 
#ifdef SIP_RUN
    QgsAbstractVectorLayerLabeling( const QgsAbstractVectorLayerLabeling &rhs );
#endif
};

class CORE_EXPORT QgsVectorLayerSimpleLabeling : public QgsAbstractVectorLayerLabeling
{
  public:
    explicit QgsVectorLayerSimpleLabeling( const QgsPalLayerSettings &settings );
 
    QString type() const override;
    QgsAbstractVectorLayerLabeling *clone() const override SIP_FACTORY;
    QgsVectorLayerLabelProvider *provider( QgsVectorLayer *layer ) const override SIP_SKIP;
    QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) const override;
    QgsPalLayerSettings settings( const QString &providerId = QString() ) const override;
    bool accept( QgsStyleEntityVisitorInterface *visitor ) const override;

    void setSettings( QgsPalLayerSettings *settings SIP_TRANSFER, const QString &providerId = QString() ) override;
 
    bool requiresAdvancedEffects() const override;
    bool hasNonDefaultCompositionMode() const override;
    Q_DECL_DEPRECATED void toSld( QDomNode &parent, const QVariantMap &props ) const override SIP_DEPRECATED;
    bool toSld( QDomNode &parent, QgsSldExportContext &context ) const override;
    void multiplyOpacity( double opacityFactor ) override;
    static QgsVectorLayerSimpleLabeling *create( const QDomElement &element, const QgsReadWriteContext &context ); // cppcheck-suppress duplInheritedMember
 
  private:
    std::unique_ptr<QgsPalLayerSettings> mSettings;
};
 
#endif // QGSVECTORLAYERLABELING_H