XML Namespace Reference

The XML Library namespace. More...

Classes
class	Attribute
	An attribute. More...
struct	FindByName
	The predicate used to find an attribute by name. More...
class	Attributes
	The collection of attributes for a node. More...
class	CDataNode
	The XML node type used to for a CDATA section. More...
class	CharTable
	A lookup table used to check the attributes of characters in an XML stream. More...
class	CommentNode
	The XML node type used to for a comment. More...
class	DocTypeNode
	The XML node type used for the document type. More...
class	Document
	The XML node type used for the top-most node. More...
class	ElementNode
	The XML node type used to denote an element. More...
class	IOException
	The type of exception throw during serialization of an XML document. More...
class	Node
	The base class for all nodes that are stored in an XML document. More...
class	NodeContainer
	The mixin class used for node types that can contain other nodes. More...
class	ProcessingNode
	The XML node type used for a processing instruction. More...
class	Reader
	The reader to create an XML document from a text stream. More...
class	TextNode
	The XML node type used for the text contained between other nodes. More...
class	Writer
	The writer to create a text stream from an XML document. More...
class	XPathIterator
	An iterator for enumerating an XML document according to an XPath expression. More...
Typedefs
typedef Core::SharedPtr < Attribute >	AttributePtr
	The default Attribute smart-pointer type.
typedef Core::RefCntPtr < CDataNode >	CDataNodePtr
	The default CDataNode smart-pointer type.
typedef Core::RefCntPtr < CommentNode >	CommentNodePtr
	The default CommentNode smart-pointer type.
typedef Core::RefCntPtr < DocTypeNode >	DocTypeNodePtr
	The default DocType smart-pointer type.
typedef Core::RefCntPtr< Document >	DocumentPtr
	The default Document smart-pointer type.
typedef Core::RefCntPtr < ElementNode >	ElementNodePtr
	The default ElementNode smart-pointer type.
typedef Core::RefCntPtr< Node >	NodePtr
	The default Node smart-pointer type.
typedef std::vector< NodePtr >	Nodes
	The default container type for a collection of Nodes.
typedef Core::RefCntPtr < ProcessingNode >	ProcessingNodePtr
	The default ProcessingNode smart-pointer type.
typedef Core::RefCntPtr< TextNode >	TextNodePtr
	The default TextNode smart-pointer type.
Enumerations
enum	NodeType {   DOCUMENT_NODE, ELEMENT_NODE, TEXT_NODE, COMMENT_NODE,   PROCESSING_NODE, DOCTYPE_NODE, CDATA_NODE }
	The types of nodes stored in an XML document. More...
Functions
template<typename T >
void	appendChild (NodePtr pNode, Core::RefCntPtr< T > &pChild)
	Helper function for appending a child node.
bool	operator== (const XPathIterator &LHS, const XPathIterator &RHS)
	Global equivalence operator for a XPath iterator.
bool	operator!= (const XPathIterator &LHS, const XPathIterator &RHS)
	Global non-equivalence operator for a XPath iterator.
Variables
static CharTable	s_oCharTable
	The stream character lookup table.

---

Detailed Description

The XML Library namespace.

---

Typedef Documentation

typedef Core::SharedPtr<Attribute> XML::AttributePtr

The default Attribute smart-pointer type.

typedef Core::RefCntPtr<CDataNode> XML::CDataNodePtr

The default CDataNode smart-pointer type.

typedef Core::RefCntPtr<CommentNode> XML::CommentNodePtr

The default CommentNode smart-pointer type.

typedef Core::RefCntPtr<DocTypeNode> XML::DocTypeNodePtr

The default DocType smart-pointer type.

typedef Core::RefCntPtr<Document> XML::DocumentPtr

The default Document smart-pointer type.

typedef Core::RefCntPtr<ElementNode> XML::ElementNodePtr

The default ElementNode smart-pointer type.

typedef Core::RefCntPtr<Node> XML::NodePtr

The default Node smart-pointer type.

typedef std::vector<NodePtr> XML::Nodes

The default container type for a collection of Nodes.

typedef Core::RefCntPtr<ProcessingNode> XML::ProcessingNodePtr

The default ProcessingNode smart-pointer type.

typedef Core::RefCntPtr<TextNode> XML::TextNodePtr

The default TextNode smart-pointer type.

---

Enumeration Type Documentation

enum XML::NodeType

The types of nodes stored in an XML document.

This is used for doing RTTI when navigating the XML document.

Enumerator:

DOCUMENT_NODE	The top-most node.
ELEMENT_NODE	An element node.
TEXT_NODE	A text string node.
COMMENT_NODE	A comment node.
PROCESSING_NODE	A processing instruction node.
DOCTYPE_NODE	A document type node.
CDATA_NODE	A CDATA section.

---

Function Documentation

template<typename T >

void XML::appendChild	(	NodePtr	pNode,
		Core::RefCntPtr< T > &	pChild
	)		[inline]

Helper function for appending a child node.

bool XML::operator==	(	const XPathIterator &	LHS,
		const XPathIterator &	RHS
	)		[inline]

Global equivalence operator for a XPath iterator.

bool XML::operator!=	(	const XPathIterator &	LHS,
		const XPathIterator &	RHS
	)		[inline]

Global non-equivalence operator for a XPath iterator.

---

Variable Documentation

CharTable XML::s_oCharTable [static]

The stream character lookup table.