qgstextmasksettings.h

Go to the documentation of this file.

/***************************************************************************
  qgstextmasksettings.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 QGSTEXTMASKSETTINGS_H
#define QGSTEXTMASKSETTINGS_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsmapunitscale.h"
 
#include <QDomElement>
#include <QSharedDataPointer>
 
class QgsTextMaskSettingsPrivate;
class QgsPaintEffect;
class QgsPropertyCollection;
class QgsSymbolLayerReference;

 
class CORE_EXPORT QgsTextMaskSettings
{
  public:

    enum MaskType
    {
      MaskBuffer = 0 
    };
 
    QgsTextMaskSettings();
 
    QgsTextMaskSettings( const QgsTextMaskSettings &other );
    SIP_SKIP QgsTextMaskSettings( QgsTextMaskSettings &&other );
    QgsTextMaskSettings &operator=( const QgsTextMaskSettings &other );
    QgsTextMaskSettings &operator=( QgsTextMaskSettings &&other );
 
    ~QgsTextMaskSettings();
 
    bool operator==( const QgsTextMaskSettings &other ) const;
    bool operator!=( const QgsTextMaskSettings &other ) const;

    bool enabled() const;

    void setEnabled( bool );

    MaskType type() const;

    void setType( MaskType type );

    double size() const;

    void setSize( double size );

    Qgis::RenderUnit sizeUnit() const;

    void setSizeUnit( Qgis::RenderUnit unit );

    QgsMapUnitScale sizeMapUnitScale() const;

    void setSizeMapUnitScale( const QgsMapUnitScale &scale );

    Qt::PenJoinStyle joinStyle() const;

    void setJoinStyle( Qt::PenJoinStyle style );

    double opacity() const;

    void setOpacity( double opacity );

    QgsPaintEffect *paintEffect() const;

    void setPaintEffect( QgsPaintEffect *effect SIP_TRANSFER );

    void readXml( const QDomElement &elem );

    QDomElement writeXml( QDomDocument &doc ) const;

    QList<QgsSymbolLayerReference> maskedSymbolLayers() const;

    void setMaskedSymbolLayers( const QList<QgsSymbolLayerReference> &maskedLayers );

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

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