QGIS API Documentation  3.25.0-Master (dec16ba68b)
Public Member Functions | Static Public Member Functions | List of all members
QgsTextDocument Class Reference

Represents a document consisting of one or more QgsTextBlock objects. More...

#include <qgstextdocument.h>

Public Member Functions

 QgsTextDocument ()
 
 QgsTextDocument (const QgsTextBlock &block)
 Constructor for a QgsTextDocument consisting of a single text block. More...
 
 QgsTextDocument (const QgsTextFragment &fragment)
 Constructor for a QgsTextDocument consisting of a single text fragment. More...
 
 ~QgsTextDocument ()
 
void append (const QgsTextBlock &block)
 Appends a block to the document. More...
 
void append (QgsTextBlock &&block)
 Appends a block to the document. More...
 
void applyCapitalization (Qgis::Capitalization capitalization)
 Applies a capitalization style to the document's text. More...
 
const QgsTextBlockat (int index) const
 Returns the block at the specified index. More...
 
QgsTextBlockoperator[] (int index)
 Returns the block at the specified index. More...
 
void reserve (int count)
 Reserves the specified count of blocks for optimised block appending. More...
 
int size () const
 Returns the number of blocks in the document. More...
 
void splitLines (const QString &wrapCharacter, int autoWrapLength=0, bool useMaxLineLengthWhenAutoWrapping=true)
 Splits lines of text in the document to separate lines, using a specified wrap character (wrapCharacter) or newline characters. More...
 
QStringList toPlainText () const
 Returns a list of plain text lines of text representing the document. More...
 

Static Public Member Functions

static QgsTextDocument fromHtml (const QStringList &lines)
 Constructor for QgsTextDocument consisting of a set of HTML formatted lines. More...
 
static QgsTextDocument fromPlainText (const QStringList &lines)
 Constructor for QgsTextDocument consisting of a set of plain text lines. More...
 

Detailed Description

Represents a document consisting of one or more QgsTextBlock objects.

Warning
This API is not considered stable and may change in future QGIS versions.
Since
QGIS 3.14

Definition at line 38 of file qgstextdocument.h.

Constructor & Destructor Documentation

◆ QgsTextDocument() [1/3]

QgsTextDocument::QgsTextDocument ( )
default

◆ ~QgsTextDocument()

QgsTextDocument::~QgsTextDocument ( )
default

◆ QgsTextDocument() [2/3]

QgsTextDocument::QgsTextDocument ( const QgsTextBlock block)
explicit

Constructor for a QgsTextDocument consisting of a single text block.

Definition at line 28 of file qgstextdocument.cpp.

◆ QgsTextDocument() [3/3]

QgsTextDocument::QgsTextDocument ( const QgsTextFragment fragment)
explicit

Constructor for a QgsTextDocument consisting of a single text fragment.

Definition at line 33 of file qgstextdocument.cpp.

Member Function Documentation

◆ append() [1/2]

void QgsTextDocument::append ( const QgsTextBlock block)

Appends a block to the document.

Definition at line 85 of file qgstextdocument.cpp.

◆ append() [2/2]

void QgsTextDocument::append ( QgsTextBlock &&  block)

Appends a block to the document.

Definition at line 90 of file qgstextdocument.cpp.

◆ applyCapitalization()

void QgsTextDocument::applyCapitalization ( Qgis::Capitalization  capitalization)

Applies a capitalization style to the document's text.

Since
QGIS 3.16

Definition at line 190 of file qgstextdocument.cpp.

◆ at()

const QgsTextBlock & QgsTextDocument::at ( int  index) const

Returns the block at the specified index.

Definition at line 100 of file qgstextdocument.cpp.

◆ fromHtml()

QgsTextDocument QgsTextDocument::fromHtml ( const QStringList &  lines)
static

Constructor for QgsTextDocument consisting of a set of HTML formatted lines.

Definition at line 47 of file qgstextdocument.cpp.

◆ fromPlainText()

QgsTextDocument QgsTextDocument::fromPlainText ( const QStringList &  lines)
static

Constructor for QgsTextDocument consisting of a set of plain text lines.

Definition at line 38 of file qgstextdocument.cpp.

◆ operator[]()

QgsTextBlock & QgsTextDocument::operator[] ( int  index)

Returns the block at the specified index.

Definition at line 105 of file qgstextdocument.cpp.

◆ reserve()

void QgsTextDocument::reserve ( int  count)

Reserves the specified count of blocks for optimised block appending.

Definition at line 95 of file qgstextdocument.cpp.

◆ size()

int QgsTextDocument::size ( ) const

Returns the number of blocks in the document.

Definition at line 110 of file qgstextdocument.cpp.

◆ splitLines()

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

Splits lines of text in the document to separate lines, using a specified wrap character (wrapCharacter) or newline characters.

The autoWrapLength argument can be used to specify an ideal length of line to automatically wrap text to (automatic wrapping is disabled if autoWrapLength is 0). This automatic wrapping is performed after processing wrapping using wrapCharacter. When auto wrapping is enabled, the useMaxLineLengthWhenAutoWrapping argument controls whether the lines should be wrapped to an ideal maximum of autoWrapLength characters, or if false then the lines are wrapped to an ideal minimum length of autoWrapLength characters.

Definition at line 131 of file qgstextdocument.cpp.

◆ toPlainText()

QStringList QgsTextDocument::toPlainText ( ) const

Returns a list of plain text lines of text representing the document.

Definition at line 115 of file qgstextdocument.cpp.


The documentation for this class was generated from the following files: