The CharIterator class represents an iterator to a character in a Layout. More...

#include <pdfsdk/cxx/text_edit.h>

Inheritance diagram for PDF::TextEdit::CharIterator:

Public Member Functions
CharIterator	GetBlockBegin () const
	Gets the iterator to the beginning of the current block.

CharIterator	GetBlockEnd () const
	Gets the iterator to the end of the current block.

CharIterator	GetParaBegin () const
	Gets the iterator to the beginning of the current paragraph.

CharIterator	GetParaEnd () const
	Gets the iterator to the end of the current paragraph.

CharIterator	GetLineBegin () const
	Gets the iterator to the beginning of the current line.

CharIterator	GetLineEnd () const
	Gets the iterator to the end of the current line.

CharIterator	GetWordBegin () const
	Gets the iterator to the beginning of the current word.

CharIterator	GetWordEnd () const
	Gets the iterator to the end of the current word.

CharIterator	GetSpanBegin () const
	Gets the iterator to the beginning of the current span.

CharIterator	GetSpanEnd () const
	Gets the iterator to the end of the current span.

CharIterator	GetAbove () const
	Gets the iterator to the character above the current character.

CharIterator	GetAboveAtPage (const Layout &prev_page_text_layout) const
	Gets the iterator to the character above the current character on the previous page.

CharIterator	GetBelow () const
	Gets the iterator to the character below the current character.

CharIterator	GetBelowAtPage (const Layout &next_page_text_layout) const
	Gets the iterator to the character below the current character on the next page.

CharIterator	Copy () const
	Creates a copy of the current iterator.

void	MoveNext ()
	Moves the iterator to the next character.

void	MovePrev ()
	Moves the iterator to the previous character.

void	Move (int n)
	Moves the iterator by the specified number of characters.

int	Distance (const CharIterator &that) const
	Calculates the distance between the current iterator and another iterator.

bool	Less (const CharIterator &that) const
	Checks if the current iterator is less than another iterator.

bool	Equal (const CharIterator &that) const
	Checks if the current iterator is equal to another iterator.

std::wstring	GetUnicodeChar () const
	Gets the Unicode character at the current iterator position.

size_t	GetPageIndex () const
	Gets the page index of the current iterator.

Quad	GetQuad () const
	Gets the quad representing the bounding box of the current character.

Quad	GetOutlineQuad () const
	Gets the quad representing the outline of the current character.

TextBlock	GetTextBlock () const
	Gets the TextBlock containing the current character.

PDTFontAttrs	GetFontAttrs () const
	Gets the font attributes of the current character.

PDTParaAttrs	GetParaAttrs () const
	Gets the paragraph attributes of the current character.

PDTListAttrs	GetListAttrs () const
	Gets the list attributes of the current character.

Matrix	GetTransform () const
	Gets the transformation matrix of the current character.

TextRun	GetTextRun () const
	Gets the TextRun containing the current character.

	CharIterator (PDTCharIterator handle, bool adopt=false) noexcept

	CharIterator (const CharIterator &rhs) noexcept

CharIterator &	operator= (const CharIterator &rhs) noexcept

	CharIterator (CharIterator &&rhs) noexcept

CharIterator &	operator= (CharIterator &&rhs) noexcept

Detailed Description

The CharIterator class represents an iterator to a character in a Layout.

Member Function Documentation

◆ Copy()

CharIterator PDF::TextEdit::CharIterator::Copy ( ) const

inline

Creates a copy of the current iterator.

Returns: The copy of the current iterator.

◆ Distance()

int PDF::TextEdit::CharIterator::Distance ( const CharIterator & that ) const

inline

Calculates the distance between the current iterator and another iterator.

Parameters

that	The other iterator.

Returns: The distance between the current iterator and the other iterator.

◆ Equal()

bool PDF::TextEdit::CharIterator::Equal ( const CharIterator & that ) const

inline

Checks if the current iterator is equal to another iterator.

Parameters

that	The other iterator.

Returns: True if the current iterator is equal to the other iterator, false otherwise.

◆ GetAbove()

CharIterator PDF::TextEdit::CharIterator::GetAbove ( ) const

inline

Gets the iterator to the character above the current character.

Returns: The iterator to the character above the current character.

◆ GetAboveAtPage()

CharIterator PDF::TextEdit::CharIterator::GetAboveAtPage ( const Layout & prev_page_text_layout ) const

inline

Gets the iterator to the character above the current character on the previous page.

Parameters

prev_page_text_layout The Layout object of the previous page.

Returns: The iterator to the character above the current character on the previous page.

◆ GetBelow()

CharIterator PDF::TextEdit::CharIterator::GetBelow ( ) const

inline

Gets the iterator to the character below the current character.

Returns: The iterator to the character below the current character.

◆ GetBelowAtPage()

CharIterator PDF::TextEdit::CharIterator::GetBelowAtPage ( const Layout & next_page_text_layout ) const

inline

Gets the iterator to the character below the current character on the next page.

Parameters

next_page_text_layout The Layout object of the next page.

Returns: The iterator to the character below the current character on the next page.

◆ GetBlockBegin()

CharIterator PDF::TextEdit::CharIterator::GetBlockBegin ( ) const

inline

Gets the iterator to the beginning of the current block.

Returns: The iterator to the beginning of the current block.

◆ GetBlockEnd()

