qgstextdocumentmetrics.h

Go to the documentation of this file.

/***************************************************************************
  qgstextdocumentmetrics.h
  -----------------
   begin                : September 2022
   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 QGSTEXTDOCUMENTMETRICS_H
#define QGSTEXTDOCUMENTMETRICS_H
 
#include "qgis_sip.h"
#include "qgis_core.h"
#include "qgis.h"
#include "qgstextdocument.h"
 
#include <QVector>
#include <QSizeF>
#include <QRectF>
 
class QgsRenderContext;
class QgsTextFormat;
struct DocumentMetrics;
struct BlockMetrics;
 
class CORE_EXPORT QgsTextDocumentRenderContext
{
  public:
 
    Qgis::TextRendererFlags flags() const { return mFlags; }
 
    void setFlags( Qgis::TextRendererFlags flags ) { mFlags = flags; }
 
    double maximumWidth() const { return mMaximumWidth; }
 
    void setMaximumWidth( double width ) { mMaximumWidth = width; }
 
  private:
 
    Qgis::TextRendererFlags mFlags;
    double mMaximumWidth = 0;
 
};
 
class CORE_EXPORT QgsTextDocumentMetrics
{
  public:
 
    static QgsTextDocumentMetrics calculateMetrics( const QgsTextDocument &document, const QgsTextFormat &format, const QgsRenderContext &context, double scaleFactor = 1.0,
        const QgsTextDocumentRenderContext &documentContext = QgsTextDocumentRenderContext() );
 
    bool isNullFontSize() const { return mIsNullSize; }
 
    const QgsTextDocument &document() const { return mDocument; }
 
    QSizeF documentSize( Qgis::TextLayoutMode mode, Qgis::TextOrientation orientation ) const;
 
    QRectF outerBounds( Qgis::TextLayoutMode mode, Qgis::TextOrientation orientation ) const;
 
    double blockWidth( int blockIndex ) const;
 
    double blockHeight( int blockIndex ) const;
 
    double firstLineCapHeight() const;
 
    double baselineOffset( int blockIndex, Qgis::TextLayoutMode mode ) const;
 
    double fragmentHorizontalAdvance( int blockIndex, int fragmentIndex, Qgis::TextLayoutMode mode ) const;
 
    double fragmentVerticalOffset( int blockIndex, int fragmentIndex, Qgis::TextLayoutMode mode ) const;
 
    double fragmentFixedHeight( int blockIndex, int fragmentIndex, Qgis::TextLayoutMode mode ) const;
 
    double fragmentAscent( int blockIndex, int fragmentIndex, Qgis::TextLayoutMode mode ) const;
 
    double fragmentDescent( int blockIndex, int fragmentIndex, Qgis::TextLayoutMode mode ) const;
 
    double verticalOrientationXOffset( int blockIndex ) const;
 
    double blockMaximumCharacterWidth( int blockIndex ) const;
 
    double blockMaximumDescent( int blockIndex ) const;
 
    double blockMaximumAscent( int blockIndex ) const;
 
    QFont fragmentFont( int blockIndex, int fragmentIndex ) const;
 
    double ascentOffset() const { return mFirstLineAscentOffset; }
 
    double blockVerticalMargin( int blockIndex ) const;
 
    double blockLeftMargin( int blockIndex ) const;
 
    double blockRightMargin( int blockIndex ) const;
 
  private:
 
    QgsTextDocument mDocument;
 
    bool mIsNullSize = false;
 
    QSizeF mDocumentSizeLabelMode;
    QSizeF mDocumentSizePointRectMode;
    QSizeF mDocumentSizeVerticalOrientation;
    QSizeF mDocumentSizeCapHeightMode;
    QSizeF mDocumentSizeAscentMode;
 
    QRectF mOuterBoundsLabelMode;
 
    QList < QList< QFont > > mFragmentFonts;
    QList< double > mBlockWidths;
    QList< double > mBlockHeights;
    QList< double > mBaselineOffsetsLabelMode;
    QList< double > mBaselineOffsetsPointMode;
    QList< double > mBaselineOffsetsRectMode;
    QList< double > mBaselineOffsetsCapHeightMode;
    QList< double > mBaselineOffsetsAscentBased;
 
    QList< QList< double > > mFragmentHorizontalAdvance;
    QList< QList< double > > mFragmentFixedHeights;
 
    QList< QList< double > > mFragmentVerticalOffsetsLabelMode;
    QList< QList< double > > mFragmentVerticalOffsetsPointMode;
    QList< QList< double > > mFragmentVerticalOffsetsRectMode;
 
    QList< QList< double > > mFragmentAscent;
    QList< QList< double > > mFragmentDescent;
 
    QList< double > mVerticalOrientationXOffsets;
    QList< double > mBlockMaxDescent;
    QList< double > mBlockMaxAscent;
    QList< double > mBlockMaxCharacterWidth;
    double mFirstLineAscentOffset = 0;
    double mLastLineAscentOffset = 0;
    double mFirstLineCapHeight = 0;
 
    QVector< double > mVerticalMarginsBetweenBlocks;
    QVector< double > mLeftBlockMargins;
    QVector< double > mRightBlockMargins;
 
    static void finalizeBlock( QgsTextDocumentMetrics &res, const QgsTextFormat &format, DocumentMetrics &documentMetrics, QgsTextBlock &outputBlock, BlockMetrics &metrics );
    static void processFragment( QgsTextDocumentMetrics &res, const QgsTextFormat &format, const QgsRenderContext &context, const QgsTextDocumentRenderContext &documentContext, double scaleFactor, DocumentMetrics &documentMetrics, BlockMetrics &thisBlockMetrics, const QFont &font, const QgsTextFragment &fragment, QgsTextBlock &currentOutputBlock );
};
 
#endif // QGSTEXTDOCUMENTMETRICS_H