qgstextbackgroundsettings.h

Go to the documentation of this file.

/***************************************************************************
  qgstextbackgroundsettings.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 QGSTEXTBACKGROUNDSETTINGS_H
#define QGSTEXTBACKGROUNDSETTINGS_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsmapunitscale.h"
 
#include <QDomElement>
#include <QPainter>
#include <QPointF>
#include <QSharedDataPointer>
#include <QSizeF>
#include <QString>
 
class QgsMarkerSymbol;
class QgsFillSymbol;
class QgsPaintEffect;
class QgsVectorLayer;
class QgsReadWriteContext;
class QgsPropertyCollection;
class QgsTextBackgroundSettingsPrivate;

class CORE_EXPORT QgsTextBackgroundSettings
{
  public:
    enum ShapeType
    {
      ShapeRectangle = 0, 
      ShapeSquare,        
      ShapeEllipse,       
      ShapeCircle,        
      ShapeSVG,           
      ShapeMarkerSymbol,  
    };

    enum SizeType
    {
      SizeBuffer = 0, 
      SizeFixed,      
      SizePercent     
    };

    enum RotationType
    {
      RotationSync = 0, 
      RotationOffset,   
      RotationFixed     
    };
 
    QgsTextBackgroundSettings();
 
    QgsTextBackgroundSettings( const QgsTextBackgroundSettings &other );
    SIP_SKIP QgsTextBackgroundSettings( QgsTextBackgroundSettings &&other );
 
    QgsTextBackgroundSettings &operator=( const QgsTextBackgroundSettings &other );
    QgsTextBackgroundSettings &operator=( QgsTextBackgroundSettings &&other );
 
    ~QgsTextBackgroundSettings();
 
    bool operator==( const QgsTextBackgroundSettings &other ) const;
    bool operator!=( const QgsTextBackgroundSettings &other ) const;

    bool enabled() const;

    void setEnabled( bool enabled );

    ShapeType type() const;

    void setType( ShapeType type );

    QString svgFile() const;

    void setSvgFile( const QString &file );

    QgsMarkerSymbol *markerSymbol() const;

    void setMarkerSymbol( QgsMarkerSymbol *symbol SIP_TRANSFER );

    QgsFillSymbol *fillSymbol() const;

    void setFillSymbol( QgsFillSymbol *symbol SIP_TRANSFER );

    SizeType sizeType() const;

    void setSizeType( SizeType type );

    QSizeF size() const;

    void setSize( QSizeF size );

    Qgis::RenderUnit sizeUnit() const;

    void setSizeUnit( Qgis::RenderUnit unit );

    QgsMapUnitScale sizeMapUnitScale() const;

    void setSizeMapUnitScale( const QgsMapUnitScale &scale );

    RotationType rotationType() const;

    void setRotationType( RotationType type );

    double rotation() const;

    void setRotation( double rotation );

    QPointF offset() const;

    void setOffset( QPointF offset );

    Qgis::RenderUnit offsetUnit() const;

    void setOffsetUnit( Qgis::RenderUnit units );

    QgsMapUnitScale offsetMapUnitScale() const;

    void setOffsetMapUnitScale( const QgsMapUnitScale &scale );

    QSizeF radii() const;

    void setRadii( QSizeF radii );

    Qgis::RenderUnit radiiUnit() const;

    void setRadiiUnit( Qgis::RenderUnit units );

    QgsMapUnitScale radiiMapUnitScale() const;

    void setRadiiMapUnitScale( const QgsMapUnitScale &scale );

    double opacity() const;

    void setOpacity( double opacity );

    QPainter::CompositionMode blendMode() const;

    void setBlendMode( QPainter::CompositionMode mode );

    QColor fillColor() const;

    void setFillColor( const QColor &color );

    QColor strokeColor() const;

    void setStrokeColor( const QColor &color );

    double strokeWidth() const;

    void setStrokeWidth( double width );

    Qgis::RenderUnit strokeWidthUnit() const;

    void setStrokeWidthUnit( Qgis::RenderUnit units );

    QgsMapUnitScale strokeWidthMapUnitScale() const;

    void setStrokeWidthMapUnitScale( const QgsMapUnitScale &scale );

    Qt::PenJoinStyle joinStyle() const;

    void setJoinStyle( Qt::PenJoinStyle style );

    const QgsPaintEffect *paintEffect() const;

    void setPaintEffect( QgsPaintEffect *effect SIP_TRANSFER );

    void readFromLayer( QgsVectorLayer *layer );

    void readXml( const QDomElement &elem, const QgsReadWriteContext &context );

    QDomElement writeXml( QDomDocument &doc, const QgsReadWriteContext &context ) const;

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

    void upgradeDataDefinedProperties( QgsPropertyCollection &properties ) SIP_SKIP;

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