CEGUI::SchemeManager Class Reference

A class that manages the creation of, access to, and destruction of GUI Scheme objects. More...

Inheritance diagram for CEGUI::SchemeManager:

Collaboration diagram for CEGUI::SchemeManager:

Public Types
typedef ConstMapIterator< ObjectRegistry >	SchemeIterator
	Definition of SchemeIterator type.
Public Types inherited from CEGUI::EventSet
typedef ConstMapIterator< EventMap >	EventIterator

Public Member Functions
	SchemeManager ()
	Constructor.
	~SchemeManager ()
	Destructor.
SchemeIterator	getIterator () const
	Return a SchemeManager::SchemeIterator object to iterate over the available schemes.
void	setAutoLoadResources (bool enabled)
	If this is enabled, Schemas will immediately load their resources after they are created. More...
bool	getAutoLoadResources () const
	Checks whether resources are loaded immediately after schemes are created. More...
Public Member Functions inherited from CEGUI::NamedXMLResourceManager< Scheme, Scheme_xmlHandler >
	NamedXMLResourceManager (const String &resource_type)
	Constructor. More...
virtual	~NamedXMLResourceManager ()
	Destructor.
Scheme &	createFromContainer (const RawDataContainer &source, XMLResourceExistsAction action=XREA_RETURN)
	Creates a new T object from a RawDataContainer and adds it to the collection. More...
Scheme &	createFromFile (const String &xml_filename, const String &resource_group="", XMLResourceExistsAction action=XREA_RETURN)
	Creates a new T object from an XML file and adds it to the collection. More...
Scheme &	createFromString (const String &source, XMLResourceExistsAction action=XREA_RETURN)
	Creates a new T object from a string and adds it to the collection. More...
void	destroy (const String &object_name)
	Destroy the object named object_name, or do nothing if such an object does not exist in the collection. More...
void	destroy (const Scheme &object)
	Destroy the object object, or do nothing if such an object does not exist in the collection. More...
void	destroyAll ()
	Destroy all objects.
Scheme &	get (const String &object_name) const
	Return a reference to the object named object_name. More...
bool	isDefined (const String &object_name) const
	Return whether an object named object_name exists.
void	createAll (const String &pattern, const String &resource_group)
	Create a new T object from files with names matching pattern in resource_group.
Public Member Functions inherited from CEGUI::EventSet
	EventSet ()
	Constructor for EventSet objects.
virtual	~EventSet (void)
	Destructor for EventSet objects.
void	addEvent (const String &name)
	Creates a new Event object with the given name and adds it to the EventSet. More...
void	addEvent (Event &event)
	Adds the given Event object to the EventSet. Ownership of the object passes to EventSet and it will be deleted when it is removed from the EventSet - whether explicitly via removeEvent or when the EventSet is destroyed. More...
void	removeEvent (const String &name)
	Removes the Event with the given name. All connections to the event are disconnected, and the underlying Event object is destroyed. More...
void	removeEvent (Event &event)
	Removes the given event from the EventSet. All connections to the event are disconnected, and the event object is destroyed. More...
void	removeAllEvents (void)
	Remove all Event objects from the EventSet. Add connections will be disconnected, and all Event objects destroyed.
bool	isEventPresent (const String &name)
	Checks to see if an Event with the given name is present in this EventSet. More...
virtual Event::Connection	subscribeEvent (const String &name, Event::Subscriber subscriber)
	Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
virtual Event::Connection	subscribeEvent (const String &name, Event::Group group, Event::Subscriber subscriber)
	Subscribes a handler to the specified group of the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
template<typename Arg1 , typename Arg2 >
Event::Connection	subscribeEvent (const String &name, Arg1 arg1, Arg2 arg2)
	Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
template<typename Arg1 , typename Arg2 >
Event::Connection	subscribeEvent (const String &name, Event::Group group, Arg1 arg1, Arg2 arg2)
	Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
virtual Event::Connection	subscribeScriptedEvent (const String &name, const String &subscriber_name)
	Subscribes the named Event to a scripted funtion. More...
