qgstextblockformat.h

Go to the documentation of this file.

/***************************************************************************
  qgstextblockformat.h
  -----------------
   begin                : September 2024
   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 QGSTEXTBLOCKFORMAT_H
#define QGSTEXTBLOCKFORMAT_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsmargins.h"
 
#include <QBrush>
#include <QColor>
#include <QFont>
 
class QTextBlockFormat;
class QgsRenderContext;

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

    QgsTextBlockFormat( const QTextBlockFormat &format );

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

    void overrideWith( const QgsTextBlockFormat &other );

    bool hasHorizontalAlignmentSet() const { return mHasHorizontalAlignSet; }

    void setHasHorizontalAlignmentSet( bool set ) { mHasHorizontalAlignSet = set; }

    Qgis::TextHorizontalAlignment horizontalAlignment() const { return mHorizontalAlign; }

    void setHorizontalAlignment( Qgis::TextHorizontalAlignment alignment ) { mHorizontalAlign = alignment; }

    double lineHeight() const;

    void setLineHeight( double height );

    double lineHeightPercentage() const;

    void setLineHeightPercentage( double height );

    QgsMargins margins() const { return mMargins; }

    void setMargins( const QgsMargins &margins ) { mMargins = margins; }

    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:
    QBrush mBackgroundBrush;
    QString mBackgroundPath;
 
    double mLineHeight = std::numeric_limits< double >::quiet_NaN();
    double mLineHeightPercentage = std::numeric_limits< double >::quiet_NaN();
 
    bool mHasHorizontalAlignSet = false;
    Qgis::TextHorizontalAlignment mHorizontalAlign = Qgis::TextHorizontalAlignment::Left;
 
    QgsMargins mMargins { std::numeric_limits< double >::quiet_NaN(), std::numeric_limits< double >::quiet_NaN(), std::numeric_limits< double >::quiet_NaN(), std::numeric_limits< double >::quiet_NaN() };
};
 
#endif // QGSTEXTBLOCKFORMAT_H