qgstextshadowsettings.h

Go to the documentation of this file.

/***************************************************************************
  qgstextshadowsettings.h
  -----------------
   begin                : May 2020
   copyright            : (C) 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 QGSTEXTSHADOWSETTINGS_H
#define QGSTEXTSHADOWSETTINGS_H
 
#include "qgsmapunitscale.h"
 
#include <QDomElement>
#include <QPainter>
#include <QSharedDataPointer>
 
class QgsTextShadowSettingsPrivate;
class QgsVectorLayer;
class QgsPropertyCollection;

class CORE_EXPORT QgsTextShadowSettings
{
  public:

    enum ShadowPlacement
    {
      ShadowLowest = 0, 
      ShadowText, 
      ShadowBuffer, 
      ShadowShape 
    };
 
    QgsTextShadowSettings();
    QgsTextShadowSettings( const QgsTextShadowSettings &other );
    SIP_SKIP QgsTextShadowSettings( QgsTextShadowSettings &&other );
 
    QgsTextShadowSettings &operator=( const QgsTextShadowSettings &other );
    QgsTextShadowSettings &operator=( QgsTextShadowSettings &&other );
 
    ~QgsTextShadowSettings();
 
    bool operator==( const QgsTextShadowSettings &other ) const;
    bool operator!=( const QgsTextShadowSettings &other ) const;

    bool enabled() const;

    void setEnabled( bool enabled );

    QgsTextShadowSettings::ShadowPlacement shadowPlacement() const;

    void setShadowPlacement( QgsTextShadowSettings::ShadowPlacement placement );

    int offsetAngle() const;

    void setOffsetAngle( int angle );

    double offsetDistance() const;

    void setOffsetDistance( double distance );

    Qgis::RenderUnit offsetUnit() const;

    void setOffsetUnit( Qgis::RenderUnit units );

    QgsMapUnitScale offsetMapUnitScale() const;

    void setOffsetMapUnitScale( const QgsMapUnitScale &scale );

    bool offsetGlobal() const;

    void setOffsetGlobal( bool global );

    double blurRadius() const;

    void setBlurRadius( double blurRadius );

    Qgis::RenderUnit blurRadiusUnit() const;

    void setBlurRadiusUnit( Qgis::RenderUnit units );

    QgsMapUnitScale blurRadiusMapUnitScale() const;

    void setBlurRadiusMapUnitScale( const QgsMapUnitScale &scale );

    bool blurAlphaOnly() const;

    void setBlurAlphaOnly( bool alphaOnly );

    double opacity() const;

    void setOpacity( double opacity );

    int scale() const;

    void setScale( int scale );

    QColor color() const;

    void setColor( const QColor &color );

    QPainter::CompositionMode blendMode() const;

    void setBlendMode( QPainter::CompositionMode mode );

    void readFromLayer( QgsVectorLayer *layer );

    void readXml( const QDomElement &elem );

    QDomElement writeXml( QDomDocument &doc ) const;

    void updateDataDefinedProperties( QgsRenderContext &context, const QgsPropertyCollection &properties );

    QSet<QString> referencedFields( const QgsRenderContext &context ) const;
 
  private:
 
    QSharedDataPointer<QgsTextShadowSettingsPrivate> d;
 
};
 
#endif // QGSTEXTSHADOWSETTINGS_H