CL_Font Class Reference
[clanDisplay Font]

Font class. More...

#include <font.h>

Inheritance diagram for CL_Font:

List of all members.

Attributes
bool	is_null ()
	Is Null.
CL_FontProvider *	get_provider () const
	Retrieves the font provider.
Public Member Functions
Construction
	CL_Font ()
	Constructs a font.
	CL_Font (CL_GraphicContext &context, const CL_StringRef &typeface_name, int height)
	CL_Font (CL_GraphicContext &context, const CL_FontDescription &desc)
	CL_Font (CL_FontProvider *provider)
	Constructs a Font.
	CL_Font (const CL_Font &copy)
	Constructs a Font.
virtual	~CL_Font ()

---

Detailed Description

Font class.

---

Constructor & Destructor Documentation

CL_Font::CL_Font (   )

Constructs a font.

CL_Font::CL_Font (  CL_GraphicContext &  context, const CL_StringRef &  typeface_name, int  height )

CL_Font::CL_Font (  CL_GraphicContext &  context, const CL_FontDescription &  desc )

CL_Font::CL_Font (  CL_FontProvider *  provider  )

Constructs a Font. Parameters: provider  = Font Provider

CL_Font::CL_Font (  const CL_Font &  copy  )

Constructs a Font. Parameters: copy  = Font

virtual CL_Font::~CL_Font (   )  [virtual]

---

Member Function Documentation

void CL_Font::draw_text (  CL_GraphicContext &  gc, const CL_Pointf &  position, const CL_StringRef &  text, const CL_Colorf &  color = CL_Colorf::white )

Print text on gc. Multiline text (seperated by /n) is supported Parameters: gc  = Graphic Context position  = Dest position text  = The text to draw color  = The text color

void CL_Font::draw_text (  CL_GraphicContext &  gc, float  x, float  y, const CL_StringRef &  text, const CL_Colorf &  color = CL_Colorf::white )

Print text on gc. Multiline text (seperated by /n) is supported Parameters: gc  = Graphic Context x  = X position y  = Y position text  = The text to draw color  = The text color

void CL_Font::draw_text (  CL_GraphicContext &  gc, int  x, int  y, const CL_StringRef &  text, const CL_Colorf &  color = CL_Colorf::white )

Print text on gc. Multiline text (seperated by /n) is supported Parameters: gc  = Graphic Context x  = X position y  = Y position text  = The text to draw color  = The text color

int CL_Font::get_character_index (  CL_GraphicContext &  gc, const CL_String &  text, const CL_Point &  point )

Get the character index at a specified point. Multiline text (seperated by /n) is supported Parameters: gc  = The Graphic Context text  = The string point  = The point Returns: The character index. -1 = Not at specified point

CL_FontMetrics CL_Font::get_font_metrics (  CL_GraphicContext &  gc  )

Retrieves font metrics description for the selected font.

CL_FontProvider* CL_Font::get_provider (   )  const

Retrieves the font provider. Reimplemented in CL_Font_Freetype, CL_Font_Sprite, CL_Font_System, and CL_Font_Vector.

CL_Size CL_Font::get_text_size (  CL_GraphicContext &  gc, const CL_StringRef &  text )

Calculate size of text string. Multiline text (seperated by /n) is supported Note: The height also includes whitespace (to give the maximum font height), so "." and "X" returns the same height. The width is the pixel width

bool CL_Font::is_null (   )

Is Null. Returns: true = null

---

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

• font.h

---