Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                               qgstextannotation.h
       3                 :            :                               -------------------
       4                 :            :   begin                : February 9, 2010
       5                 :            :   copyright            : (C) 2010 by Marco Hugentobler
       6                 :            :   email                : marco dot hugentobler at hugis dot net
       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 QGSTEXTANNOTATION_H
      19                 :            : #define QGSTEXTANNOTATION_H
      20                 :            : 
      21                 :            : #include "qgsannotation.h"
      22                 :            : #include <QTextDocument>
      23                 :            : #include "qgis_core.h"
      24                 :            : 
      25                 :            : /**
      26                 :            :  * \class QgsTextAnnotation
      27                 :            :  * \ingroup core
      28                 :            :  * \brief An annotation item that displays formatted text from a QTextDocument document.
      29                 :            :  * \since QGIS 3.0
      30                 :            : */
      31                 :            : class CORE_EXPORT QgsTextAnnotation: public QgsAnnotation
      32                 :            : {
      33                 :            :     Q_OBJECT
      34                 :            : 
      35                 :            :   public:
      36                 :            : 
      37                 :            :     /**
      38                 :            :      * Constructor for QgsTextAnnotation.
      39                 :            :      */
      40                 :            :     QgsTextAnnotation( QObject *parent SIP_TRANSFERTHIS = nullptr );
      41                 :            : 
      42                 :            :     QgsTextAnnotation *clone() const override SIP_FACTORY;
      43                 :            : 
      44                 :            :     /**
      45                 :            :      * Returns the text document which will be rendered
      46                 :            :      * within the annotation.
      47                 :            :      * \see setDocument()
      48                 :            :      */
      49                 :            :     const QTextDocument *document() const;
      50                 :            : 
      51                 :            :     /**
      52                 :            :      * Sets the text document which will be rendered
      53                 :            :      * within the annotation. Ownership is not transferred.
      54                 :            :      * \see document()
      55                 :            :      */
      56                 :            :     void setDocument( const QTextDocument *doc );
      57                 :            : 
      58                 :            :     void writeXml( QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context ) const override;
      59                 :            :     void readXml( const QDomElement &itemElem, const QgsReadWriteContext &context ) override;
      60                 :            : 
      61                 :            :     /**
      62                 :            :      * Returns a new QgsTextAnnotation object.
      63                 :            :      */
      64                 :          0 :     static QgsTextAnnotation *create() SIP_FACTORY { return new QgsTextAnnotation(); }
      65                 :            : 
      66                 :            :   protected:
      67                 :            : 
      68                 :            :     void renderAnnotation( QgsRenderContext &context, QSizeF size ) const override;
      69                 :            : 
      70                 :            :   private:
      71                 :            :     std::unique_ptr< QTextDocument > mDocument;
      72                 :            : };
      73                 :            : 
      74                 :            : #endif // QGSTEXTANNOTATION_H