qgstextmetrics.h

Go to the documentation of this file.

/***************************************************************************
  qgstextmetrics.h
  -----------------
   begin                : April 2021
   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 QGSTEXTMETRICS_H
#define QGSTEXTMETRICS_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgstextcharacterformat.h"
 
#include <QStringList>
#include <QVector>
 
#define SIP_NO_FILE

class CORE_EXPORT QgsPrecalculatedTextMetrics
{
  public:

    QgsPrecalculatedTextMetrics( const QStringList &graphemes,
                                 const QVector< double > &characterWidths,
                                 const QVector< double > &characterHeights,
                                 const QVector< double > &characterDescents )
      : mGraphemes( graphemes )
      , mCharacterHeights( characterHeights )
      , mCharacterWidths( characterWidths )
      , mCharacterDescents( characterDescents )
    {
      Q_ASSERT( mCharacterHeights.size() == mCharacterWidths.size() );
      Q_ASSERT( mCharacterDescents.size() == mCharacterWidths.size() );
 
      if ( !mCharacterHeights.empty() )
      {
        mMaximumCharacterHeight = *std::max_element( mCharacterHeights.constBegin(), mCharacterHeights.constEnd() );
        mMaximumCharacterDescent = *std::max_element( mCharacterDescents.constBegin(), mCharacterDescents.constEnd() );
      }
    }

    int count() const { return static_cast< int >( mCharacterWidths.size() ); }

    double characterWidth( int position ) const
    {
      // caller's responsibility to check!
      // cppcheck-suppress negativeContainerIndex
      return mCharacterWidths[position];
    }

    double characterHeight( int position ) const
    {
      // caller's responsibility to check!
      // cppcheck-suppress negativeContainerIndex
      return mCharacterHeights[position];
    }

    double characterDescent( int position ) const
    {
      // caller's responsibility to check!
      // cppcheck-suppress negativeContainerIndex
      return mCharacterDescents[position];
    }

    double maximumCharacterHeight() const { return mMaximumCharacterHeight; }

    double maximumCharacterDescent() const { return mMaximumCharacterDescent; }

    QStringList graphemes() const { return mGraphemes; }

    QString grapheme( int index ) const { return mGraphemes.at( index ); }

    void setGraphemeFormats( const QVector< QgsTextCharacterFormat > &formats ) { mGraphemeFormats = formats; }

    int graphemeFormatCount() const { return mGraphemeFormats.count(); }

    QgsTextCharacterFormat graphemeFormat( int index ) const { return mGraphemeFormats.value( index ); }
 
  private:
 
    QStringList mGraphemes;
    QVector< QgsTextCharacterFormat > mGraphemeFormats;
    QVector< double > mCharacterHeights;
    QVector< double > mCharacterWidths;
    QVector< double > mCharacterDescents;
    double mMaximumCharacterHeight = 0;
    double mMaximumCharacterDescent = 0;
 
};
 
 
#endif // QGSTEXTMETRICS_H