Cavestory Mod API
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
FontHandle Class Reference

A handle for fonts. More...

#include <CSMAPI_types.h>

Public Member Functions

void set (FontManager *fo)
 
void set (FontObject *fo)
 
void unload ()
 
 FontHandle (FontManager *fo)
 
 FontHandle (FontObject *fo)
 
 FontHandle (const char *font_name, int font_width, int font_height)
 
 FontHandle (const char *font_name, int font_width, int font_height, VideoTexture *pTexture)
 
 FontHandle (const char *font_name, int font_width, int font_height, int iMagnification)
 
void linkToTexture (VideoTexture *pTexture)
 
FontHandleoperator= (const FontHandle &t)
 
FontHandleoperator= (FontObject *&t)
 
bool operator== (const FontHandle &t) const
 
bool operator!= (const FontHandle &t) const
 
const char * getName () const
 Returns the font's name, if it exists. More...
 
 operator FontObject * ()
 Returns the font's object, if it exists. More...
 
bool isValid () const
 Check to see if this handle is valid. More...
 

Public Attributes

FontHandlenext
 
FontHandleprev
 
FontManagerobject
 

Static Public Attributes

static FontHandlefirst
 

Detailed Description

A handle for fonts.

Member Function Documentation

◆ getName()

const char* FontHandle::getName ( ) const
inline

Returns the font's name, if it exists.

Returns
Returns the font name, or NULL if this is an invalid handle.

◆ isValid()

bool FontHandle::isValid ( ) const
inline

Check to see if this handle is valid.

Returns
Returns true if the handle has a font object.

◆ operator FontObject *()

FontHandle::operator FontObject * ( )
inline

Returns the font's object, if it exists.

Returns
Returns the font object, or NULL if this is an invalid handle.

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