qgstextbuffersettings.h

Go to the documentation of this file.

/***************************************************************************
  qgstextbuffersettings.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 QGSTEXTBUFFERSETTINGS_H
#define QGSTEXTBUFFERSETTINGS_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsmapunitscale.h"
 
#include <QDomElement>
#include <QPainter>
#include <QSharedData>
 
class QgsReadWriteContext;
class QgsTextBufferSettingsPrivate;
class QgsVectorLayer;
class QgsPaintEffect;
class QgsPropertyCollection;

class CORE_EXPORT QgsTextBufferSettings
{
  public:
    QgsTextBufferSettings();
 
    QgsTextBufferSettings( const QgsTextBufferSettings &other );
    SIP_SKIP QgsTextBufferSettings( QgsTextBufferSettings &&other );
 
    QgsTextBufferSettings &operator=( const QgsTextBufferSettings &other );
    QgsTextBufferSettings &operator=( QgsTextBufferSettings &&other );
 
    ~QgsTextBufferSettings();
 
    bool operator==( const QgsTextBufferSettings &other ) const;
    bool operator!=( const QgsTextBufferSettings &other ) const;

    bool enabled() const;

    void setEnabled( bool enabled );

    double size() const;

    void setSize( double size );

    Qgis::RenderUnit sizeUnit() const;

    void setSizeUnit( Qgis::RenderUnit unit );

    QgsMapUnitScale sizeMapUnitScale() const;

    void setSizeMapUnitScale( const QgsMapUnitScale &scale );

    QColor color() const;

    void setColor( const QColor &color );

    bool fillBufferInterior() const;

    void setFillBufferInterior( bool fill );

    double opacity() const;

    void setOpacity( double opacity );

    Qt::PenJoinStyle joinStyle() const;

    void setJoinStyle( Qt::PenJoinStyle style );

    QPainter::CompositionMode blendMode() const;

    void setBlendMode( QPainter::CompositionMode mode );

    void readFromLayer( QgsVectorLayer *layer );

    void readXml( const QDomElement &elem );

    QDomElement writeXml( QDomDocument &doc ) const;

    const QgsPaintEffect *paintEffect() const;

    void setPaintEffect( QgsPaintEffect *effect SIP_TRANSFER );

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

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