qgsannotationrectangletextitem.h

Go to the documentation of this file.

/***************************************************************************
    qgsannotationrectangletextitem.h
    ----------------
    begin                : July 2024
    copyright            : (C) 2024 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 QGSANNOTATIONRECTANGLETEXTITEM_H
#define QGSANNOTATIONRECTANGLETEXTITEM_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsannotationrectitem.h"
#include "qgsmargins.h"
#include "qgstextformat.h"

class CORE_EXPORT QgsAnnotationRectangleTextItem : public QgsAnnotationRectItem
{
  public:

    QgsAnnotationRectangleTextItem( const QString &text, const QgsRectangle &bounds );
    ~QgsAnnotationRectangleTextItem() override;
 
    QString type() const override;
    Qgis::AnnotationItemFlags flags() const override;
    bool writeXml( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const override;

    static QgsAnnotationRectangleTextItem *create() SIP_FACTORY;
 
    bool readXml( const QDomElement &element, const QgsReadWriteContext &context ) override;
    QgsAnnotationRectangleTextItem *clone() const override SIP_FACTORY;

    QString text() const { return mText; }

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

    QgsTextFormat format() const;

    void setFormat( const QgsTextFormat &format );

    Qt::Alignment alignment() const;

    void setAlignment( Qt::Alignment alignment );

    const QgsMargins &margins() const { return mMargins; }

    void setMargins( const QgsMargins &margins ) { mMargins = margins; }

    void setMarginsUnit( Qgis::RenderUnit unit ) { mMarginUnit = unit; }

    Qgis::RenderUnit marginsUnit() const { return mMarginUnit; }
 
  protected:
 
    void renderInBounds( QgsRenderContext &context, const QRectF &painterBounds, QgsFeedback *feedback ) override;
 
  private:
 
    QString mText;
    QgsTextFormat mTextFormat;
    Qt::Alignment mAlignment = Qt::AlignLeft;
 
    QgsMargins mMargins;
    Qgis::RenderUnit mMarginUnit = Qgis::RenderUnit::Millimeters;
 
#ifdef SIP_RUN
    QgsAnnotationRectangleTextItem( const QgsAnnotationRectangleTextItem &other );
#endif
 
};
#endif // QGSANNOTATIONRECTANGLETEXTITEM_H