pdftron::SDF::DictIterator Class Reference

DictIterator is used to traverse key/value pairs in a dictionary. More...

#include <DictIterator.h>

List of all members.

Public Member Functions

void Next ()
 Advances the iterator to the next element of the collection.
SDF::Obj Key ()
SDF::Obj Value ()
bool HasNext ()
 DictIterator (const DictIterator &c)
 Copy constructor.
DictIteratoroperator= (const DictIterator &other)
 ~DictIterator ()


Detailed Description

DictIterator is used to traverse key/value pairs in a dictionary.

For example a DictIterator can be used to print out all the entries in a given Obj dictionary as follows:

  DictIterator itr = dict.GetDictIterator();
  while (itr.HasNext()) {
      Obj key = itr.Key();
            cout << key.GetName() << endl;
      Obj value = itr.Value();
      // ...
      itr.Next()
   }
 }

Constructor & Destructor Documentation

pdftron::SDF::DictIterator::DictIterator ( const DictIterator c  ) 

Copy constructor.

pdftron::SDF::DictIterator::~DictIterator (  ) 


Member Function Documentation

void pdftron::SDF::DictIterator::Next (  ) 

Advances the iterator to the next element of the collection.

SDF::Obj pdftron::SDF::DictIterator::Key (  ) 

Returns:
the key of the current dictionary entry.

SDF::Obj pdftron::SDF::DictIterator::Value (  ) 

Returns:
the value of the current dictionary entry.

bool pdftron::SDF::DictIterator::HasNext (  ) 

Returns:
true if the iterator can be successfully advanced to the next element; false if the end collection is reached.

DictIterator& pdftron::SDF::DictIterator::operator= ( const DictIterator other  ) 


© 2002-2010 PDFTron Systems Inc.