zeus::TXLoaderObject Class Reference

#include <XLoaderObject.h>

Inheritance diagram for zeus::TXLoaderObject:

List of all members.

Public Member Functions
	TXLoaderObject (IXMLNode &rNode)
virtual	~TXLoaderObject ()
virtual Retval MQUALIFIER	load ()
virtual Retval MQUALIFIER	unload ()
virtual bool MQUALIFIER	isLoaded ()
virtual Retval MQUALIFIER	getExtXMLRefNode (IXMLNode *&rpExtRefNode) const
virtual Retval MQUALIFIER	setExtXMLRef (NAMESPACE_Zeus::IXMLDocument &doc, IXMLNode &main_ref)
virtual void MQUALIFIER	getXMLFileName (IString &pFileName) const
virtual Retval MQUALIFIER	reload (const IString *pFileNameToCopy=NULL)
virtual Retval MQUALIFIER	addChild (IXObject &child)
virtual bool MQUALIFIER	canCreateChildren () const
virtual bool MQUALIFIER	freeze ()
virtual bool MQUALIFIER	unfreeze ()
virtual Retval MQUALIFIER	insertChild (Int iIndex, IXObject &rChild)
virtual Retval MQUALIFIER	getChild (Int iIndex, IXObject *&rpChild)
virtual Retval MQUALIFIER	getChildByName (const IString &rName, IXObject *&rpChild)
virtual Retval MQUALIFIER	askForInterface (const InterfaceID &rInterfaceID, IZUnknown *&rpIface)
virtual void MQUALIFIER	addRef () const
virtual void MQUALIFIER	release () const
	REG_SUB_BEGIN (TXLoaderObject) REG_SUB_ADD(TXLoaderObject
Public Attributes
L	TXLoaderObject
Protected Member Functions
Retval	saveXML (const TString &rFileName=L"")

---

Detailed Description

This Object is a loadable node of the xobject tree. This means, that a factory who creates the tree wont create its children. The children were defined in seperate xml document and are loaded when someone need a child instance only. This mechanisme is usefull to save system resources.

---

Constructor & Destructor Documentation

zeus::TXLoaderObject::TXLoaderObject

(

IXMLNode &

rNode )

TXLoaderObject::~TXLoaderObject

(

)

[virtual]

Destroys the loadable object

---

Member Function Documentation

Retval MQUALIFIER TXLoaderObject::addChild

(

IXObject &

child )

[virtual]

See also:

IXObject::addChild

Reimplemented from zeus::TXObject.

virtual void MQUALIFIER zeus::TXLoaderObject::addRef

(

)

const [virtual]

See also:

IZUnknown::addRef

Reimplemented from zeus::TXObject.

Reimplemented in zeus::TModule.

virtual Retval MQUALIFIER zeus::TXLoaderObject::askForInterface	(	const InterfaceID &	rInterfaceID,
		IZUnknown *&	rpIface
	)		[virtual]

See also:

IZUnknown::askForInterface

Reimplemented from zeus::TXObject.

Reimplemented in zeus::TModule.

bool MQUALIFIER TXLoaderObject::canCreateChildren

(

)

const [virtual]

Check the attribute "CreateChildren". If the value is set to 1, this object will be loaded and all children will be created. See IXObject

Reimplemented from zeus::TXObject.

bool MQUALIFIER TXLoaderObject::freeze

(

)

[virtual]

See also:

IXObject::freeze

Reimplemented from zeus::TXObject.

Reimplemented in zeus::TModule.

Retval MQUALIFIER TXLoaderObject::getChild	(	Int	iIndex,
		IXObject *&	rpChild
	)		[virtual]

See also:

IXObject::getChild

Reimplemented from zeus::TXObject.

Retval MQUALIFIER TXLoaderObject::getChildByName	(	const IString &	rName,
		IXObject *&	rpChild
	)		[virtual]

See also:

IXObject::getChildByName

Reimplemented from zeus::TXObject.

Retval MQUALIFIER TXLoaderObject::getExtXMLRefNode

(

IXMLNode *&

rpExtRefNode )

const [virtual]

See also:

IXLoaderObject::getExtXMLRefNode

Implements zeus::IXLoaderObject.

void MQUALIFIER TXLoaderObject::getXMLFileName

(

IString &

pFileName )

const [virtual]

See also:

IXLoaderObject::getXMLFileName

Implements zeus::IXLoaderObject.

Retval MQUALIFIER TXLoaderObject::insertChild	(	Int	iIndex,
		IXObject &	rChild
	)		[virtual]

See also:

IXObject::insertChild

Reimplemented from zeus::TXObject.

bool MQUALIFIER zeus::TXLoaderObject::isLoaded

(

)

[inline, virtual]

See also:

IXLoaderObject::isLoaded

Implements zeus::IXLoaderObject.

Retval MQUALIFIER TXLoaderObject::load

(

)

[virtual]

See also:

IXLoaderObject::load

Implements zeus::IXLoaderObject.

Reimplemented in zeus::TModule.

zeus::TXLoaderObject::REG_SUB_BEGIN

(

TXLoaderObject

)

virtual void MQUALIFIER zeus::TXLoaderObject::release

(

)

const [virtual]

See also:

IZUnknown::release

Reimplemented from zeus::TXObject.

Reimplemented in zeus::TModule.

Retval MQUALIFIER TXLoaderObject::reload

(

const IString *

pFileNameToCopy = NULL )

[virtual]

See also:

IXLoaderObject::reload

Implements zeus::IXLoaderObject.

Retval TXLoaderObject::saveXML

(

const TString &

rFileName = L"" )

[protected]

Saves the XML Document of the external objects

Parameters:

rFileName,:

Name of the file (if empty it takes the actual file name)

Return values:

RET_NOERROR	: File saved
RET_REQUEST_FAILED	: No Document available or could not store file

Retval MQUALIFIER TXLoaderObject::setExtXMLRef	(	NAMESPACE_Zeus::IXMLDocument &	doc,
		IXMLNode &	main_ref
	)		[virtual]

See also:

IXLoaderObject::setExtXMLRef

bool MQUALIFIER TXLoaderObject::unfreeze

(

)

[virtual]

See also:

IXObject::unfreeze

Reimplemented from zeus::TXObject.

Reimplemented in zeus::TModule.

Retval MQUALIFIER TXLoaderObject::unload

(

)

[virtual]

See also:

IXLoaderObject::unload

Implements zeus::IXLoaderObject.

Reimplemented in zeus::TModule.

---

Member Data Documentation

TXLoaderObject::TXLoaderObject

Creates a loadable object node

Parameters:

node	: XML Node

---

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

• XLoaderObject.h
• XLoaderObject.cpp