CL_Font Class Reference
[clanDisplay Font]

Font class. More...

#include <font.h>

Inheritance diagram for CL_Font:
Inheritance graph
[legend]

List of all members.

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 ()
Attributes

bool is_null () const
 Is Null.
CL_FontProviderget_provider () const
 Retrieves the font provider.
Operations

void draw_text (CL_GraphicContext &gc, int x, int y, const CL_StringRef &text, const CL_Colorf &color=CL_Colorf::white)
 Print text on gc.
void draw_text (CL_GraphicContext &gc, float x, float y, const CL_StringRef &text, const CL_Colorf &color=CL_Colorf::white)
 Print text on gc.
void draw_text (CL_GraphicContext &gc, const CL_Pointf &position, const CL_StringRef &text, const CL_Colorf &color=CL_Colorf::white)
 Print text on gc.
void draw_text_ellipsis (CL_GraphicContext &gc, int x, int y, CL_Rect content_box, const CL_StringRef &text, const CL_Colorf &color=CL_Colorf::white)
 Print text on gc adding elipses if it does not fit.
void draw_text_ellipsis (CL_GraphicContext &gc, float x, float y, CL_Rectf content_box, const CL_StringRef &text, const CL_Colorf &color=CL_Colorf::white)
 Print text on gc adding elipses if it does not fit.
void draw_text_ellipsis (CL_GraphicContext &gc, const CL_Pointf &position, CL_Rectf content_box, const CL_StringRef &text, const CL_Colorf &color=CL_Colorf::white)
 Print text on gc adding elipses if it does not fit.
CL_Size get_text_size (CL_GraphicContext &gc, const CL_StringRef &text)
 Calculate size of text string.
CL_Size get_glyph_size (CL_GraphicContext &gc, unsigned int glyph)
 Gets the size of a specified glyph.
CL_FontMetrics get_font_metrics ()
 Retrieves font metrics description for the selected font.
int get_character_index (CL_GraphicContext &gc, const CL_String &text, const CL_Point &point)
 Get the character index at a specified point.

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,
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
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,
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_ellipsis ( CL_GraphicContext gc,
const CL_Pointf position,
CL_Rectf  content_box,
const CL_StringRef text,
const CL_Colorf color = CL_Colorf::white 
)

Print text on gc adding elipses if it does not fit.

Multiline text (seperated by /n) is supported

Parameters:
gc = Graphic Context
position = Dest position
content_box = Rectangle the text is allowed within
text = The text to draw
color = The text color
void CL_Font::draw_text_ellipsis ( CL_GraphicContext gc,
int  x,
int  y,
CL_Rect  content_box,
const CL_StringRef text,
const CL_Colorf color = CL_Colorf::white 
)

Print text on gc adding elipses if it does not fit.

Multiline text (seperated by /n) is supported

Parameters:
gc = Graphic Context
x = X position
y = Y position
content_box = Rectangle the text is allowed within
text = The text to draw
color = The text color
void CL_Font::draw_text_ellipsis ( CL_GraphicContext gc,
float  x,
float  y,
CL_Rectf  content_box,
const CL_StringRef text,
const CL_Colorf color = CL_Colorf::white 
)

Print text on gc adding elipses if it does not fit.

Multiline text (seperated by /n) is supported

Parameters:
gc = Graphic Context
x = X position
y = Y position
content_box = Rectangle the text is allowed within
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 (  ) 

Retrieves font metrics description for the selected font.

CL_Size CL_Font::get_glyph_size ( CL_GraphicContext gc,
unsigned int  glyph 
)

Gets the size of a specified glyph.

The size is the increment value to the next glyph

Parameters:
glyph = The glyph to get
Returns:
The size
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

The size is the increment value to the next glyph

bool CL_Font::is_null (  )  const

Is Null.

Returns:
true = null

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