qgstextfragment.h

Go to the documentation of this file.

/***************************************************************************
  qgstextfragment.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 QGSTEXTFRAGMENT_H
#define QGSTEXTFRAGMENT_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgstextcharacterformat.h"
 
class QTextFragment;

class CORE_EXPORT QgsTextFragment
{
  public:
    explicit QgsTextFragment( const QString &text = QString(), const QgsTextCharacterFormat &format = QgsTextCharacterFormat() );

    explicit QgsTextFragment( const QTextFragment &fragment );

    QString text() const;

    void setText( const QString &text );

    bool isTab() const { return mText == '\t'; }

    bool isWhitespace() const { return isTab() || mText.trimmed().isEmpty(); }

    const QgsTextCharacterFormat &characterFormat() const { return mCharFormat; }

    void setCharacterFormat( const QgsTextCharacterFormat &format );

    bool isImage() const;

    double horizontalAdvance( const QFont &font, const QgsRenderContext &context, bool fontHasBeenUpdatedForFragment = false, double scaleFactor = 1.0 ) const;

    void applyCapitalization( Qgis::Capitalization capitalization );
 
  private:
    QString mText;
    bool mIsImage = false;
    QgsTextCharacterFormat mCharFormat;
};
 
#endif // QGSTEXTFRAGMENT_H