qgstextcharacterformat.h

Go to the documentation of this file.

/***************************************************************************
  qgstextcharacterformat.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 QGSTEXTCHARACTERFORMAT_H
#define QGSTEXTCHARACTERFORMAT_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QBrush>
#include <QColor>
#include <QFont>
#include <QSizeF>
 
class QTextCharFormat;
class QgsRenderContext;

class CORE_EXPORT QgsTextCharacterFormat
{
  public:
    QgsTextCharacterFormat() = default;

    QgsTextCharacterFormat( const QTextCharFormat &format );

    enum class BooleanValue
    {
      NotSet,   
      SetTrue,  
      SetFalse, 
    };

    void overrideWith( const QgsTextCharacterFormat &other );

    QColor textColor() const;

    void setTextColor( const QColor &textColor );

    double fontPointSize() const;

    void setFontPointSize( double size );

    double fontPercentageSize() const;

    void setFontPercentageSize( double size );

    QString family() const;

    void setFamily( const QString &family );

    int fontWeight() const;

    void setFontWeight( int fontWeight );

    double wordSpacing() const;

    void setWordSpacing( double spacing );

    BooleanValue italic() const;

    void setItalic( BooleanValue enabled );

    BooleanValue strikeOut() const;

    void setStrikeOut( BooleanValue enabled );

    BooleanValue underline() const;

    void setUnderline( BooleanValue enabled );

    BooleanValue overline() const;

    void setOverline( BooleanValue enabled );

    QString imagePath() const;

    void setImagePath( const QString &path );

    QSizeF imageSize() const;

    void setImageSize( const QSizeF &size );

    bool hasVerticalAlignmentSet() const { return mHasVerticalAlignSet; }

    void setHasVerticalAlignmentSet( bool set ) { mHasVerticalAlignSet = set; }

    Qgis::TextCharacterVerticalAlignment verticalAlignment() const { return mVerticalAlign; }

    void setVerticalAlignment( Qgis::TextCharacterVerticalAlignment alignment ) { mVerticalAlign = alignment; }

    bool hasBackground() const;

    QBrush backgroundBrush() const;

    void setBackgroundBrush( const QBrush &brush );

    QString backgroundImagePath() const;

    void setBackgroundImagePath( const QString &path );

    void updateFontForFormat( QFont &font, const QgsRenderContext &context, double scaleFactor = 1.0 ) const;
 
  private:
    QColor mTextColor;
    int mFontWeight = -1;
    QString mStyleName;
    BooleanValue mItalic = BooleanValue::NotSet;
    double mFontPointSize = -1;
    double mFontPercentageSize = -1;
    QString mFontFamily;
    double mWordSpacing = std::numeric_limits< double >::quiet_NaN();
 
    bool mHasVerticalAlignSet = false;
    Qgis::TextCharacterVerticalAlignment mVerticalAlign = Qgis::TextCharacterVerticalAlignment::Normal;
 
    QString mImagePath;
    QSizeF mImageSize;
 
    BooleanValue mStrikethrough = BooleanValue::NotSet;
    BooleanValue mUnderline = BooleanValue::NotSet;
    BooleanValue mOverline = BooleanValue::NotSet;
 
    QBrush mBackgroundBrush;
    QString mBackgroundPath;
};
 
#endif // QGSTEXTCHARACTERFORMAT_H