JC::SConfig::Handler Class Reference

Class that wraps a Node class for easy and secure access. More...

#include <sconfig.hpp>

Collaboration diagram for JC::SConfig::Handler:

[legend]

List of all members.

Public Member Functions
	Handler (const Node *node)
	Default constructor.
	~Handler ()
	Handler (const Handler &handler)
	Copy constructor.
Handler &	operator= (const Handler &old)
Handler	FirstNode () const
	Gets the first Node and wraps it with an Handler.
Handler	FirstNode (const string &name) const
	Gets the first Node with a specific name and wraps it with an Handler.
Handler	NextSibling ()
	Gets the next Node sibling and wraps it with an Handler.
Handler	NextSibling (const string &name)
	Gets the next Node sibling with a specific name and wraps it with an Handler.
Handler	PreviousSibling ()
	Gets the previous Node sibling and wraps it with an Handler.
Handler	PreviousSibling (const string &name)
	Gets the previous Node sibling with a specific name and wraps it with an Handler.
PairHandler	FirstPair () const
	Gets the first Pair and wraps it with an PairHandler.
PairHandler	FirstPair (const string &name) const
	Gets the first Pair with a specific key name and wraps it with an PairHandler.
const Node *	Get ()
	Gets the actual Node pointer, if it exists.
Private Attributes
const Node *	m_Node

---

Detailed Description

Class that wraps a Node class for easy and secure access.

---

Constructor & Destructor Documentation

Handler::Handler

(

const Node *

node

)

Default constructor.

Parameters:

node

Pointer to the Node to be wrapped.

Handler::~Handler

(

)

Handler::Handler

(

const Handler &

handler

)

Copy constructor.

---

Member Function Documentation

Handler & Handler::operator=

(

const Handler &

old

)

Handler Handler::FirstNode

(

)

const

Gets the first Node and wraps it with an Handler.

Returns:

An Handler object wrapping the first Node.

Handler Handler::FirstNode

(

const string &

name

)

const

Gets the first Node with a specific name and wraps it with an Handler.

Parameters:

name

the Node's name to search for.

Returns:

An Handler object wrapping the first Node with the specified name.

Handler Handler::NextSibling

(

)

Gets the next Node sibling and wraps it with an Handler.

Returns:

An Handler object wrapping the next sibling.

Handler Handler::NextSibling

(

const string &

name

)

Gets the next Node sibling with a specific name and wraps it with an Handler.

Parameters:

name

the Node's name to search for.

Returns:

An Handler object wrapping the next sibling with the specified name.

Handler Handler::PreviousSibling

(

)

Gets the previous Node sibling and wraps it with an Handler.

Returns:

An Handler object wrapping the previous sibling.

Handler Handler::PreviousSibling

(

const string &

name

)

Gets the previous Node sibling with a specific name and wraps it with an Handler.

Parameters:

name

the Node's name to search for.

Returns:

An Handler object wrapping the previous sibling with the specified name.

PairHandler Handler::FirstPair

(

)

const

Gets the first Pair and wraps it with an PairHandler.

Returns:

A PairHandler object wrapping the first Pair.

PairHandler Handler::FirstPair

(

const string &

name

)

const

Gets the first Pair with a specific key name and wraps it with an PairHandler.

Parameters:

name

the Pair's key to search for.

Returns:

A PairHandler object wrapping the first Pair with the specified name.

const Node * Handler::Get

(

)

Gets the actual Node pointer, if it exists.

Returns:

A pointer to the actual Node, NULL is returned if Node doesn't exist.

---

Member Data Documentation

const Node* JC::SConfig::Handler::m_Node [private]

---

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

• src/sconfig.hpp
• src/sconfig.cpp