Hot Door CORE  0.7.0
Adobe® Illustrator® Plug-in Library
Public Member Functions | Friends | List of all members
hdi::core::ai::Dictionary::Iterator Class Reference

Allows for iteration through the members of a dictionary, a la std::vector iteration. More...

#include <hdicoreaiDictionary.h>

Public Member Functions

 Iterator (const Iterator &iter_)
 Constructs an Iterator object from an existing Iterator object (copy constructor) More...
 
 ~Iterator ()
 Destructs an Iterator object. More...
 
Iteratoroperator= (const Iterator &rhs_)
 Assigns one Iterator object to another. More...
 
bool operator== (const Iterator &rhs_) const
 Tests whether a given Iterator object is the same as another. More...
 
bool operator!= (const Iterator &rhs_) const
 Tests whether a given Iterator object is not the same as another. More...
 
Iteratoroperator++ ()
 Prefix increment operator for forward iteration. More...
 
Iterator operator++ (int)
 Postfix increment operator for forward iteration. More...
 
Iteratoroperator-- ()
 Prefix decrement operator for reverse iteration. More...
 
Iterator operator-- (int)
 Postfix decrement operator for reverse iteration. More...
 
bool atEnd () const
 Determines whether iteration should stop; works well as the conditional in a for() loop. More...
 
std::string key () const
 Gets the key for the current entry pointed to by the iterator (or "" if at the end) More...
 
std::auto_ptr< Entryvalue () const
 Gets the current entry pointed to by the iterator. More...
 

Friends

class Dictionary
 

Detailed Description

Allows for iteration through the members of a dictionary, a la std::vector iteration.

// For example:
for(hdi::core::ai::Dictionary::Iterator iter = someDict.begin(); !iter.atEnd(); ++iter)
{
// Do stuff with either iter.key() or iter.value()
}

Constructor & Destructor Documentation

hdi::core::ai::Dictionary::Iterator::Iterator ( const Iterator iter_)

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

Author
GW
Date
10/2013
Parameters
iter_Existing Iterator object
hdi::core::ai::Dictionary::Iterator::~Iterator ( )

Destructs an Iterator object.

Author
GW
Date
08/2013

Member Function Documentation

bool hdi::core::ai::Dictionary::Iterator::atEnd ( ) const

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

Author
GW
Date
08/2013
Returns
true if at the end of the list of members, false otherwise
std::string hdi::core::ai::Dictionary::Iterator::key ( ) const

Gets the key for the current entry pointed to by the iterator (or "" if at the end)

Author
GW
Date
08/2013
Returns
The current key as UTF-8, or "" if at the end
bool hdi::core::ai::Dictionary::Iterator::operator!= ( const Iterator rhs_) const

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

Author
GW
Date
10/2013
Parameters
rhs_Iterator to compare against (righthand side of inequality operator)
Returns
true for the target and rhs_ having differing states, false otherwise
Iterator& hdi::core::ai::Dictionary::Iterator::operator++ ( )

Prefix increment operator for forward iteration.

Author
GW
Date
08/2013
Returns
A reference to the iterator after its position was changed
Iterator hdi::core::ai::Dictionary::Iterator::operator++ ( int  )

Postfix increment operator for forward iteration.

Author
GW
Date
08/2013
Returns
A copy of the original iterator before its position was changed
Iterator& hdi::core::ai::Dictionary::Iterator::operator-- ( )

Prefix decrement operator for reverse iteration.

Author
GW
Date
08/2013
Returns
A reference to the iterator after its position was changed
Iterator hdi::core::ai::Dictionary::Iterator::operator-- ( int  )

Postfix decrement operator for reverse iteration.

Author
GW
Date
08/2013
Returns
A copy of the original iterator before its position was changed
Iterator& hdi::core::ai::Dictionary::Iterator::operator= ( const Iterator rhs_)

Assigns one Iterator object to another.

Author
GW
Date
10/2013
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
bool hdi::core::ai::Dictionary::Iterator::operator== ( const Iterator rhs_) const

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

Author
GW
Date
10/2013
Parameters
rhs_Iterator to compare against (righthand side of equality operator)
Returns
true for the target and rhs_ having the same state, false otherwise
std::auto_ptr<Entry> hdi::core::ai::Dictionary::Iterator::value ( ) const

Gets the current entry pointed to by the iterator.

Author
GW
Date
08/2013
Returns
The current entry, or NULL if at the end