Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | List of all members
om::graphics::gui::fonts::FontID Class Reference

A class that describes information about an installed font file, such as its name and file path. More...

#include <omGraphicsGUIFontID.h>

Public Member Functions

 FontID ()
 Create a default font information object that doesn't represent a valid font. More...
 
 FontID (const UTF8String &newFontPath)
 Create a new font information object with the specified path to a font file. More...
 
 FontID (const UTF8String &newFontPath, const UTF8String &newFontFamily, const UTF8String &newFontStyle)
 Create a new font information object with the specified path to a font file, family, and style. More...
 
const UTF8String & getPath () const
 Return a string representing the path to the font that is being described. More...
 
const UTF8String & getFamily () const
 Return a string which represents a human-readable name for the font family that is being described. More...
 
void setFamily (const UTF8String &newFamilyName)
 Set a string which represents a human-readable name for the font family that is being described. More...
 
const UTF8String & getStyle () const
 Return a string which represents a human-readable name for the text style that is being described. More...
 
void setStyle (const UTF8String &newStyleName)
 Set a string which represents a human-readable name for the text style that is being described. More...
 
Bool operator== (const FontID &other) const
 Return whether or not this font info object refers to the same font as another. More...
 
Bool operator!= (const FontID &other) const
 Return whether or not this font info object does not refer to the same font as another. More...
 
Bool operator< (const FontID &other) const
 Return whether or not this font ID should come before another, based on its family and style name. More...
 

Detailed Description

A class that describes information about an installed font file, such as its name and file path.

Constructor & Destructor Documentation

om::graphics::gui::fonts::FontID::FontID ( )
inline

Create a default font information object that doesn't represent a valid font.

om::graphics::gui::fonts::FontID::FontID ( const UTF8String &  newFontPath)
inline

Create a new font information object with the specified path to a font file.

om::graphics::gui::fonts::FontID::FontID ( const UTF8String &  newFontPath,
const UTF8String &  newFontFamily,
const UTF8String &  newFontStyle 
)
inline

Create a new font information object with the specified path to a font file, family, and style.

Member Function Documentation

const UTF8String& om::graphics::gui::fonts::FontID::getPath ( ) const
inline

Return a string representing the path to the font that is being described.

const UTF8String& om::graphics::gui::fonts::FontID::getFamily ( ) const
inline

Return a string which represents a human-readable name for the font family that is being described.

void om::graphics::gui::fonts::FontID::setFamily ( const UTF8String &  newFamilyName)
inline

Set a string which represents a human-readable name for the font family that is being described.

const UTF8String& om::graphics::gui::fonts::FontID::getStyle ( ) const
inline

Return a string which represents a human-readable name for the text style that is being described.

void om::graphics::gui::fonts::FontID::setStyle ( const UTF8String &  newStyleName)
inline

Set a string which represents a human-readable name for the text style that is being described.

Bool om::graphics::gui::fonts::FontID::operator== ( const FontID other) const
inline

Return whether or not this font info object refers to the same font as another.

Bool om::graphics::gui::fonts::FontID::operator!= ( const FontID other) const
inline

Return whether or not this font info object does not refer to the same font as another.

Bool om::graphics::gui::fonts::FontID::operator< ( const FontID other) const
inline

Return whether or not this font ID should come before another, based on its family and style name.


The documentation for this class was generated from the following file: