#include <IXLoaderObject.hpp>
List of all members.
Detailed Description
This interface defines a loadable object node, which can load and unload the children objects (load and unload a ressource library)
Member Function Documentation
| virtual Retval MQUALIFIER zeus::IXLoaderObject::getExtXMLRefNode |
( |
IXMLNode *& |
rpExtRefNode ) |
const [pure virtual] |
Get the xml node of the xobject
- Parameters:
-
| rpExtRefNode | : return parameter of the xml node |
- Return values:
-
| RET_NOERROR | : node returned |
| RET_REQUEST_FAILED | : Could not get the xml node |
Implemented in zeus::TXLoaderObject.
| virtual void MQUALIFIER zeus::IXLoaderObject::getXMLFileName |
( |
IString & |
rFileName ) |
const [pure virtual] |
Returns the filename of the external xml file.
- Parameters:
-
| rFileName | : Return parameter of the filename |
Implemented in zeus::TXLoaderObject.
| virtual bool MQUALIFIER zeus::IXLoaderObject::isLoaded |
( |
) |
[pure virtual] |
Check if the resource is loaded
- Return values:
-
| true | : Resource is loaded |
| false | : Resource is not loaded |
Implemented in zeus::TXLoaderObject.
| virtual Retval MQUALIFIER zeus::IXLoaderObject::load |
( |
) |
[pure virtual] |
Load the ressource DLL
- Return values:
-
| RET_NOERROR | : Resource loaded |
| RET_INTERNAL_ERROR | : An internal unknown error occured loading the resource |
| RET_REQUEST_FAILED | : Could not load the resource (file not available) |
Implemented in zeus::TModule, and zeus::TXLoaderObject.
| virtual Retval MQUALIFIER zeus::IXLoaderObject::reload |
( |
const IString * |
pFileNameToCopy = NULL ) |
[pure virtual] |
Reloads the document
- Parameters:
-
| pFileNameToCopy | : Copy data form a file first |
Implemented in zeus::TXLoaderObject.
| virtual Retval MQUALIFIER zeus::IXLoaderObject::setExtXMLRef |
( |
IXMLDocument & |
rDoc, |
|
|
IXMLNode & |
rMainRef |
|
) |
| [pure virtual] |
This sets a external XML Reference as a XMLDocument. Only one xml document can be loaded externaly.
- Parameters:
-
| rDoc | : Loaded document |
| rMainRef | : Main node of the document |
- Return values:
-
| RET_NOERROR | : Ext reference added |
| RET_REQUEST_FAILED | : Could not add document, because one is loaded already |
| virtual Retval MQUALIFIER zeus::IXLoaderObject::unload |
( |
) |
[pure virtual] |
Unload the resource
- Return values:
-
| RET_NOERROR | : Resource unloaded |
| RET_INTERNAL_ERROR | : An internal unknown error occured unloading the resource |
| RET_REQUEST_FAILED | : Could not unload the resource |
Implemented in zeus::TModule, and zeus::TXLoaderObject.
The documentation for this class was generated from the following file:
