Class providing a shared library of Font objects to the system. More...

Inheritance diagram for CEGUI::FontManager:

Collaboration diagram for CEGUI::FontManager:

Public Types
typedef ConstMapIterator < ObjectRegistry >	FontIterator
	ConstBaseIterator type definition.

Public Types inherited from CEGUI::EventSet
typedef ConstMapIterator < EventMap >	EventIterator

Public Member Functions
	FontManager ()
	Constructor.

	~FontManager ()
	Destructor.

Font &	createFreeTypeFont (const String &font_name, const float point_size, const bool anti_aliased, const String &font_filename, const String &resource_group="", const AutoScaledMode auto_scaled=ASM_Disabled, const Sizef &native_res=Sizef(640.0f, 480.0f), XMLResourceExistsAction action=XREA_RETURN)
	Creates a FreeType type font. More...

Font &	createPixmapFont (const String &font_name, const String &imageset_filename, const String &resource_group="", const AutoScaledMode auto_scaled=ASM_Disabled, const Sizef &native_res=Sizef(640.0f, 480.0f), XMLResourceExistsAction action=XREA_RETURN)
	Creates a Pixmap type font. More...

void	notifyDisplaySizeChanged (const Sizef &size)
	Notify the FontManager that display size may have changed. More...

void	writeFontToStream (const String &name, OutStream &out_stream) const
	Writes a full XML font file for the specified Font to the given OutStream. More...

FontIterator	getIterator () const
	Return a FontManager::FontIterator object to iterate over the available Font objects.

Public Member Functions inherited from CEGUI::NamedXMLResourceManager< Font, Font_xmlHandler >
	NamedXMLResourceManager (const String &resource_type)
	Constructor. More...

virtual	~NamedXMLResourceManager ()
	Destructor.

Font &	createFromContainer (const RawDataContainer &source, XMLResourceExistsAction action=XREA_RETURN)
	Creates a new T object from a RawDataContainer and adds it to the collection. More...

Font &	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...

Font &	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 Font &object)
	Destroy the object object, or do nothing if such an object does not exist in the collection. More...

void	destroyAll ()
	Destroy all objects.

Font &	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.

Additional Inherited Members
Static Public Member Functions inherited from CEGUI::Singleton< FontManager >
static FontManager &	getSingleton (void)

static FontManager *	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< Font, Font_xmlHandler >
typedef std::map< String, Font , StringFastLessCompare CEGUI_MAP_ALLOC(String, Font )>	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

Protected Member Functions inherited from CEGUI::NamedXMLResourceManager< Font, Font_xmlHandler >
void	destroyObject (typename ObjectRegistry::iterator ob)
	implementation of object destruction.

Font &	doExistingObjectAction (const String object_name, Font *object, const XMLResourceExistsAction action)
	function to enforce XMLResourceExistsAction policy.

virtual void	doPostObjectAdditionAction (Font &object)
	Function called each time a new object is added to the collection.

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 &	operator= (EventSet &)

Protected Attributes inherited from CEGUI::NamedXMLResourceManager< Font, Font_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< FontManager >
static FontManager *	ms_Singleton

Detailed Description

Class providing a shared library of Font objects to the system.

The FontManager is used to create, access, and destroy Font objects. The idea is that the FontManager will function as a central repository for Font objects used within the GUI system, and that those Font objects can be accessed, via a unique name, by any interested party within the system.

Member Function Documentation

Font& CEGUI::FontManager::createFreeTypeFont	(	const String &	font_name,
		const float	point_size,
		const bool	anti_aliased,
		const String &	font_filename,
		const String &	resource_group = `""`,
		const AutoScaledMode	auto_scaled = `ASM_Disabled`,
		const Sizef &	native_res = `Sizef(640.0f, 480.0f)`,
		XMLResourceExistsAction	action = `XREA_RETURN`
	)

Creates a FreeType type font.

Parameters

font_name	The name that the font will use within the CEGUI system.
point_size	Specifies the point size that the font is to be rendered at.
anti_aliased	Specifies whether the font should be rendered using anti aliasing.
font_filename	The filename of an font file that will be used as the source for glyph images for this font.
resource_group	The resource group identifier to use when loading the font file specified by font_filename.
auto_scaled	Specifies whether the font imagery should be automatically scaled to maintain the same physical size (which is calculated by using the native resolution setting).
native_horz_res	The horizontal native resolution value. This is only significant when auto scaling is enabled.
native_vert_res	The vertical native resolution value. This is only significant when auto scaling is enabled.
action	One of the XMLResourceExistsAction enumerated values indicating what action should be taken when a Font with the specified name already exists.

Returns: Reference to the newly create Font object.

Font& CEGUI::FontManager::createPixmapFont	(	const String &	font_name,
		const String &	imageset_filename,
		const String &	resource_group = `""`,
		const AutoScaledMode	auto_scaled = `ASM_Disabled`,
		const Sizef &	native_res = `Sizef(640.0f, 480.0f)`,
		XMLResourceExistsAction	action = `XREA_RETURN`
	)

Creates a Pixmap type font.

Parameters

font_name	The name that the font will use within the CEGUI system.
imageset_filename	The filename of an imageset to load that will be used as the source for glyph images for this font. If resource_group is the special value of "*", this parameter may instead refer to the name of an already loaded Imagset.
resource_group	The resource group identifier to use when loading the imageset file specified by imageset_filename. If this group is set to the special value of "", then imageset_filename* instead will refer to the name of an existing Imageset.
auto_scaled	Specifies whether the font imagery should be automatically scaled to maintain the same physical size (which is calculated by using the native resolution setting).
native_horz_res	The horizontal native resolution value. This is only significant when auto scaling is enabled.
native_vert_res	The vertical native resolution value. This is only significant when auto scaling is enabled.
action	One of the XMLResourceExistsAction enumerated values indicating what action should be taken when a Font with the specified name already exists.

Returns: Reference to the newly create Font object.

void CEGUI::FontManager::notifyDisplaySizeChanged ( const Sizef & size )

Notify the FontManager that display size may have changed.

Parameters

size	Size object describing the display resolution

void CEGUI::FontManager::writeFontToStream	(	const String &	name,
		OutStream &	out_stream
	)		const

Writes a full XML font file for the specified Font to the given OutStream.

Parameters

name	String holding the name of the Font to be written to the stream.
out_stream	OutStream (std::ostream based) object where data is to be sent.

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation