Crazy Eddies GUI System  0.7.9
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
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 ConstBaseIterator
< ObjectRegistry
SchemeIterator
 Definition of SchemeIterator type.
 
- Public Types inherited from CEGUI::EventSet
typedef ConstBaseIterator
< EventMap > 
Iterator
 

Public Member Functions

 SchemeManager ()
 Constructor.
 
 ~SchemeManager ()
 Destructor.
 
SchemeIterator getIterator () const
 Return a SchemeManager::SchemeIterator object to iterate over the available schemes.
 
- Public Member Functions inherited from CEGUI::NamedXMLResourceManager< Scheme, Scheme_xmlHandler >
 NamedXMLResourceManager (const String &resource_type)
 Constructor. More...
 
virtual ~NamedXMLResourceManager ()
 Destructor.
 
Schemecreate (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...
 
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.
 
Schemeget (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)
 Add a new Event to the EventSet with the given name. More...
 
void removeEvent (const String &name)
 Removes the Event with the given name. All connections to the event are disconnected. More...
 
void removeAllEvents (void)
 Remove all Event objects from the EventSet. More...
 
bool isEventPresent (const String &name)
 Checks to see if an Event with the given name is present in the 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...
 
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...
 
Iterator getIterator (void) const
 Return a EventSet::Iterator 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.
 
SchemedoExistingObjectAction (const String object_name, Scheme *object, const XMLResourceExistsAction action)
 function to enforce XMLResourceExistsAction policy.
 
- Protected Member Functions inherited from CEGUI::EventSet
EventgetEventObject (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...
 
void fireEvent_impl (const String &name, EventArgs &args)
 Implementation event firing member.
 
 EventSet (EventSet &)
 
EventSetoperator= (EventSet &)
 

Additional Inherited Members

- Static Public Member Functions inherited from CEGUI::Singleton< SchemeManager >
static SchemeManagergetSingleton (void)
 
static SchemeManagergetSingletonPtr (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
*, String::FastLessCompare
ObjectRegistry
 type of collection used to store and manage objects
 
- Protected Types inherited from CEGUI::EventSet
typedef std::map< String,
Event
*, String::FastLessCompare
EventMap
 
- 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.
 
- Static Protected Attributes inherited from CEGUI::Singleton< SchemeManager >
static SchemeManagerms_Singleton
 

Detailed Description

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