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:

Collaboration diagram for CEGUI::WidgetLookManager:

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). More...

bool	isWidgetLookAvailable (const String &widget) const
	Return whether a WidgetLookFeel has been created with the specified name. More...

const WidgetLookFeel &	getWidgetLook (const String &widget) const
	Return a const reference to a WidgetLookFeel object which has the specified name. More...

void	eraseWidgetLook (const String &widget)
	Erase the WidgetLookFeel that has the specified name. More...

void	addWidgetLook (const WidgetLookFeel &look)
	Add the given WidgetLookFeel. More...

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. More...

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. More...

Static Public Member Functions
static WidgetLookManager &	getSingleton (void)
	Return singleton WidgetLookManager object. More...

static WidgetLookManager *	getSingletonPtr (void)
	Return pointer to singleton WindowFactoryManager object. More...

static const String &	getDefaultResourceGroup ()
	Returns the default resource group currently set for LookNFeels. More...

static void	setDefaultResourceGroup (const String &resourceGroup)
	Sets the default resource group to be used when loading LookNFeel data. More...

Static Public Member Functions inherited from CEGUI::Singleton< WidgetLookManager >
static WidgetLookManager &	getSingleton (void)

static WidgetLookManager *	getSingletonPtr (void)

Additional Inherited Members
Static Protected Attributes inherited from CEGUI::Singleton< WidgetLookManager >
static WidgetLookManager *	ms_Singleton

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(), 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.

static const String& CEGUI::WidgetLookManager::getDefaultResourceGroup ( void )

inlinestatic

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 CEGUI::WindowRenderer::getLookNFeel(), CEGUI::Tree::initialise(), CEGUI::Window::isPropertyAtDefault(), CEGUI::Window::performChildWindowLayout(), CEGUI::Window::rename(), CEGUI::SectionSpecification::render(), and CEGUI::Window::setLookNFeel().

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, CEGUI::System::getSingleton(), CEGUI::System::getXMLParser(), and CEGUI::XMLParser::parseXMLFile().

static void CEGUI::WidgetLookManager::setDefaultResourceGroup ( const String & resourceGroup )

inlinestatic

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 \a 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, getWidgetLook(), CEGUI::XMLSerializer::openTag(), and CEGUI::WidgetLookFeel::writeXMLToStream().

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation