qgstextformat.h

Go to the documentation of this file.

/***************************************************************************
  qgstextformat.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 QGSTEXTFORMAT_H
#define QGSTEXTFORMAT_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsscreenproperties.h"
#include "qgsstringutils.h"
#include "qgstextbackgroundsettings.h"
#include "qgstextbuffersettings.h"
#include "qgstextmasksettings.h"
#include "qgstextshadowsettings.h"
 
#include <QSharedDataPointer>
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QMimeData;
class QgsTextSettingsPrivate;

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

    bool isValid() const;

    void setValid();

    QgsTextBufferSettings &buffer();

    SIP_SKIP QgsTextBufferSettings buffer() const { return mBufferSettings; }

    void setBuffer( const QgsTextBufferSettings &bufferSettings );

    QgsTextBackgroundSettings &background();

    SIP_SKIP QgsTextBackgroundSettings background() const { return mBackgroundSettings; }

    void setBackground( const QgsTextBackgroundSettings &backgroundSettings );

    QgsTextShadowSettings &shadow();

    SIP_SKIP QgsTextShadowSettings shadow() const { return mShadowSettings; }

    void setShadow( const QgsTextShadowSettings &shadowSettings );

    QgsTextMaskSettings &mask();

    SIP_SKIP QgsTextMaskSettings mask() const { return mMaskSettings; }

    void setMask( const QgsTextMaskSettings &maskSettings );

    QFont font() const;

    QFont scaledFont( const QgsRenderContext &context, double scaleFactor = 1.0, bool *isZeroSize SIP_PYARGREMOVE = nullptr ) const;

    void setFont( const QFont &font );

    QString namedStyle() const;

    void setNamedStyle( const QString &style );

    bool forcedBold() const;

    void setForcedBold( bool forced );

    bool forcedItalic() const;

    void setForcedItalic( bool forced );

    QStringList families() const;

    void setFamilies( const QStringList &families );

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

    double opacity() const;

    void multiplyOpacity( double opacityFactor );

    void setOpacity( double opacity );

    int stretchFactor() const;

    void setStretchFactor( int factor );

    QPainter::CompositionMode blendMode() const;

    void setBlendMode( QPainter::CompositionMode mode );

    double lineHeight() const;

    void setLineHeight( double height );

    Qgis::RenderUnit lineHeightUnit() const;

    void setLineHeightUnit( Qgis::RenderUnit unit );

    double tabStopDistance() const;

    void setTabStopDistance( double distance );

    class CORE_EXPORT Tab
    {
      public:
        explicit Tab( double position );

        void setPosition( double position ) { mPosition = position; }

        double position() const { return mPosition; }
 
        bool operator==( const QgsTextFormat::Tab &other ) const { return qgsDoubleNear( mPosition, other.mPosition ); }
 
#ifdef SIP_RUN
        // clang-format off
        SIP_PYOBJECT __repr__();
        % MethodCode
        const QString str = u"<QgsTextFormat.Tab: %1>"_s.arg( sipCpp->position() );
        sipRes = PyUnicode_FromString( str.toUtf8().constData() );
        % End
// clang-format on
#endif
 
        // clang-format off
        private:
        // clang-format on
 
        double mPosition
        = 0;
    };

    QList< QgsTextFormat::Tab > tabPositions() const;

    void setTabPositions( const QList< QgsTextFormat::Tab > &positions );

    Qgis::RenderUnit tabStopDistanceUnit() const;

    void setTabStopDistanceUnit( Qgis::RenderUnit unit );

    QgsMapUnitScale tabStopDistanceMapUnitScale() const;

    void setTabStopDistanceMapUnitScale( const QgsMapUnitScale &scale );

    Qgis::TextOrientation orientation() const;

    void setOrientation( Qgis::TextOrientation orientation );

    Qgis::Capitalization capitalization() const;

    void setCapitalization( Qgis::Capitalization capitalization );

    bool allowHtmlFormatting() const;

    void setAllowHtmlFormatting( bool allow );

    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 hasNonDefaultCompositionMode() const;

    bool fontFound() const { return mTextFontFound; }

    QString resolvedFontFamily() const { return mTextFontFamily; }

    QgsPropertyCollection &dataDefinedProperties();

    const QgsPropertyCollection &dataDefinedProperties() const SIP_SKIP;

    QSet<QString> referencedFields( const QgsRenderContext &context ) const;

    void setDataDefinedProperties( const QgsPropertyCollection &collection );

    void updateDataDefinedProperties( QgsRenderContext &context );

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

    QString asCSS( double pointToPixelMultiplier = 1.0 ) const;
 
  private:
    QgsTextBufferSettings mBufferSettings;
    QgsTextBackgroundSettings mBackgroundSettings;
    QgsTextShadowSettings mShadowSettings;
    QgsTextMaskSettings mMaskSettings;
 
    QString mTextFontFamily;
    bool mTextFontFound = true;
 
    QSharedDataPointer<QgsTextSettingsPrivate> d;
};
 
Q_DECLARE_METATYPE( QgsTextFormat )
 
#endif // QGSTEXTFORMAT_H