qgstextrenderer.h

Go to the documentation of this file.

/***************************************************************************
  qgstextrenderer.h
  -----------------
   begin                : September 2015
   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 QGSTEXTRENDERER_H
#define QGSTEXTRENDERER_H

#include "qgis_sip.h"
#include "qgis_core.h"
#include "qgsmapunitscale.h"
#include "qgsunittypes.h"

#include <QSharedData>
#include <QPainter>
#include <QPicture>
#include <QDomElement>

class QgsReadWriteContext;
class QgsTextBufferSettingsPrivate;
class QgsTextBackgroundSettingsPrivate;
class QgsTextShadowSettingsPrivate;
class QgsTextSettingsPrivate;
class QgsVectorLayer;
class QgsPaintEffect;
class QgsMarkerSymbol;
class QgsPropertyCollection;

class CORE_EXPORT QgsTextBufferSettings
{
  public:

    QgsTextBufferSettings();

    QgsTextBufferSettings( const QgsTextBufferSettings &other );

    QgsTextBufferSettings &operator=( const QgsTextBufferSettings &other );

    ~QgsTextBufferSettings();

    bool enabled() const;

    void setEnabled( bool enabled );

    double size() const;

    void setSize( double size );

    QgsUnitTypes::RenderUnit sizeUnit() const;

    void setSizeUnit( QgsUnitTypes::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;

    QgsPaintEffect *paintEffect() const;

    void setPaintEffect( QgsPaintEffect *effect SIP_TRANSFER );

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

  private:

    QSharedDataPointer<QgsTextBufferSettingsPrivate> d;

};

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 );

    QgsTextBackgroundSettings &operator=( const QgsTextBackgroundSettings &other );

    ~QgsTextBackgroundSettings();

    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 );

    SizeType sizeType() const;

    void setSizeType( SizeType type );

    QSizeF size() const;

    void setSize( QSizeF size );

    QgsUnitTypes::RenderUnit sizeUnit() const;

    void setSizeUnit( QgsUnitTypes::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 );

    QgsUnitTypes::RenderUnit offsetUnit() const;

    void setOffsetUnit( QgsUnitTypes::RenderUnit units );

    QgsMapUnitScale offsetMapUnitScale() const;

    void setOffsetMapUnitScale( const QgsMapUnitScale &scale );

    QSizeF radii() const;

    void setRadii( QSizeF radii );

    QgsUnitTypes::RenderUnit radiiUnit() const;

    void setRadiiUnit( QgsUnitTypes::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 );

    QgsUnitTypes::RenderUnit strokeWidthUnit() const;

    void setStrokeWidthUnit( QgsUnitTypes::RenderUnit units );

    QgsMapUnitScale strokeWidthMapUnitScale() const;

    void setStrokeWidthMapUnitScale( const QgsMapUnitScale &scale );

    Qt::PenJoinStyle joinStyle() const;

    void setJoinStyle( Qt::PenJoinStyle style );

    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 );

  private:

    QSharedDataPointer<QgsTextBackgroundSettingsPrivate> d;

};

class CORE_EXPORT QgsTextShadowSettings
{
  public:

    enum ShadowPlacement
    {
      ShadowLowest = 0, 
      ShadowText, 
      ShadowBuffer, 
      ShadowShape 
    };

    QgsTextShadowSettings();

    QgsTextShadowSettings( const QgsTextShadowSettings &other );

    QgsTextShadowSettings &operator=( const QgsTextShadowSettings &other );

    ~QgsTextShadowSettings();

    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 );

    QgsUnitTypes::RenderUnit offsetUnit() const;

    void setOffsetUnit( QgsUnitTypes::RenderUnit units );

    QgsMapUnitScale offsetMapUnitScale() const;

    void setOffsetMapUnitScale( const QgsMapUnitScale &scale );

    bool offsetGlobal() const;

    void setOffsetGlobal( bool global );

    double blurRadius() const;

    void setBlurRadius( double blurRadius );

    QgsUnitTypes::RenderUnit blurRadiusUnit() const;

    void setBlurRadiusUnit( QgsUnitTypes::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 );

  private:

    QSharedDataPointer<QgsTextShadowSettingsPrivate> d;

};


class CORE_EXPORT QgsTextFormat
{
  public:

    enum TextOrientation
    {
      HorizontalOrientation, 
      VerticalOrientation, 
      RotationBasedOrientation, 
    };

    QgsTextFormat();

    QgsTextFormat( const QgsTextFormat &other );

    QgsTextFormat &operator=( const QgsTextFormat &other );

    ~QgsTextFormat();

    QgsTextBufferSettings &buffer() { return mBufferSettings; }

    SIP_SKIP QgsTextBufferSettings buffer() const { return mBufferSettings; }

    void setBuffer( const QgsTextBufferSettings &bufferSettings ) { mBufferSettings = bufferSettings; }

    QgsTextBackgroundSettings &background() { return mBackgroundSettings; }

    SIP_SKIP QgsTextBackgroundSettings background() const { return mBackgroundSettings; }

    void setBackground( const QgsTextBackgroundSettings &backgroundSettings ) { mBackgroundSettings = backgroundSettings; }

    QgsTextShadowSettings &shadow() { return mShadowSettings; }

    SIP_SKIP QgsTextShadowSettings shadow() const { return mShadowSettings; }

    void setShadow( const QgsTextShadowSettings &shadowSettings ) { mShadowSettings = shadowSettings; }

    QFont font() const;

    QFont scaledFont( const QgsRenderContext &context ) const;

    void setFont( const QFont &font );

    QString namedStyle() const;

    void setNamedStyle( const QString &style );

    double size() const;

    void setSize( double size );

    QgsUnitTypes::RenderUnit sizeUnit() const;

    void setSizeUnit( QgsUnitTypes::RenderUnit unit );

    QgsMapUnitScale sizeMapUnitScale() const;

    void setSizeMapUnitScale( const QgsMapUnitScale &scale );

    QColor color() const;

    void setColor( const QColor &color );

    double opacity() const;

    void setOpacity( double opacity );

    QPainter::CompositionMode blendMode() const;

    void setBlendMode( QPainter::CompositionMode mode );

    double lineHeight() const;

    void setLineHeight( double height );

    TextOrientation orientation() const;

    void setOrientation( TextOrientation orientation );

    QColor previewBackgroundColor() const;

    void setPreviewBackgroundColor( const QColor &color );

    void readFromLayer( QgsVectorLayer *layer );

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

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

    QMimeData *toMimeData() const SIP_FACTORY;

    static QgsTextFormat fromQFont( const QFont &font );

    QFont toQFont() const;

    static QgsTextFormat fromMimeData( const QMimeData *data, bool *ok SIP_OUT = nullptr );

    bool containsAdvancedEffects() const;

    bool fontFound() const { return mTextFontFound; }

    QString resolvedFontFamily() const { return mTextFontFamily; }

    QgsPropertyCollection &dataDefinedProperties();

    const QgsPropertyCollection &dataDefinedProperties() const SIP_SKIP;

    void setDataDefinedProperties( const QgsPropertyCollection &collection );

    void updateDataDefinedProperties( QgsRenderContext &context );

    static QPixmap textFormatPreviewPixmap( const QgsTextFormat &format, QSize size, const QString &previewText = QString(), int padding = 0 );

  private:

    QgsTextBufferSettings mBufferSettings;
    QgsTextBackgroundSettings mBackgroundSettings;
    QgsTextShadowSettings mShadowSettings;

    QString mTextFontFamily;
    bool mTextFontFound = true;

    QSharedDataPointer<QgsTextSettingsPrivate> d;

};

class CORE_EXPORT QgsTextRenderer
{
  public:

    enum DrawMode
    {
      Rect = 0, 
      Point, 
      Label, 
    };

    enum TextPart
    {
      Text = 0, 
      Buffer, 
      Background, 
      Shadow, 
    };

    enum HAlignment
    {
      AlignLeft = 0, 
      AlignCenter, 
      AlignRight, 
    };

    static int sizeToPixel( double size, const QgsRenderContext &c, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale &mapUnitScale = QgsMapUnitScale() );

    // TODO QGIS 4.0 -- remove drawAsOutlines from below methods!

    static void drawText( const QRectF &rect, double rotation, HAlignment alignment, const QStringList &textLines,
                          QgsRenderContext &context, const QgsTextFormat &format,
                          bool drawAsOutlines = true );

    static void drawText( QPointF point, double rotation, HAlignment alignment, const QStringList &textLines,
                          QgsRenderContext &context, const QgsTextFormat &format,
                          bool drawAsOutlines = true );

    static void drawPart( const QRectF &rect, double rotation, HAlignment alignment, const QStringList &textLines,
                          QgsRenderContext &context, const QgsTextFormat &format,
                          TextPart part, bool drawAsOutlines = true );

    static void drawPart( QPointF origin, double rotation, HAlignment alignment, const QStringList &textLines,
                          QgsRenderContext &context, const QgsTextFormat &format,
                          TextPart part, bool drawAsOutlines = true );

    static QFontMetricsF fontMetrics( QgsRenderContext &context, const QgsTextFormat &format );

    static double textWidth( const QgsRenderContext &context, const QgsTextFormat &format, const QStringList &textLines,
                             QFontMetricsF *fontMetrics = nullptr );

    static double textHeight( const QgsRenderContext &context, const QgsTextFormat &format, const QStringList &textLines, DrawMode mode,
                              QFontMetricsF *fontMetrics = nullptr );

  private:

    struct Component
    {
      QString text;
      QPointF origin;
      bool useOrigin = false;
      double rotation = 0.0;
      double rotationOffset = 0.0;
      QPointF center;
      QSizeF size;
      QPointF offset;
      QPicture picture;

      double pictureBuffer = 0.0;
      double dpiRatio = 1.0;
      HAlignment hAlign = AlignLeft;
    };

    static void drawBuffer( QgsRenderContext &context,
                            const Component &component,
                            const QgsTextFormat &format,
                            const QFontMetricsF *fontMetrics );

    static void drawBackground( QgsRenderContext &context,
                                Component component,
                                const QgsTextFormat &format,
                                const QStringList &textLines,
                                DrawMode mode = Rect );

    static void drawShadow( QgsRenderContext &context,
                            const Component &component,
                            const QgsTextFormat &format );

    static void drawText( QgsRenderContext &context,
                          const Component &component,
                          const QgsTextFormat &format );

    static void drawTextInternal( TextPart drawType,
                                  QgsRenderContext &context,
                                  const QgsTextFormat &format,
                                  const Component &component,
                                  const QStringList &textLines,
                                  const QFontMetricsF *fontMetrics,
                                  HAlignment alignment,
                                  DrawMode mode = Rect );

    friend class QgsVectorLayerLabelProvider;
    friend class QgsLabelPreview;

    static QgsTextFormat updateShadowPosition( const QgsTextFormat &format );


};

class CORE_EXPORT QgsTextRendererUtils
{
  public:

    static QgsTextBackgroundSettings::ShapeType decodeShapeType( const QString &string );

    static QgsTextBackgroundSettings::SizeType decodeBackgroundSizeType( const QString &string );

    static QgsTextBackgroundSettings::RotationType decodeBackgroundRotationType( const QString &string );

    static QgsTextShadowSettings::ShadowPlacement decodeShadowPlacementType( const QString &string );

    static QString encodeTextOrientation( QgsTextFormat::TextOrientation orientation );

    static QgsTextFormat::TextOrientation decodeTextOrientation( const QString &name, bool *ok = nullptr );
};


#endif // QGSTEXTRENDERER_H