Public Types | |
|
typedef ConstBaseIterator< FontRegistry > | FontIterator |
Public Member Functions | |
| FontManager (void) | |
| Constructor for FontManager objects. | |
| ~FontManager (void) | |
| Destructor for FontManager objects. | |
| Font * | createFont (const String &filename, const String &resourceGroup="") |
| Creates a new font from a font definition file, and returns a pointer to the new Font object. | |
| Font * | createFont (const String &type, const String &name, const String &fontname, const String &resourceGroup="") |
| Creates a new Font based on a true-type font, and returns a pointer to the new Font object. | |
| Font * | createFont (const String &type, const XMLAttributes &attributes) |
| Create a new font object given its type and the XML attributes. | |
| void | destroyFont (const String &name) |
| Destroy's the font with the given name. | |
| void | destroyFont (Font *font) |
| Destroys the given Font object. | |
| void | destroyAllFonts (void) |
| Destroys all Font objects registered in the system. | |
| bool | isFontPresent (const String &name) const |
| Checks the existence of a given font. | |
| Font * | getFont (const String &name) const |
| Returns a pointer to the font object with the specified name. | |
| void | notifyScreenResolution (const Size &size) |
| Notify the FontManager of the current (usually new) display resolution. | |
| void | writeFontToStream (const String &name, OutStream &out_stream) const |
| Writes a full XML font file for the specified Font to the given OutStream. | |
| FontIterator | getIterator (void) const |
| Return a FontManager::FontIterator object to iterate over the available Font objects. | |
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.
| Font * CEGUI::FontManager::createFont | ( | const String & | type, | |
| const XMLAttributes & | attributes | |||
| ) |
Create a new font object given its type and the XML attributes.
| Font * CEGUI::FontManager::createFont | ( | const String & | type, | |
| const String & | name, | |||
| const String & | fontname, | |||
| const String & | resourceGroup = "" | |||
| ) |
Creates a new Font based on a true-type font, and returns a pointer to the new Font object.
| type | String object containing the type of the font to be created (same as in the "Type" attribute of the font XML). | |
| name | String object containing a unique name for the new font. | |
| fontname | String object containing the name and path of the true-type font to access. | |
| resourceGroup | Resource group identifier to be passed to the resource provider when loading the font definition file. |
| AlreadyExistsException | thrown if a Font already exists with the name specified, or if a font Imageset clashes with one already defined in the system. | |
| GenericException | thrown if something goes wrong while accessing a true-type font referenced in file fontname. | |
| RendererException | thrown if the Renderer can't support a texture large enough to hold the requested glyph imagery. | |
| MemoryException | thrown if allocation of imagery construction buffer fails. |
| Font * CEGUI::FontManager::createFont | ( | const String & | filename, | |
| const String & | resourceGroup = "" | |||
| ) |
Creates a new font from a font definition file, and returns a pointer to the new Font object.
| filename | String object containing the filename of a 'font definition file' what will be used to create the new font | |
| resourceGroup | Resource group identifier to pass to the resource provider when loading the font definition file. |
| FileIOException | thrown if there was some problem accessing or parsing the file filename | |
| InvalidRequestException | thrown if an invalid filename was provided. | |
| AlreadyExistsException | thrown if a Font already exists with the name specified, or if a font Imageset clashes with one already defined in the system. | |
| GenericException | thrown if something goes wrong while accessing a true-type font referenced in file filename. | |
| RendererException | thrown if the Renderer can't support a texture large enough to hold the requested glyph imagery. | |
| MemoryException | thrown if allocation of imagery construction buffer fails. |
| void CEGUI::FontManager::destroyAllFonts | ( | void | ) |
| void CEGUI::FontManager::destroyFont | ( | Font * | font | ) |
| void CEGUI::FontManager::destroyFont | ( | const String & | name | ) |
Destroy's the font with the given name.
| name | String object containing the name of the font to be destroyed. If the specified font does not exist, nothing happens. |
Returns a pointer to the font object with the specified name.
| UnknownObjectException | Thrown if no font with the given name exists. |
| bool CEGUI::FontManager::isFontPresent | ( | const String & | name | ) | const |
| void CEGUI::FontManager::notifyScreenResolution | ( | const Size & | size | ) |
Notify the FontManager of the current (usually new) display resolution.
| size | Size object describing the display resolution |
1.4.7