CzXomlLoad Class Reference

Utility class to allow loading of XOML files from within another XOML file. More...

#include <CzXomlLoad.h>

Inheritance diagram for CzXomlLoad:

List of all members.

Public Member Functions
	CzXomlLoad ()
int	LoadFromXoml (IzXomlResource *parebt, bool load_children, CzXmlNode *node)
	XOML command that loads another XOML file.
Static Public Member Functions
static bool	CreateInstance (IzXomlResource *parent, CzScene *scene, CzString *template_name, CzString *parameters)
	Instantiates XOML data from a template.

---

Detailed Description

Utility class to allow loading of XOML files from within another XOML file.

CzXomlLoad implements the LoadXOML tag, which enables a XOML file to load another XOML file into its heirarchy.

Loading a XOML file from XOML is incredibly simple:

<LoadXOML File="UIStyle.xml" />

Or from an action:

<Action Method="LoadXOML" P1="Scene2.xml" />

---

Constructor & Destructor Documentation

CzXomlLoad::CzXomlLoad

(

)

[inline]

---

Member Function Documentation

bool CzXomlLoad::CreateInstance	(	IzXomlResource *	parent,
		CzScene *	scene,
		CzString *	template_name,
		CzString *	parameters
	)		[static]

Instantiates XOML data from a template.

Instantiates XOML data from the supplied template using the supplied parameters list. The scene represents the scene that will receive the created XOML objects whilst the parent represents the place where to look for the template.

Parameters:

[in]	parent	If non-null, the parent where the template resource is located.
[in,out]	scene	If non-null, the scene where the template objects will be instantiated.
[in]	template_name	If non-null, name of the template.
[in]	parameters	If non-null, template parameters.

Returns:

The new instance.

int CzXomlLoad::LoadFromXoml	(	IzXomlResource *	parent,
		bool	load_children,
		CzXmlNode *	node
	)		[virtual]

XOML command that loads another XOML file.

This method loads another XOML file into the parent XOML resource (for example a scene or actor). Supplying NULL for parent will load the XOML globally.

Parameters:

[in,out]	parent	If non-null, the parent.
	load_children	true to load children nodes.
[in]	node	If non-null, the node.

Implements IzXomlResource.

---

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

• CzXomlLoad.h
• CzXomlLoad.cpp