#include <qgstextblock.h>

Public Member Functions
	QgsTextBlock ()=default
	Constructor for an empty text block. More...

	QgsTextBlock (const QgsTextFragment &fragment)
	Constructor for a QgsTextBlock consisting of a single text fragment. More...

void	append (const QgsTextFragment &fragment)
	Appends a fragment to the block. More...

void	append (QgsTextFragment &&fragment)
	Appends a fragment to the block. More...

const QgsTextFragment &	at (int index) const
	Returns the fragment at the specified index. More...

void	clear ()
	Clears the block, removing all its contents. More...

bool	empty () const
	Returns `true` if the block is empty. More...

QgsTextFragment &	operator[] (int index)
	Returns the fragment at the specified index. More...

int	size () const
	Returns the number of fragments in the block. More...

Detailed Description

Represents a block of text consisting of one or more QgsTextFragment objects.

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

Since: QGIS 3.14

Definition at line 34 of file qgstextblock.h.

Constructor & Destructor Documentation

◆ QgsTextBlock() [1/2]

QgsTextBlock::QgsTextBlock ( )

default

Constructor for an empty text block.

◆ QgsTextBlock() [2/2]

QgsTextBlock::QgsTextBlock ( const QgsTextFragment & fragment )

explicit

Constructor for a QgsTextBlock consisting of a single text fragment.

Definition at line 19 of file qgstextblock.cpp.

Member Function Documentation

◆ append() [1/2]

void QgsTextBlock::append ( const QgsTextFragment & fragment )

Appends a fragment to the block.

Definition at line 24 of file qgstextblock.cpp.

◆ append() [2/2]

void QgsTextBlock::append ( QgsTextFragment && fragment )

Appends a fragment to the block.

Definition at line 29 of file qgstextblock.cpp.

◆ at()

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

Returns the fragment at the specified index.

Definition at line 49 of file qgstextblock.cpp.

◆ clear()

void QgsTextBlock::clear ( )

Clears the block, removing all its contents.

Definition at line 34 of file qgstextblock.cpp.

◆ empty()

bool QgsTextBlock::empty ( ) const

Returns true if the block is empty.

Definition at line 39 of file qgstextblock.cpp.

◆ operator[]()

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

Returns the fragment at the specified index.

Definition at line 54 of file qgstextblock.cpp.

◆ size()

int QgsTextBlock::size ( ) const

Returns the number of fragments in the block.

Definition at line 44 of file qgstextblock.cpp.

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

/build/qgis-3.14.0+99unstable/src/core/textrenderer/qgstextblock.h
/build/qgis-3.14.0+99unstable/src/core/textrenderer/qgstextblock.cpp

Public Member Functions