CharIterator PDF::TextEdit::CharIterator::GetBlockEnd ( ) const

inline

Gets the iterator to the end of the current block.

Returns: The iterator to the end of the current block.

◆ GetFontAttrs()

PDTFontAttrs PDF::TextEdit::CharIterator::GetFontAttrs ( ) const

inline

Gets the font attributes of the current character.

Returns: The font attributes of the current character.

◆ GetLineBegin()

CharIterator PDF::TextEdit::CharIterator::GetLineBegin ( ) const

inline

Gets the iterator to the beginning of the current line.

Returns: The iterator to the beginning of the current line.

◆ GetLineEnd()

CharIterator PDF::TextEdit::CharIterator::GetLineEnd ( ) const

inline

Gets the iterator to the end of the current line.

Returns: The iterator to the end of the current line.

◆ GetListAttrs()

PDTListAttrs PDF::TextEdit::CharIterator::GetListAttrs ( ) const

inline

Gets the list attributes of the current character.

Returns: The list attributes of the current character.

◆ GetOutlineQuad()

Quad PDF::TextEdit::CharIterator::GetOutlineQuad ( ) const

inline

Gets the quad representing the outline of the current character.

Returns: The quad representing the outline of the current character.

◆ GetPageIndex()

size_t PDF::TextEdit::CharIterator::GetPageIndex ( ) const

inline

Gets the page index of the current iterator.

Returns: The page index of the current iterator.

◆ GetParaAttrs()

PDTParaAttrs PDF::TextEdit::CharIterator::GetParaAttrs ( ) const

inline

Gets the paragraph attributes of the current character.

Returns: The paragraph attributes of the current character.

◆ GetParaBegin()

CharIterator PDF::TextEdit::CharIterator::GetParaBegin ( ) const

inline

Gets the iterator to the beginning of the current paragraph.

Returns: The iterator to the beginning of the current paragraph.

◆ GetParaEnd()

CharIterator PDF::TextEdit::CharIterator::GetParaEnd ( ) const

inline

Gets the iterator to the end of the current paragraph.

Returns: The iterator to the end of the current paragraph.

◆ GetQuad()

Quad PDF::TextEdit::CharIterator::GetQuad ( ) const

inline

Gets the quad representing the bounding box of the current character.

Returns: The quad representing the bounding box of the current character.

◆ GetSpanBegin()

CharIterator PDF::TextEdit::CharIterator::GetSpanBegin ( ) const

inline

Gets the iterator to the beginning of the current span.

Returns: The iterator to the beginning of the current span.

◆ GetSpanEnd()

CharIterator PDF::TextEdit::CharIterator::GetSpanEnd ( ) const

inline

Gets the iterator to the end of the current span.

Returns: The iterator to the end of the current span.

◆ GetTextBlock()

TextBlock PDF::TextEdit::CharIterator::GetTextBlock ( ) const

inline

Gets the TextBlock containing the current character.

Returns: The TextBlock containing the current character.

◆ GetTextRun()

TextRun PDF::TextEdit::CharIterator::GetTextRun ( ) const

inline

Gets the TextRun containing the current character.

Returns: The TextRun containing the current character.

◆ GetTransform()

Matrix PDF::TextEdit::CharIterator::GetTransform ( ) const

inline

Gets the transformation matrix of the current character.

Returns: The transformation matrix of the current character.

◆ GetUnicodeChar()

std::wstring PDF::TextEdit::CharIterator::GetUnicodeChar ( ) const

inline

Gets the Unicode character at the current iterator position.

Returns: The Unicode character at the current iterator position.

◆ GetWordBegin()

CharIterator PDF::TextEdit::CharIterator::GetWordBegin ( ) const

inline

Gets the iterator to the beginning of the current word.

Returns: The iterator to the beginning of the current word.

◆ GetWordEnd()

CharIterator PDF::TextEdit::CharIterator::GetWordEnd ( ) const

inline

Gets the iterator to the end of the current word.

Returns: The iterator to the end of the current word.

◆ Less()

bool PDF::TextEdit::CharIterator::Less ( const CharIterator & that ) const

inline

Checks if the current iterator is less than another iterator.

Parameters

that	The other iterator.

Returns: True if the current iterator is less than the other iterator, false otherwise.

◆ Move()

void PDF::TextEdit::CharIterator::Move ( int n )

inline

Moves the iterator by the specified number of characters.

Parameters

n	The number of characters to move the iterator.

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

include/pdfsdk/cxx/text_edit.h

PDF SDK Documentation

Public Member Functions

Detailed Description

Member Function Documentation

◆ Copy()

◆ Distance()

◆ Equal()

◆ GetAbove()

◆ GetAboveAtPage()

◆ GetBelow()

◆ GetBelowAtPage()

◆ GetBlockBegin()

◆ GetBlockEnd()

◆ GetFontAttrs()

◆ GetLineBegin()

◆ GetLineEnd()

◆ GetListAttrs()

◆ GetOutlineQuad()

◆ GetPageIndex()

◆ GetParaAttrs()

◆ GetParaBegin()

◆ GetParaEnd()

◆ GetQuad()

◆ GetSpanBegin()

◆ GetSpanEnd()

◆ GetTextBlock()

◆ GetTextRun()

◆ GetTransform()

◆ GetUnicodeChar()

◆ GetWordBegin()

◆ GetWordEnd()

◆ Less()

◆ Move()