An iterator for iterating over the characters in a PageText object. More...

#include <pdfsdk/cxx/page_text.h>

Public Types
using	iterator_category = std::input_iterator_tag

using	value_type = PageTextChar

using	difference_type = int32_t

using	pointer = PageTextChar*

using	reference = PageTextChar&

Public Member Functions
	PageTextIterator ()
	Default constructor.

	PageTextIterator (const PageText &pagetext, size_t charindex=0)
	Constructor with PageText and character index.

	PageTextIterator (const PageTextIterator &rhs)
	Copy constructor.

PageTextIterator &	Advance (int offset)
	Advance the iterator by the specified offset.

PageTextIterator &	Next ()
	Move the iterator to the next character.

PageTextIterator &	Prev ()
	Move the iterator to the previous character.

PageTextIterator &	operator= (const PageTextIterator &rhs)
	Assignment operator.

PageTextIterator &	operator++ ()
	Pre-increment operator.

PageTextIterator	operator++ (int)
	Post-increment operator.

PageTextIterator &	operator-- ()
	Pre-decrement operator.

PageTextIterator	operator-- (int)
	Post-decrement operator.

PageTextIterator &	operator+= (difference_type offset)
	Addition assignment operator.

PageTextIterator	operator+ (difference_type offset) const
	Addition operator.

PageTextIterator &	operator-= (difference_type offset)
	Subtraction assignment operator.

PageTextIterator	operator- (difference_type offset) const
	Subtraction operator.

bool	Equals (const PageTextIterator &rhs) const
	Equality comparison.

bool	operator== (const PageTextIterator &rhs) const
	Equality operator.

bool	operator!= (const PageTextIterator &rhs) const
	Inequality operator.

bool	LessThen (const PageTextIterator &rhs) const
	Less than comparison.

bool	operator< (const PageTextIterator &rhs) const
	Less than operator.

bool	operator<= (const PageTextIterator &rhs) const
	Less than or equal to operator.

bool	operator> (const PageTextIterator &rhs) const
	Greater than operator.

bool	operator>= (const PageTextIterator &rhs) const
	Greater than or equal to operator.

PageTextIterator	begin () const
	Get the beginning iterator.

PageTextIterator	end () const
	Get the ending iterator.

PageText	GetPageText () const
	Get the PageText object.

size_t	GetCharIndex () const
	Get the character index.

PageTextChar	GetChar () const
	Get the character at the current iterator position.

PageTextChar	operator* () const

Detailed Description

An iterator for iterating over the characters in a PageText object.

Constructor & Destructor Documentation

◆ PageTextIterator() [1/2]

PDF::PageTextIterator::PageTextIterator	(	const PageText &	pagetext,
		size_t	charindex = 0 )

inline

Constructor with PageText and character index.

Parameters

pagetext	The PageText object.
charindex	The character index. Default is 0.

◆ PageTextIterator() [2/2]

PDF::PageTextIterator::PageTextIterator ( const PageTextIterator & rhs )

inline

Copy constructor.

Parameters

rhs	The PageTextIterator to copy from.

Member Function Documentation

◆ Advance()

PageTextIterator & PDF::PageTextIterator::Advance ( int offset )

inline

Advance the iterator by the specified offset.

Parameters

offset The offset to advance the iterator by.

Returns: A reference to the advanced PageTextIterator.

◆ begin()

PageTextIterator PDF::PageTextIterator::begin ( ) const

inline

Get the beginning iterator.

Returns: A new PageTextIterator at the beginning.

◆ end()

PageTextIterator PDF::PageTextIterator::end ( ) const

inline

Get the ending iterator.

Returns: A new PageTextIterator at the end.

◆ Equals()

bool PDF::PageTextIterator::Equals ( const PageTextIterator & rhs ) const

inline

Equality comparison.

Parameters

rhs	The PageTextIterator to compare with.

Returns: True if the iterators are equal, false otherwise.

◆ GetChar()

PageTextChar PDF::PageTextIterator::GetChar ( ) const

inline

Get the character at the current iterator position.

Returns: The character at the current iterator position.

◆ GetCharIndex()

size_t PDF::PageTextIterator::GetCharIndex ( ) const

inline

Get the character index.

Returns: The character index.

◆ GetPageText()

PageText PDF::PageTextIterator::GetPageText ( ) const

inline

Get the PageText object.

Returns: The PageText object.

◆ LessThen()

bool PDF::PageTextIterator::LessThen ( const PageTextIterator & rhs ) const

inline

Less than comparison.

Parameters

rhs	The PageTextIterator to compare with.

