CEGUI::ResourceProvider Class Reference

Abstract class that defines the required interface for all resource provider sub-classes. More...

#include <CEGUIResourceProvider.h>

Inheritance diagram for CEGUI::ResourceProvider:

[legend]Collaboration diagram for CEGUI::ResourceProvider:

[legend]List of all members.

Public Member Functions
	ResourceProvider ()
	Constructor for the ResourceProvider class.
virtual	~ResourceProvider (void)
	Destructor for the ResourceProvider class.
virtual void	loadRawDataContainer (const String &filename, RawDataContainer &output, const String &resourceGroup)=0
	// Load XML data using InputSource objects. Load raw binary data.
const String &	getDefaultResourceGroup (void) const
	Return the current default resource group identifier.
void	setDefaultResourceGroup (const String &resourceGroup)
	Set the default resource group identifier.
Protected Attributes
String	d_defaultResourceGroup
	Default resource group identifier.

---

Detailed Description

Abstract class that defines the required interface for all resource provider sub-classes.

A ResourceProvider is used to load both XML and binary data from an external source. This could be from a filesystem or the resource manager of a specific renderer.

Definition at line 43 of file CEGUIResourceProvider.h.

---

Constructor & Destructor Documentation

CEGUI::ResourceProvider::ResourceProvider (   )  [inline]

Constructor for the ResourceProvider class. Definition at line 53 of file CEGUIResourceProvider.h.

virtual CEGUI::ResourceProvider::~ResourceProvider (  void   )  [inline, virtual]

Destructor for the ResourceProvider class. Definition at line 59 of file CEGUIResourceProvider.h.

---

Member Function Documentation

const String& CEGUI::ResourceProvider::getDefaultResourceGroup (  void   )  const [inline]

Return the current default resource group identifier. Returns: String object containing the currently set default resource group identifier. Definition at line 100 of file CEGUIResourceProvider.h.

virtual void CEGUI::ResourceProvider::loadRawDataContainer (  const String &  filename, RawDataContainer &  output, const String &  resourceGroup )  [pure virtual]

// Load XML data using InputSource objects. Load raw binary data. Parameters: filename  String containing a filename of the resource to be loaded. output  Reference to a RawDataContainer object to load the data into. resourceGroup  Optional String that may be used by implementations to identify the group from which the resource should be loaded. Implemented in CEGUI::DefaultResourceProvider, and CEGUI::IrrlichtResourceProvider.

void CEGUI::ResourceProvider::setDefaultResourceGroup (  const String &  resourceGroup  )  [inline]

Set the default resource group identifier. Parameters: resourceGroup  String object containing the default resource group identifier to be used. Returns: Nothing. Definition at line 112 of file CEGUIResourceProvider.h.

---

Member Data Documentation

String CEGUI::ResourceProvider::d_defaultResourceGroup [protected]

Default resource group identifier. Definition at line 115 of file CEGUIResourceProvider.h.

---

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

• CEGUIResourceProvider.h

---