qgsannotationlinetextitem.h

Go to the documentation of this file.

/***************************************************************************
    qgsannotationlinetextitem.h
    ----------------
    begin                : March 2023
    copyright            : (C) 2023 by 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 QGSANNOTATIONLINETEXTITEM_H
#define QGSANNOTATIONLINETEXTITEM_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsannotationitem.h"
#include "qgstextformat.h"
 
class QgsCurve;

class CORE_EXPORT QgsAnnotationLineTextItem : public QgsAnnotationItem
{
  public:
    QgsAnnotationLineTextItem( const QString &text, QgsCurve *curve SIP_TRANSFER );
    ~QgsAnnotationLineTextItem() override;
 
    Qgis::AnnotationItemFlags flags() const override;
    QString type() const override;
    void render( QgsRenderContext &context, QgsFeedback *feedback ) override;
    bool writeXml( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const override;
    QList< QgsAnnotationItemNode > nodesV2( const QgsAnnotationItemEditContext &context ) const override;
    Qgis::AnnotationItemEditOperationResult applyEditV2( QgsAbstractAnnotationItemEditOperation *operation, const QgsAnnotationItemEditContext &context ) override;
    QgsAnnotationItemEditOperationTransientResults *transientEditResultsV2( QgsAbstractAnnotationItemEditOperation *operation, const QgsAnnotationItemEditContext &context ) override SIP_FACTORY;

    static QgsAnnotationLineTextItem *create() SIP_FACTORY;
 
    bool readXml( const QDomElement &element, const QgsReadWriteContext &context ) override;
    QgsRectangle boundingBox() const override;
    QgsRectangle boundingBox( QgsRenderContext &context ) const override;
 
    QgsAnnotationLineTextItem *clone() const override SIP_FACTORY;

    const QgsCurve *geometry() const { return mCurve.get(); }

    void setGeometry( QgsCurve *geometry SIP_TRANSFER );

    QString text() const { return mText; }

    void setText( const QString &text ) { mText = text; }

    QgsTextFormat format() const;

    void setFormat( const QgsTextFormat &format );

    double offsetFromLine() const { return mOffsetFromLineDistance; }

    void setOffsetFromLine( double distance ) { mOffsetFromLineDistance = distance; }

    void setOffsetFromLineUnit( Qgis::RenderUnit unit ) { mOffsetFromLineUnit = unit; }

    Qgis::RenderUnit offsetFromLineUnit() const { return mOffsetFromLineUnit; }

    void setOffsetFromLineMapUnitScale( const QgsMapUnitScale &scale ) { mOffsetFromLineScale = scale; }

    const QgsMapUnitScale &offsetFromLineMapUnitScale() const { return mOffsetFromLineScale; }
 
  private:
    QString mText;
    std::unique_ptr< QgsCurve > mCurve;
    QgsTextFormat mTextFormat;
 
    double mOffsetFromLineDistance = 0;
    Qgis::RenderUnit mOffsetFromLineUnit = Qgis::RenderUnit::Millimeters;
    QgsMapUnitScale mOffsetFromLineScale;
 
#ifdef SIP_RUN
    QgsAnnotationLineTextItem( const QgsAnnotationLineTextItem &other );
#endif
};
 
#endif // QGSANNOTATIONLINETEXTITEM_H