qgstextannotation.cpp

Go to the documentation of this file.

/***************************************************************************
                          qgstextannotation.cpp
                          ------------------------
begin                : February 9, 2010
copyright            : (C) 2010 by Marco Hugentobler
email                : marco dot hugentobler at hugis dot net
***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/
 
#include "qgstextannotation.h"
 
#include <memory>
 
#include "qgspainting.h"
#include "qgsrendercontext.h"
 
#include <QDomDocument>
#include <QPainter>
#include <QString>
 
#include "moc_qgstextannotation.cpp"
 
using namespace Qt::StringLiterals;
 
QgsTextAnnotation::QgsTextAnnotation( QObject *parent )
  : QgsAnnotation( parent )
  , mDocument( new QTextDocument( QString() ) )
{
  mDocument->setUseDesignMetrics( true );
}
 
QgsTextAnnotation *QgsTextAnnotation::clone() const
{
  auto c = std::make_unique<QgsTextAnnotation>();
  copyCommonProperties( c.get() );
  c->setDocument( mDocument.get() );
  return c.release();
}
 
const QTextDocument *QgsTextAnnotation::document() const
{
  return mDocument.get();
}
 
void QgsTextAnnotation::setDocument( const QTextDocument *doc )
{
  if ( doc )
    mDocument.reset( doc->clone() );
  else
    mDocument.reset();
  emit appearanceChanged();
}
 
void QgsTextAnnotation::renderAnnotation( QgsRenderContext &context, QSizeF size ) const
{
  QPainter *painter = context.painter();
  if ( !mDocument || !painter || ( context.feedback() && context.feedback()->isCanceled() ) )
  {
    return;
  }
 
  // scale painter back to 96 dpi, so layout prints match screen rendering
  const QgsScopedQPainterState painterState( context.painter() );
  const double scaleFactor = context.painter()->device()->logicalDpiX() / 96.0;
  context.painter()->scale( scaleFactor, scaleFactor );
  size /= scaleFactor;
 
  mDocument->setTextWidth( size.width() );
 
  QRectF clipRect = QRectF( 0, 0, size.width(), size.height() );
  if ( painter->hasClipping() )
  {
    //QTextDocument::drawContents will draw text outside of the painter's clip region
    //when it is passed a clip rectangle. So, we need to intersect it with the
    //painter's clip region to prevent text drawn outside clipped region (e.g., outside layout maps, see #10400)
    clipRect = clipRect.intersected( painter->clipRegion().boundingRect() );
  }
  //draw text document
  mDocument->drawContents( painter, clipRect );
}
 
void QgsTextAnnotation::writeXml( QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context ) const
{
  QDomElement annotationElem = doc.createElement( u"TextAnnotationItem"_s );
  if ( mDocument )
  {
    annotationElem.setAttribute( u"document"_s, mDocument->toHtml() );
  }
  _writeXml( annotationElem, doc, context );
  elem.appendChild( annotationElem );
}
 
void QgsTextAnnotation::readXml( const QDomElement &itemElem, const QgsReadWriteContext &context )
{
  mDocument = std::make_unique<QTextDocument>();
  mDocument->setHtml( itemElem.attribute( u"document"_s, QString() ) );
  const QDomElement annotationElem = itemElem.firstChildElement( u"AnnotationItem"_s );
  if ( !annotationElem.isNull() )
  {
    _readXml( annotationElem, context );
  }
}