HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
UT_JSONValue::traverser Class Reference

Traverse the children of the current value. More...

#include <UT_JSONValue.h>

Public Member Functions

 traverser ()
 
 traverser (const traverser &src)
 
 ~traverser ()
 
const traverseroperator= (const traverser &src)
 
traverseroperator++ ()
 ++iterator More...
 
bool atEnd () const
 No post increment as it is harmful. More...
 
void advance ()
 
UT_JSONValuegetValue ()
 
bool getKey (UT_String &key)
 Deprecated in favour of UT_StringHolder method. More...
 
bool getLowerCaseKey (UT_String &key)
 Deprecated in favour of UT_StringHolder method. More...
 
bool getKey (UT_StringHolder &key)
 
bool getLowerCaseKey (UT_StringHolder &key)
 Get a lower case map key (for case insensitive maps) More...
 

Friends

class UT_JSONValue
 

Detailed Description

Traverse the children of the current value.

This class will iterate over all items in this value, whether they are in the form of an array or a map. For values with neither, it will return the current value itself. Note that the getKey() function is only available when this value is a map.

Example:

for (it = value.beginTraversal(); !it.atEnd(); ++it)

Definition at line 332 of file UT_JSONValue.h.

Constructor & Destructor Documentation

UT_JSONValue::traverser::traverser ( )
inline

Definition at line 335 of file UT_JSONValue.h.

UT_JSONValue::traverser::traverser ( const traverser src)
inline

Definition at line 341 of file UT_JSONValue.h.

UT_JSONValue::traverser::~traverser ( )
inline

Definition at line 345 of file UT_JSONValue.h.

Member Function Documentation

void UT_JSONValue::traverser::advance ( )
inline

Definition at line 363 of file UT_JSONValue.h.

bool UT_JSONValue::traverser::atEnd ( ) const
inline

No post increment as it is harmful.

Definition at line 362 of file UT_JSONValue.h.

bool UT_JSONValue::traverser::getKey ( UT_String key)
inline

Deprecated in favour of UT_StringHolder method.

Definition at line 404 of file UT_JSONValue.h.

bool UT_JSONValue::traverser::getKey ( UT_StringHolder key)
inline

Definition at line 422 of file UT_JSONValue.h.

bool UT_JSONValue::traverser::getLowerCaseKey ( UT_String key)
inline

Deprecated in favour of UT_StringHolder method.

Definition at line 413 of file UT_JSONValue.h.

bool UT_JSONValue::traverser::getLowerCaseKey ( UT_StringHolder key)
inline

Get a lower case map key (for case insensitive maps)

Definition at line 444 of file UT_JSONValue.h.

UT_JSONValue* UT_JSONValue::traverser::getValue ( )
inline

Returns the child value which corresponds to the current traversal position.

Definition at line 389 of file UT_JSONValue.h.

traverser& UT_JSONValue::traverser::operator++ ( )
inline

++iterator

Definition at line 359 of file UT_JSONValue.h.

const traverser& UT_JSONValue::traverser::operator= ( const traverser src)
inline

Definition at line 347 of file UT_JSONValue.h.

Friends And Related Function Documentation

friend class UT_JSONValue
friend

Definition at line 493 of file UT_JSONValue.h.


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