zeus::TXMLStream Class Reference

#include <XMLStream.h>

Inheritance diagram for zeus::TXMLStream:

List of all members.

Public Member Functions
	TXMLStream (const IString &rData)
void	closeXML ()
Retval	loadXML (NAMESPACE_Zeus::IXMLDocument *&rpDocument)
Retval	loadXObjects (IXObject *&rpObject, bool dDoUnfreeze=true, bool bKeepXObjectAfterClosing=false)
TString	getDocumentStream () const
Retval	selectNode (const IString &rXPath, IXMLNode *&rpNode)
Retval	selectNode (const wchar_t *pXPath, IXMLNode *&rpNode)
Retval	selectNodes (const IString &rXPath, IXPathResults *&rpResults)
Retval	selectNodes (const wchar_t *pXPath, IXPathResults *&rpResults)
Retval	selectNodeValue (const IString &rXPath, IString &rValue)
Retval	selectNodeValue (const wchar_t *pXPath, IString &rValue)
Retval	selectObject (const IString &rXObjectPath, IXObject *&rpObject)
Retval	selectObject (const wchar_t *pXObjectPath, IXObject *&rpObject)
Retval	selectObjects (const IString &rXObjectPath, IXObjectCollection *&rpCollection)
Retval	selectObjects (const wchar_t *pXObjectPath, IXObjectCollection *&rpCollection)
Retval	selectCastedObject (const IString &rXObjectPath, const InterfaceID &rInterfaceID, IZUnknown *&rpObject)
Retval	selectCastedObject (const wchar_t *pXObjectPath, const InterfaceID &rInterfaceID, IZUnknown *&rpObject)
void	useNamespace (const IString &rPrefix, const IString &rNamespace)
void	useNamespace (const wchar_t *pPrefix, const wchar_t *pNamespace)
Retval	writeNodeValue (const IString &rXPath, const IString &rValue)
Retval	writeNodeValue (const wchar_t *pXPath, const wchar_t *pValue)
Protected Member Functions
virtual	~TXMLStream ()
virtual Retval	loadXML_internal ()

---

Detailed Description

the xml stream loads xml data nodes out of a stream and returns DOM nodes or X-Objects. Like the XMLFile class this class handles the XML data and provides a comfortable interface for XML in Zeus-Framework

---

Constructor & Destructor Documentation

TXMLStream::TXMLStream

(

const IString &

rData

)

Creates a XML stream object

TXMLStream::~TXMLStream

(

)

[protected, virtual]

Destroys the XML stream object

---

Member Function Documentation

void zeus::TXMLStream::closeXML

(

)

[inline]

See also:

TXMLDataSource::closeXML

Retval zeus::TXMLStream::loadXML

(

NAMESPACE_Zeus::IXMLDocument *&

rpDocument

)

[inline]

See also:

TXMLDataSource::loadXML

Retval zeus::TXMLStream::loadXObjects	(	IXObject *&	rpObject,
		bool	dDoUnfreeze = true,
		bool	bKeepXObjectAfterClosing = false
	)			[inline]

See also:

TXMLDataSource::loadXObjects

TString zeus::TXMLStream::getDocumentStream

(

)

const [inline]

See also:

TXMLDataSource::getDocumentStream

Retval zeus::TXMLStream::selectNode	(	const IString &	rXPath,
		IXMLNode *&	rpNode
	)			[inline]

See also:

TXMLDataSource::selectNode

Retval zeus::TXMLStream::selectNode	(	const wchar_t *	pXPath,
		IXMLNode *&	rpNode
	)			[inline]

queries an xml node

Retval zeus::TXMLStream::selectNodes	(	const IString &	rXPath,
		IXPathResults *&	rpResults
	)			[inline]

See also:

TXMLDataSource::selectNodes

Retval zeus::TXMLStream::selectNodes	(	const wchar_t *	pXPath,
		IXPathResults *&	rpResults
	)			[inline]

selects a xpath result (list of nodes)

Retval zeus::TXMLStream::selectNodeValue	(	const IString &	rXPath,
		IString &	rValue
	)			[inline]

See also:

TXMLDataSource::selectNodeValue

Retval zeus::TXMLStream::selectNodeValue	(	const wchar_t *	pXPath,
		IString &	rValue
	)			[inline]

queries an xml node value

Retval zeus::TXMLStream::selectObject	(	const IString &	rXObjectPath,
		IXObject *&	rpObject
	)			[inline]

See also:

TXMLDataSource::selectObject

Retval zeus::TXMLStream::selectObject	(	const wchar_t *	pXObjectPath,
		IXObject *&	rpObject
	)			[inline]

queries an x-object

Retval zeus::TXMLStream::selectObjects	(	const IString &	rXObjectPath,
		IXObjectCollection *&	rpCollection
	)			[inline]

See also:

TXMLDataSource::selectObjects

Retval zeus::TXMLStream::selectObjects	(	const wchar_t *	pXObjectPath,
		IXObjectCollection *&	rpCollection
	)			[inline]

queries a set of x-objects

Retval zeus::TXMLStream::selectCastedObject	(	const IString &	rXObjectPath,
		const InterfaceID &	rInterfaceID,
		IZUnknown *&	rpObject
	)			[inline]

See also:

TXMLDataSource::selectCastedObject

Retval zeus::TXMLStream::selectCastedObject	(	const wchar_t *	pXObjectPath,
		const InterfaceID &	rInterfaceID,
		IZUnknown *&	rpObject
	)			[inline]

queries a casted object

void zeus::TXMLStream::useNamespace	(	const IString &	rPrefix,
		const IString &	rNamespace
	)			[inline]

sets a prefix for namspace

void zeus::TXMLStream::useNamespace	(	const wchar_t *	pPrefix,
		const wchar_t *	pNamespace
	)			[inline]

sets a prefix for namspace

Retval zeus::TXMLStream::writeNodeValue	(	const IString &	rXPath,
		const IString &	rValue
	)			[inline]

See also:

TXMLDataSource::writeNodeValue

Retval zeus::TXMLStream::writeNodeValue	(	const wchar_t *	pXPath,
		const wchar_t *	pValue
	)			[inline]

writes a node value to the XML file

Retval TXMLStream::loadXML_internal

(

)

[protected, virtual]

loads an XML file into the internal document

---

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

• XMLStream.h
• XMLStream.cpp