CEGUI::WidgetLookManager Class Reference

Manager class that gives top-level access to widget data based "look and feel" specifications loaded into the system. More...

Inheritance diagram for CEGUI::WidgetLookManager:

[legend]

Collaboration diagram for CEGUI::WidgetLookManager:

[legend]

List of all members.

Public Member Functions
	WidgetLookManager ()
	Constructor.
	~WidgetLookManager ()
	Destructor.
void	parseLookNFeelSpecification (const String &filename, const String &resourceGroup="")
	Parses a file containing window look & feel specifications (in the form of XML).
bool	isWidgetLookAvailable (const String &widget) const
	Return whether a WidgetLookFeel has been created with the specified name.
const WidgetLookFeel &	getWidgetLook (const String &widget) const
	Return a const reference to a WidgetLookFeel object which has the specified name.
void	eraseWidgetLook (const String &widget)
	Erase the WidgetLookFeel that has the specified name.
void	addWidgetLook (const WidgetLookFeel &look)
	Add the given WidgetLookFeel.
void	writeWidgetLookToStream (const String &name, OutStream &out_stream) const
	Writes a complete Widge Look to a stream. Note that xml file header and falagard opening/closing tags will also be written.
void	writeWidgetLookSeriesToStream (const String &prefix, OutStream &out_stream) const
	Writes a series of complete Widge Look objects to a stream. Note that xml file header and falagard opening/closing tags will also be written.
Static Public Member Functions
static WidgetLookManager &	getSingleton (void)
	Return singleton WidgetLookManager object.
static WidgetLookManager *	getSingletonPtr (void)
	Return pointer to singleton WindowFactoryManager object.
static const String &	getDefaultResourceGroup ()
	Returns the default resource group currently set for LookNFeels.
static void	setDefaultResourceGroup (const String &resourceGroup)
	Sets the default resource group to be used when loading LookNFeel data.

---

Detailed Description

Manager class that gives top-level access to widget data based "look and feel" specifications loaded into the system.

---

Member Function Documentation

void CEGUI::WidgetLookManager::addWidgetLook

(

const WidgetLookFeel &

look

)

Add the given WidgetLookFeel.

Note:

If the WidgetLookFeel specification uses a name that already exists within the system, it is not an error; the previous definition is overwritten by the new data. An entry will appear in the log each time any look & feel component is overwritten.

Parameters:

look

WidgetLookFeel object to be added to the system. NB: The WidgetLookFeel is copied, no change of ownership of the input object occurrs.

Returns:

Nothing.

References CEGUI::WidgetLookFeel::getName(), getSingleton(), and isWidgetLookAvailable().

void CEGUI::WidgetLookManager::eraseWidgetLook

(

const String &

widget

)

Erase the WidgetLookFeel that has the specified name.

Parameters:

widget

String object holding the name of a widget look to be erased. If no such WindowLookFeel exists, nothing happens.

Returns:

Nothing.

References getSingleton().

static const String& CEGUI::WidgetLookManager::getDefaultResourceGroup

(

void

)

[inline, static]

Returns the default resource group currently set for LookNFeels.

Returns:

String describing the default resource group identifier that will be used when loading LookNFeel data.

WidgetLookManager & CEGUI::WidgetLookManager::getSingleton

(

void

)

[static]

Return singleton WidgetLookManager object.

Returns:

Singleton WidgetLookManager object

Referenced by addWidgetLook(), eraseWidgetLook(), CEGUI::WindowRenderer::getLookNFeel(), CEGUI::Tree::initialise(), CEGUI::Window::isPropertyAtDefault(), parseLookNFeelSpecification(), CEGUI::Window::performChildWindowLayout(), CEGUI::Window::rename(), CEGUI::SectionSpecification::render(), CEGUI::Window::setLookNFeel(), WidgetLookManager(), writeWidgetLookToStream(), and ~WidgetLookManager().

WidgetLookManager * CEGUI::WidgetLookManager::getSingletonPtr

(

void

)

[static]

Return pointer to singleton WindowFactoryManager object.

Returns:

Pointer to singleton WindowFactoryManager object

const WidgetLookFeel & CEGUI::WidgetLookManager::getWidgetLook

(

const String &

widget

)

const

Return a const reference to a WidgetLookFeel object which has the specified name.

Parameters:

widget

String object holding the name of a widget look that is to be returned.

Returns:

const reference to the requested WidgetLookFeel object.

Exceptions:

UnknownObjectException

thrown if no WindowLookFeel is available with the requested name.

Referenced by CEGUI::WindowRenderer::getLookNFeel(), CEGUI::Tree::initialise(), CEGUI::Window::isPropertyAtDefault(), CEGUI::Window::performChildWindowLayout(), CEGUI::Window::rename(), CEGUI::SectionSpecification::render(), CEGUI::Window::setLookNFeel(), and writeWidgetLookToStream().

bool CEGUI::WidgetLookManager::isWidgetLookAvailable

(

const String &

widget

)

const

Return whether a WidgetLookFeel has been created with the specified name.

Parameters:

widget

String object holding the name of a widget look to test for.

Returns:

• true if a WindowLookFeel named widget is available.
• false if so such WindowLookFeel is currently available.

Referenced by addWidgetLook().

void CEGUI::WidgetLookManager::parseLookNFeelSpecification	(	const String &	filename,
		const String &	resourceGroup = ""
	)

Parses a file containing window look & feel specifications (in the form of XML).

Note:

If the new file contains specifications for widget types that are already specified, it is not an error; the previous definitions are overwritten by the new data. An entry will appear in the log each time any look & feel component is overwritten.

Parameters:

	filename	String object containing the filename of a file containing the widget look & feel data
	resourceGroup	Resource group identifier to pass to the resource provider when loading the file.

Returns:

Nothing.

Exceptions:

	FileIOException	thrown if there was some problem accessing or parsing the file filename
	InvalidRequestException	thrown if an invalid filename was provided.

References CEGUI::String::empty(), CEGUI::Errors, and getSingleton().

static void CEGUI::WidgetLookManager::setDefaultResourceGroup

(

const String &

resourceGroup

)

[inline, static]

Sets the default resource group to be used when loading LookNFeel data.

Parameters:

resourceGroup

String describing the default resource group identifier to be used.

Returns:

Nothing.

void CEGUI::WidgetLookManager::writeWidgetLookSeriesToStream	(	const String &	prefix,
		OutStream &	out_stream
	)			const

Writes a series of complete Widge Look objects to a stream. Note that xml file header and falagard opening/closing tags will also be written.

The prefix specifies a name prefix common to all widget looks to be written, you could specify this as "TaharezLook/" and then any defined widget look starting with that prefix, such as "TaharezLook/Button" and "TaharezLook/Listbox" will be written to the stream.

Parameters:

	prefix	String holding the widget look name prefix, which will be used when searching for the widget looks to be output to the stream.
	out_stream	OutStream where XML data should be sent.

References CEGUI::XMLSerializer::closeTag(), CEGUI::String::length(), and CEGUI::XMLSerializer::openTag().

void CEGUI::WidgetLookManager::writeWidgetLookToStream	(	const String &	name,
		OutStream &	out_stream
	)			const

Writes a complete Widge Look to a stream. Note that xml file header and falagard opening/closing tags will also be written.

Parameters:

	name	String holding the name of the widget look to be output to the stream.
	out_stream	OutStream where XML data should be sent.

References CEGUI::XMLSerializer::closeTag(), CEGUI::Errors, getSingleton(), getWidgetLook(), CEGUI::XMLSerializer::openTag(), and CEGUI::WidgetLookFeel::writeXMLToStream().