Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :     qgsannotationpointtextitem.h
       3                 :            :     ----------------
       4                 :            :     begin                : August 2020
       5                 :            :     copyright            : (C) 2020 by Nyall Dawson
       6                 :            :     email                : nyall dot dawson at gmail dot com
       7                 :            :  ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : #ifndef QGSANNOTATIONPOINTTEXTITEM_H
      19                 :            : #define QGSANNOTATIONPOINTTEXTITEM_H
      20                 :            : 
      21                 :            : #include "qgis_core.h"
      22                 :            : #include "qgis_sip.h"
      23                 :            : #include "qgsannotationitem.h"
      24                 :            : #include "qgstextformat.h"
      25                 :            : 
      26                 :            : 
      27                 :            : /**
      28                 :            :  * \ingroup core
      29                 :            :  * \brief An annotation item which renders a text string at a point location.
      30                 :            :  *
      31                 :            :  * \since QGIS 3.16
      32                 :            :  */
      33                 :            : class CORE_EXPORT QgsAnnotationPointTextItem : public QgsAnnotationItem
      34                 :            : {
      35                 :            :   public:
      36                 :            : 
      37                 :            :     /**
      38                 :            :      * Constructor for QgsAnnotationPointTextItem, containing the specified \a text at the specified \a point.
      39                 :            :      */
      40                 :            :     QgsAnnotationPointTextItem( const QString &text, QgsPointXY point );
      41                 :            :     ~QgsAnnotationPointTextItem() override;
      42                 :            : 
      43                 :            :     QString type() const override;
      44                 :            :     void render( QgsRenderContext &context, QgsFeedback *feedback ) override;
      45                 :            :     bool writeXml( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const override;
      46                 :            : 
      47                 :            :     /**
      48                 :            :      * Creates a new text at point annotation item.
      49                 :            :      */
      50                 :            :     static QgsAnnotationPointTextItem *create() SIP_FACTORY;
      51                 :            : 
      52                 :            :     bool readXml( const QDomElement &element, const QgsReadWriteContext &context ) override;
      53                 :            :     QgsAnnotationPointTextItem *clone() override SIP_FACTORY;
      54                 :            :     QgsRectangle boundingBox() const override;
      55                 :            : 
      56                 :            :     /**
      57                 :            :      * Returns the point location of the text.
      58                 :            :      *
      59                 :            :      * The coordinate reference system for the point will be the parent layer's QgsAnnotationLayer::crs().
      60                 :            :      *
      61                 :            :      * \see setPoint()
      62                 :            :      */
      63                 :            :     QgsPointXY point() const { return mPoint; }
      64                 :            : 
      65                 :            :     /**
      66                 :            :      * Sets the \a point location of the text.
      67                 :            :      *
      68                 :            :      * The coordinate reference system for the point will be the parent layer's QgsAnnotationLayer::crs().
      69                 :            :      *
      70                 :            :      * \see point()
      71                 :            :      */
      72                 :            :     void setPoint( QgsPointXY point ) { mPoint = point; }
      73                 :            : 
      74                 :            :     /**
      75                 :            :      * Returns the text rendered by the item.
      76                 :            :      *
      77                 :            :      * \see setText()
      78                 :            :      */
      79                 :            :     QString text() const { return mText; }
      80                 :            : 
      81                 :            :     /**
      82                 :            :      * Sets the \a text rendered by the item.
      83                 :            :      *
      84                 :            :      * \see text()
      85                 :            :      */
      86                 :            :     void setText( const QString &text ) { mText = text; }
      87                 :            : 
      88                 :            :     /**
      89                 :            :      * Returns the text format used to render the text.
      90                 :            :      *
      91                 :            :      * \see setFormat()
      92                 :            :      */
      93                 :            :     QgsTextFormat format() const;
      94                 :            : 
      95                 :            :     /**
      96                 :            :      * Sets the text \a format used to render the text.
      97                 :            :      *
      98                 :            :      * \see format()
      99                 :            :      */
     100                 :            :     void setFormat( const QgsTextFormat &format );
     101                 :            : 
     102                 :            :     /**
     103                 :            :      * Returns the text's rotation angle, in degrees clockwise.
     104                 :            :      *
     105                 :            :      * \see setAngle()
     106                 :            :      */
     107                 :            :     double angle() const { return mAngle; }
     108                 :            : 
     109                 :            :     /**
     110                 :            :      * Sets the text's rotation \a angle, in degrees clockwise.
     111                 :            :      *
     112                 :            :      * \see angle()
     113                 :            :      */
     114                 :          0 :     void setAngle( double angle ) { mAngle = angle; }
     115                 :            : 
     116                 :            :     /**
     117                 :            :      * Returns the text's alignment relative to the reference point().
     118                 :            :      *
     119                 :            :      * \see setAlignment().
     120                 :            :      */
     121                 :            :     Qt::Alignment alignment() const;
     122                 :            : 
     123                 :            :     /**
     124                 :            :      * Sets the text's \a alignment relative to the reference point().
     125                 :            :      *
     126                 :            :      * \see alignment().
     127                 :            :      */
     128                 :            :     void setAlignment( Qt::Alignment alignment );
     129                 :            : 
     130                 :            :   private:
     131                 :            : 
     132                 :            :     QString mText;
     133                 :            :     QgsPointXY mPoint;
     134                 :            :     QgsTextFormat mTextFormat;
     135                 :            :     double mAngle = 0;
     136                 :            :     Qt::Alignment mAlignment = Qt::AlignHCenter;
     137                 :            : 
     138                 :            : #ifdef SIP_RUN
     139                 :            :     QgsAnnotationPointTextItem( const QgsAnnotationPointTextItem &other );
     140                 :            : #endif
     141                 :            : 
     142                 :            : };
     143                 :            : 
     144                 :            : #endif // QGSANNOTATIONPOINTTEXTITEM_H