qgstextdocument.h

Go to the documentation of this file.

/***************************************************************************
  qgstextdocument.h
  -----------------
   begin                : May 2020
   copyright            : (C) 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 QGSTEXTDOCUMENT_H
#define QGSTEXTDOCUMENT_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsstringutils.h"
#include "qgstextblock.h"
 
#include <QSizeF>
#include <QVector>
 
class QgsTextFragment;
class QgsTextFormat;

class CORE_EXPORT QgsTextDocument
{
  public:
    QgsTextDocument();
    QgsTextDocument( const QgsTextDocument &other );
    SIP_SKIP QgsTextDocument( QgsTextDocument &&other );
    QgsTextDocument &operator=( const QgsTextDocument &other );
    QgsTextDocument &operator=( QgsTextDocument &&other );
 
    ~QgsTextDocument();

    explicit QgsTextDocument( const QgsTextBlock &block );

    explicit QgsTextDocument( const QgsTextFragment &fragment );

    static QgsTextDocument fromPlainText( const QStringList &lines );

    static QgsTextDocument fromHtml( const QStringList &lines );

    static QgsTextDocument fromTextAndFormat( const QStringList &lines, const QgsTextFormat &format );

    void append( const QgsTextBlock &block );

    void append( QgsTextBlock &&block ) SIP_SKIP;
 
#ifndef SIP_RUN

    void insert( int index, const QgsTextBlock &block );
#else
    // clang-format off

    void insert( int index, const QgsTextBlock &block );
    % MethodCode
    if ( a0 < 0 || a0 > sipCpp->size() )
    {
      PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
      sipIsErr = 1;
    }
    else
    {
      sipCpp->insert( a0, *a1 );
    }
    % End
// clang-format on
#endif

    void insert( int index, QgsTextBlock &&block ) SIP_SKIP;

    void reserve( int count );
 
#ifndef SIP_RUN

    const QgsTextBlock &at( int index ) const SIP_FACTORY;
#else
    // clang-format off

    const QgsTextBlock &at( int index ) const SIP_FACTORY;
    % MethodCode
    if ( a0 < 0 || a0 >= sipCpp->size() )
    {
      PyErr_SetString( PyExc_KeyError, QByteArray::number( a0 ) );
      sipIsErr = 1;
    }
    else
    {
      sipRes = new QgsTextBlock( sipCpp->at( a0 ) );
    }
    % End
// clang-format on
#endif

    QgsTextBlock &operator[]( int index ) SIP_FACTORY;
#ifdef SIP_RUN
    // clang-format off
    % MethodCode
    SIP_SSIZE_T idx = sipConvertFromSequenceIndex( a0, sipCpp->size() );
    if ( idx < 0 )
      sipIsErr = 1;
    else
      sipRes = new QgsTextBlock( sipCpp->operator[]( idx ) );
    % End
// clang-format on
#endif

      int size() const;
 
#ifdef SIP_RUN
    // clang-format off
    int __len__() const;
    % MethodCode
    sipRes = sipCpp->size();
    % End
// clang-format on
#endif

        QStringList toPlainText() const;

    void splitLines( const QString &wrapCharacter, int autoWrapLength = 0, bool useMaxLineLengthWhenAutoWrapping = true );

    QVector< QgsTextDocument > splitBlocksToDocuments() const;

    void applyCapitalization( Qgis::Capitalization capitalization );

    bool hasBackgrounds() const;
 
#ifndef SIP_RUN
    QVector< QgsTextBlock >::const_iterator begin() const;
    QVector< QgsTextBlock >::const_iterator end() const;
#endif
 
  private:
    QVector< QgsTextBlock > mBlocks;
};
 
#endif // QGSTEXTDOCUMENT_H