hdi::core::TextTabStopSet::Iterator Class Reference

Allows for iteration through the children of a tab stop set, a la std::vector iteration. More...

#include <hdicoreTextTabStopSet.h>

Public Member Functions
	Iterator (const Iterator &iter_)
	Constructs an Iterator object from an existing Iterator object (copy constructor)
	~Iterator ()
	Destructs an Iterator object.
Iterator &	operator= (const Iterator &iter_)
	Assigns one Iterator object to another.
bool	operator== (const Iterator &iter_) const
	Tests whether a given Iterator object is the same as another.
bool	operator!= (const Iterator &iter_) const
	Tests whether a given Iterator object is not the same as another.
Iterator &	operator++ ()
	Prefix increment operator for forward iteration.
Iterator	operator++ (int)
	Postfix increment operator for forward iteration.
bool	atEnd () const
	Determines whether iteration should stop; works well as the conditional in a for() loop.
std::unique_ptr< TextTabStop >	tabStop () const
	Gets the current paragraph style pointed to by the iterator.

Friends
class	TextTabStopSet

Detailed Description

Allows for iteration through the children of a tab stop set, a la std::vector iteration.

// Here's an example, iterating through the children of someSet:
for(hdi::core::TextTabStopSet::Iterator iter = someSet.begin(); !iter.atEnd(); ++iter)
{
    // do stuff to iter.tabStop()
}

Constructor & Destructor Documentation

Iterator()

hdi::core::TextTabStopSet::Iterator::Iterator

(

const Iterator &

iter_

)

Constructs an Iterator object from an existing Iterator object (copy constructor)

Author

GW

Date

08/2014

Parameters

iter_

Existing Iterator object

~Iterator()

hdi::core::TextTabStopSet::Iterator::~Iterator

(

)

Destructs an Iterator object.

Author

GW

Date

08/2014

Member Function Documentation

atEnd()

bool hdi::core::TextTabStopSet::Iterator::atEnd

(

)

const

Determines whether iteration should stop; works well as the conditional in a for() loop.

Author

GW

Date

08/2014

Returns

true if at the end of the list of tab stops, false otherwise

operator!=()

bool hdi::core::TextTabStopSet::Iterator::operator!=

(

const Iterator &

iter_

)

const

Tests whether a given Iterator object is not the same as another.

Author

GW

Date

08/2014

Parameters

rhs_	Iterator to compare against (righthand side of inequality operator)

Returns

true for the target and rhs_ having differing states, false otherwise

operator++() [1/2]

Iterator & hdi::core::TextTabStopSet::Iterator::operator++

(

)

Prefix increment operator for forward iteration.

Author

GW

Date

08/2014

Returns

A reference to the iterator after its position was changed

operator++() [2/2]

Iterator hdi::core::TextTabStopSet::Iterator::operator++

(

int

)

Postfix increment operator for forward iteration.

Author

GW

Date

08/2014

Returns

A copy of the original iterator before its position was changed

operator=()

Iterator & hdi::core::TextTabStopSet::Iterator::operator=

(

const Iterator &

iter_

)

Assigns one Iterator object to another.

Author

GW

Date

08/2014

Parameters

rhs_	Existing Iterator object to copy values from

Returns

The target Iterator object, but with its values updated to match that of the rhs_ argument

operator==()

bool hdi::core::TextTabStopSet::Iterator::operator==

(

const Iterator &

iter_

)

const

Tests whether a given Iterator object is the same as another.

Author

GW

Date

08/2014

Parameters

rhs_	Iterator to compare against (righthand side of equality operator)

Returns

true for the target and rhs_ having the same state, false otherwise

tabStop()

std::unique_ptr< TextTabStop > hdi::core::TextTabStopSet::Iterator::tabStop

(

)

const

Gets the current paragraph style pointed to by the iterator.

Author

GW

Date

08/2014

Returns

The current style, or an empty TextTabStop object if at the end (see default TextTabStop constructor for more information)