XMLContentIterator Class Reference

#include <XMLContentIterator.h>

Public Types
typedef InDesign::TextRange	value_type
typedef std::ptrdiff_t	difference_type
typedef const value_type *	pointer
typedef const value_type &	reference
typedef std::bidirectional_iterator_tag	iterator_category

Public Member Functions
	XMLContentIterator ()
	XMLContentIterator (const XMLContentIterator &)
	XMLContentIterator (const IIDXMLElement *element, int32 position)
	~XMLContentIterator ()
const InDesign::TextRange &	operator* () const
const InDesign::TextRange *	operator-> () const
XMLContentIterator &	operator= (const XMLContentIterator &rhs)
XMLContentIterator &	operator++ ()
XMLContentIterator	operator++ (int)
XMLContentIterator &	operator-- ()
XMLContentIterator	operator-- (int)
XMLContentIterator &	operator+= (int32 n)
XMLContentIterator	operator+ (int32 n) const
XMLContentIterator &	operator-= (int32 n)
XMLContentIterator	operator- (int32 n) const
int32	Position () const
bool16	IsValid () const

Friends
class	const_iterator
XMLContentIterator	operator+ (int32 n, const XMLContentIterator &rhs)
bool	operator== (const XMLContentIterator &x, const XMLContentIterator &y)
bool	operator!= (const XMLContentIterator &x, const XMLContentIterator &y)
bool	operator< (const XMLContentIterator &x, const XMLContentIterator &y)
bool	operator<= (const XMLContentIterator &x, const XMLContentIterator &y)
bool	operator> (const XMLContentIterator &x, const XMLContentIterator &y)
bool	operator>= (const XMLContentIterator &x, const XMLContentIterator &y)

Detailed Description

XMLContentIterator iterates over the content of an element and returns ranges of content in the same order as the DOM would return content. Text ranges are specified using the TextRange class. These can in turn be used to create TextIterators for iterating over the individual characters of the content. The constructors for this class are intended to be created with the factory methods begin and end of XMLElement.

Constructor & Destructor Documentation

XMLContentIterator::XMLContentIterator

(

)

Default constructor

Returns

XMLContentIterator::XMLContentIterator

(

const XMLContentIterator &

)

Copy constructor

XMLContentIterator::XMLContentIterator	(	const IIDXMLElement *	element,
		int32	position
	)

Constructor

Parameters

element
position

XMLContentIterator::~XMLContentIterator

(

)

Destructor

Member Function Documentation

bool16 XMLContentIterator::IsValid ( ) const

inline

Dereference operator for given Position

Parameters

i	specifies Position of intereset

Returns

TextRange marked up by given child element Accessor for valid state of this

whether this is valid

const InDesign::TextRange& XMLContentIterator::operator* ( ) const

inline

Pointer dereference operator

Returns

current TextRange

XMLContentIterator XMLContentIterator::operator+ ( int32  n ) const

inline

Addition operator

Parameters

n

Returns

iterator adjusted appropriately

XMLContentIterator& XMLContentIterator::operator++

(

)

Increment operator

Returns

adjusted iterator

XMLContentIterator XMLContentIterator::operator++ ( int  )

inline

Increment by specified amount

Returns

XMLContentIterator operator

XMLContentIterator& XMLContentIterator::operator+=

(

int32

n

)

Addition-assignment operator

Parameters

n	specifies number of positions to move iterator Position

Returns

iterator adjusted appropriately

XMLContentIterator XMLContentIterator::operator- ( int32  n ) const

inline

Substraction operator

Parameters

n

Returns

iterator adjusted appropriately

XMLContentIterator& XMLContentIterator::operator--

(

)

Operator decrement

Returns

adjusted iterator

XMLContentIterator XMLContentIterator::operator-- ( int  )

inline

Operator decrement by specified amount

Returns

adjusted iterator

XMLContentIterator& XMLContentIterator::operator-=

(

int32

n

)

Subtraction-assignment operator

Parameters

n

Returns

iterator adjusted appropriately

const InDesign::TextRange* XMLContentIterator::operator-> ( ) const

inline

Member selection operator or 'smart pointer'

Returns

ptr to current TextRange

XMLContentIterator& XMLContentIterator::operator=

(

const XMLContentIterator &

rhs

)

Assignment

Parameters

rhs	object to copy state from

Returns

result of assignment

int32 XMLContentIterator::Position ( ) const

inline

Accessor for location iterator starts from

Returns

current location of iterator