Returns: True if this iterator is less than the rhs iterator, false otherwise.

◆ Next()

PageTextIterator & PDF::PageTextIterator::Next ( )

inline

Move the iterator to the next character.

Returns: A reference to the next PageTextIterator.

◆ operator!=()

bool PDF::PageTextIterator::operator!= ( const PageTextIterator & rhs ) const

inline

Inequality operator.

Parameters

rhs	The PageTextIterator to compare with.

Returns: True if the iterators are not equal, false otherwise.

◆ operator+()

PageTextIterator PDF::PageTextIterator::operator+ ( difference_type offset ) const

inline

Addition operator.

Parameters

offset The offset to add.

Returns: A new PageTextIterator with the added offset.

◆ operator++() [1/2]

PageTextIterator & PDF::PageTextIterator::operator++ ( )

inline

Pre-increment operator.

Returns: A reference to the incremented PageTextIterator.

◆ operator++() [2/2]

PageTextIterator PDF::PageTextIterator::operator++ ( int )

inline

Post-increment operator.

Returns: A copy of the original PageTextIterator.

◆ operator+=()

PageTextIterator & PDF::PageTextIterator::operator+= ( difference_type offset )

inline

Addition assignment operator.

Parameters

offset The offset to add.

Returns: A reference to the modified PageTextIterator.

◆ operator-()

PageTextIterator PDF::PageTextIterator::operator- ( difference_type offset ) const

inline

Subtraction operator.

Parameters

offset The offset to subtract.

Returns: A new PageTextIterator with the subtracted offset.

◆ operator--() [1/2]

PageTextIterator & PDF::PageTextIterator::operator-- ( )

inline

Pre-decrement operator.

Returns: A reference to the decremented PageTextIterator.

◆ operator--() [2/2]

PageTextIterator PDF::PageTextIterator::operator-- ( int )

inline

Post-decrement operator.

Returns: A copy of the original PageTextIterator.

◆ operator-=()

PageTextIterator & PDF::PageTextIterator::operator-= ( difference_type offset )

inline

Subtraction assignment operator.

Parameters

offset The offset to subtract.

Returns: A reference to the modified PageTextIterator.

◆ operator<()

bool PDF::PageTextIterator::operator< ( const PageTextIterator & rhs ) const

inline

Less than operator.

Parameters

rhs	The PageTextIterator to compare with.

Returns: True if this iterator is less than the rhs iterator, false otherwise.

◆ operator<=()

bool PDF::PageTextIterator::operator<= ( const PageTextIterator & rhs ) const

inline

Less than or equal to operator.

Parameters

rhs	The PageTextIterator to compare with.

Returns: True if this iterator is less than or equal to the rhs iterator, false otherwise.

◆ operator=()

PageTextIterator & PDF::PageTextIterator::operator= ( const PageTextIterator & rhs )

inline

Assignment operator.

Parameters

rhs	The PageTextIterator to assign from.

Returns: A reference to the assigned PageTextIterator.

◆ operator==()

bool PDF::PageTextIterator::operator== ( const PageTextIterator & rhs ) const

inline

Equality operator.

Parameters

rhs	The PageTextIterator to compare with.

Returns: True if the iterators are equal, false otherwise.

◆ operator>()

bool PDF::PageTextIterator::operator> ( const PageTextIterator & rhs ) const

inline

Greater than operator.

Parameters

rhs	The PageTextIterator to compare with.

Returns: True if this iterator is greater than the rhs iterator, false otherwise.

◆ operator>=()

bool PDF::PageTextIterator::operator>= ( const PageTextIterator & rhs ) const

inline

Greater than or equal to operator.

Parameters

rhs	The PageTextIterator to compare with.

Returns: True if this iterator is greater than or equal to the rhs iterator, false otherwise.

◆ Prev()

PageTextIterator & PDF::PageTextIterator::Prev ( )

inline

Move the iterator to the previous character.

Returns: A reference to the previous PageTextIterator.

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

include/pdfsdk/cxx/page_text.h

PDF SDK Documentation

Public Types

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ PageTextIterator() [1/2]

◆ PageTextIterator() [2/2]

Member Function Documentation

◆ Advance()

◆ begin()

◆ end()

◆ Equals()

◆ GetChar()

◆ GetCharIndex()

◆ GetPageText()

◆ LessThen()

◆ Next()

◆ operator!=()

◆ operator+()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator+=()

◆ operator-()

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ operator-=()

◆ operator<()

◆ operator<=()

◆ operator=()

◆ operator==()

◆ operator>()

◆ operator>=()

◆ Prev()