PDF::TextEdit::TextBlock Class Reference

The TextBlock class represents a block of text in a Layout. More...

#include <pdfsdk/cxx/text_edit.h>

Inheritance diagram for PDF::TextEdit::TextBlock:

Public Member Functions
bool	Equals (const TextBlock &that) const
	Checks if the current TextBlock is equal to another TextBlock.
PointF	GetPosition () const
	Gets the position of the TextBlock.
SizeF	GetSize () const
	Gets the size of the TextBlock.
float	GetRotation () const
	Gets the rotation angle of the TextBlock.
bool	IsReflected () const
	Checks if the TextBlock is reflected.
RectF	GetBBox () const
	Gets the bounding box of the TextBlock.
CharIterator	GetCharBegin (const Layout &text_layout) const
	Gets an iterator to the beginning of the characters in the TextBlock.
CharIterator	GetCharEnd (const Layout &text_layout) const
	Gets an iterator to the end of the characters in the TextBlock.
CharIterator	GetCharByIndex (const Layout &text_layout, size_t char_index) const
	Gets an iterator to the character at the specified index in the TextBlock.
Element	CreateTextElement () const
	Creates a TextElement from the TextBlock.
bool	IsExplicitWidth () const
	Checks if the TextBlock has an explicit width.
void	SetExplicitWidth (bool value)
	Sets whether the TextBlock has an explicit width.
	TextBlock (PDTTextBlock handle, bool adopt=false) noexcept
	TextBlock (const TextBlock &rhs) noexcept
TextBlock &	operator= (const TextBlock &rhs) noexcept
	TextBlock (TextBlock &&rhs) noexcept
TextBlock &	operator= (TextBlock &&rhs) noexcept

Detailed Description

The TextBlock class represents a block of text in a Layout.

Member Function Documentation

CreateTextElement()

Element PDF::TextEdit::TextBlock::CreateTextElement ( ) const

inline

Creates a TextElement from the TextBlock.

Returns

The created TextElement.

Equals()

bool PDF::TextEdit::TextBlock::Equals ( const TextBlock & that ) const

inline

Checks if the current TextBlock is equal to another TextBlock.

Parameters

that	The TextBlock to compare with.

Returns

True if the TextBlocks are equal, false otherwise.

GetBBox()

RectF PDF::TextEdit::TextBlock::GetBBox ( ) const

inline

Gets the bounding box of the TextBlock.

Returns

The bounding box of the TextBlock.

GetCharBegin()

CharIterator PDF::TextEdit::TextBlock::GetCharBegin ( const Layout & text_layout ) const

inline

Gets an iterator to the beginning of the characters in the TextBlock.

Parameters

text_layout

The Layout object containing the TextBlock.

Returns

The iterator to the beginning of the characters in the TextBlock.

GetCharByIndex()

CharIterator PDF::TextEdit::TextBlock::GetCharByIndex ( const Layout & text_layout, size_t char_index ) const

inline

Gets an iterator to the character at the specified index in the TextBlock.

Parameters

text_layout	The Layout object containing the TextBlock.
char_index	The index of the character to retrieve.

Returns

The iterator to the character at the specified index.

GetCharEnd()

CharIterator PDF::TextEdit::TextBlock::GetCharEnd ( const Layout & text_layout ) const

inline

Gets an iterator to the end of the characters in the TextBlock.

Parameters

text_layout

The Layout object containing the TextBlock.

Returns

The iterator to the end of the characters in the TextBlock.

GetPosition()

PointF PDF::TextEdit::TextBlock::GetPosition ( ) const

inline

Gets the position of the TextBlock.

Returns

The position of the TextBlock.

GetRotation()

float PDF::TextEdit::TextBlock::GetRotation ( ) const

inline

Gets the rotation angle of the TextBlock.

Returns

The rotation angle of the TextBlock.

GetSize()

SizeF PDF::TextEdit::TextBlock::GetSize ( ) const

inline

Gets the size of the TextBlock.

Returns

The size of the TextBlock.

IsExplicitWidth()

bool PDF::TextEdit::TextBlock::IsExplicitWidth ( ) const

inline

Checks if the TextBlock has an explicit width.

Returns

True if the TextBlock has an explicit width, false otherwise.

IsReflected()

bool PDF::TextEdit::TextBlock::IsReflected ( ) const

inline

Checks if the TextBlock is reflected.

Returns

True if the TextBlock is reflected, false otherwise.

SetExplicitWidth()

void PDF::TextEdit::TextBlock::SetExplicitWidth ( bool value )

inline

Sets whether the TextBlock has an explicit width.

Parameters

value

The value indicating whether the TextBlock has an explicit width.

---

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

• include/pdfsdk/cxx/text_edit.h