qgstextlabelfeature.h

Go to the documentation of this file.

/***************************************************************************
    qgstextlabelfeature.h
    ---------------------
    begin                : December 2015
    copyright            : (C) 2015 by Martin Dobias
    email                : wonder dot sk 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 QGSTEXTLABELFEATURE_H
#define QGSTEXTLABELFEATURE_H
 
#define SIP_NO_FILE
 
#include <optional>
 
#include "qgslabelfeature.h"
#include "qgspallabeling.h"
#include "qgstextdocument.h"
#include "qgstextdocumentmetrics.h"
#include "qgstextmetrics.h"
 
class QgsTextCharacterFormat;

class CORE_EXPORT QgsTextLabelFeature : public QgsLabelFeature
{
  public:
    QgsTextLabelFeature( QgsFeatureId id, geos::unique_ptr geometry, QSizeF size );

    ~QgsTextLabelFeature() override;

    QString text( int partId ) const;

    QgsTextCharacterFormat characterFormat( int partId ) const;

    bool hasCharacterFormat( int partId ) const;

    const QMap< QgsPalLayerSettings::Property, QVariant > &dataDefinedValues() const { return mDataDefinedValues; }
    void setDataDefinedValues( const QMap< QgsPalLayerSettings::Property, QVariant > &values ) { mDataDefinedValues = values; }

    void setDefinedFont( const QFont &f ) { mDefinedFont = f; }
    QFont definedFont() const { return mDefinedFont; }

    const QgsPrecalculatedTextMetrics *textMetrics() const { return mTextMetrics.has_value() ? &( *mTextMetrics ) : nullptr; }

    void setTextMetrics( const QgsPrecalculatedTextMetrics &metrics ) { mTextMetrics = metrics; }

    static QgsPrecalculatedTextMetrics calculateTextMetrics( const QgsMapToPixel *xform, const QgsRenderContext &context, const QgsTextFormat &format, const QFont &baseFont, const QFontMetricsF &fontMetrics, double letterSpacing,
        double wordSpacing, const QString &text = QString(), QgsTextDocument *document = nullptr, QgsTextDocumentMetrics *metrics = nullptr );

    const QgsTextDocument &document() const { return mDocument; }

    const QgsTextDocumentMetrics &documentMetrics() const { return mDocumentMetrics; }

    void setDocument( const QgsTextDocument &document, const QgsTextDocumentMetrics &metrics );

    void setMaximumCharacterAngleInside( double angle ) { mMaximumCharacterAngleInside = angle; }

    double maximumCharacterAngleInside() const { return mMaximumCharacterAngleInside; }

    void setMaximumCharacterAngleOutside( double angle ) { mMaximumCharacterAngleOutside = angle; }

    double maximumCharacterAngleOutside() const { return mMaximumCharacterAngleOutside; }
 
  protected:

    QFont mDefinedFont;

    QMap< QgsPalLayerSettings::Property, QVariant > mDataDefinedValues;
 
    QgsTextDocument mDocument;
    QgsTextDocumentMetrics mDocumentMetrics;
 
    double mMaximumCharacterAngleInside = 0;
    double mMaximumCharacterAngleOutside = 0;
 
    std::optional< QgsPrecalculatedTextMetrics > mTextMetrics;
 
};
 
#endif //QGSTEXTLABELFEATURE_H