virtual Event::Connection	subscribeScriptedEvent (const String &name, Event::Group group, const String &subscriber_name)
	Subscribes the specified group of the named Event to a scripted funtion. More...
virtual void	fireEvent (const String &name, EventArgs &args, const String &eventNamespace="")
	Fires the named event passing the given EventArgs object. More...
bool	isMuted (void) const
	Return whether the EventSet is muted or not. More...
void	setMutedState (bool setting)
	Set the mute state for this EventSet. More...
Event *	getEventObject (const String &name, bool autoAdd=false)
	Return a pointer to the Event object with the given name, optionally adding such an Event object to the EventSet if it does not already exist. More...
EventIterator	getEventIterator (void) const
	Return a EventSet::EventIterator object to iterate over the events currently added to the EventSet.

Protected Member Functions
void	doPostObjectAdditionAction (Scheme &object)
	Function called each time a new object is added to the collection.
Protected Member Functions inherited from CEGUI::NamedXMLResourceManager< Scheme, Scheme_xmlHandler >
void	destroyObject (typename ObjectRegistry::iterator ob)
	implementation of object destruction.
Scheme &	doExistingObjectAction (const String object_name, Scheme *object, const XMLResourceExistsAction action)
	function to enforce XMLResourceExistsAction policy.
Protected Member Functions inherited from CEGUI::EventSet
void	fireEvent_impl (const String &name, EventArgs &args)
	Implementation event firing member.
ScriptModule *	getScriptModule () const
	Helper to return the script module pointer or throw.
	EventSet (EventSet &)
	EventSet (const EventSet &)
EventSet &	operator= (EventSet &)
EventSet &	operator= (const EventSet &)

Protected Attributes
bool	d_autoLoadResources
	If true, Scheme::loadResources is called after "create" is called for it.
Protected Attributes inherited from CEGUI::NamedXMLResourceManager< Scheme, Scheme_xmlHandler >
const String	d_resourceType
	String holding the text for the resource type managed.
ObjectRegistry	d_objects
	the collection of objects
Protected Attributes inherited from CEGUI::EventSet
EventMap	d_events
bool	d_muted
	true if events for this EventSet have been muted.

Additional Inherited Members
Static Public Member Functions inherited from CEGUI::Singleton< SchemeManager >
static SchemeManager &	getSingleton (void)
static SchemeManager *	getSingletonPtr (void)
Static Public Attributes inherited from CEGUI::ResourceEventSet
static const String	EventNamespace
	Namespace name for all resource managers.
static const String	EventResourceCreated
static const String	EventResourceDestroyed
static const String	EventResourceReplaced
Protected Types inherited from CEGUI::NamedXMLResourceManager< Scheme, Scheme_xmlHandler >
typedef std::map< String, Scheme *, StringFastLessCompare CEGUI_MAP_ALLOC(String, Scheme *)>	ObjectRegistry
	type of collection used to store and manage objects
Protected Types inherited from CEGUI::EventSet
typedef std::map< String, Event *, StringFastLessCompare CEGUI_MAP_ALLOC(String, Event *)>	EventMap
Static Protected Attributes inherited from CEGUI::Singleton< SchemeManager >
static SchemeManager *	ms_Singleton

Detailed Description

A class that manages the creation of, access to, and destruction of GUI Scheme objects.

Member Function Documentation

bool CEGUI::SchemeManager::getAutoLoadResources

(

)

const

Checks whether resources are loaded immediately after schemes are created.

See also

SchemeManager::setAutoLoadResources

void CEGUI::SchemeManager::setAutoLoadResources

(

bool

enabled

)

If this is enabled, Schemas will immediately load their resources after they are created.

It's sometimes useful to turn this off when you want to load things more selectively. This is enabled by default.

Parameters

enabled

If true, you will have to load resources from the Scheme yourself!

Note

Calling Scheme::loadResources after you create the Scheme is equivalent to this being enabled and creating the scheme.