CL_FontDescription Class Reference
[clanDisplay Font]

Font description class. More...

#include <font_description.h>

List of all members.

Construction
	CL_FontDescription ()
	Constructs a font description with default values.
	CL_FontDescription (const CL_FontDescription &copy)
	Constructs a FontDescription.
virtual	~CL_FontDescription ()
static CL_FontDescription	create_null_object ()
	Create null object.
Public Member Functions
Attributes
bool	is_null () const
	Is Null.
const CL_String &	get_typeface_name () const
	Returns the typeface name.
int	get_height () const
	Returns the font height.
int	get_average_width () const
	Returns the font average width.
float	get_escapement () const
	Returns the font escapement.
float	get_orientation () const
	Returns the font orientation.
int	get_weight () const
	Returns the font weight.
bool	get_italic () const
	Returns the font italic setting.
bool	get_underline () const
	Returns the font underline setting.
bool	get_strikeout () const
	Returns the font strikeout setting.
bool	get_fixed_pitch () const
	Returns the font fixed pitch setting.
bool	get_anti_alias () const
	Get the font anti-alias setting.
bool	get_anti_alias_set () const
	Returns true if set_anti_alias() was called. (Else, the anti-alias default setting depends on the implementation.
bool	operator== (const CL_FontDescription &other) const
	Returns true if the font is identical.
Operations
CL_FontDescription &	operator= (const CL_FontDescription &copy)
	Copy assignment operator.
void	clone (const CL_FontDescription &copy)
void	set_typeface_name (const CL_String &name)
	Sets the typeface name.
void	set_height (int value)
	Sets the font height.
void	set_average_width (int value)
	Sets the font average width.
void	set_escapement (float value)
	Sets the font escapement.
void	set_orientation (float value)
	Sets the font orientation.
void	set_weight (int value)
	Sets the font weight.
void	set_italic (bool setting=true)
	Sets the font italic setting.
void	set_underline (bool setting=true)
	Sets the font underline setting.
void	set_strikeout (bool setting=true)
	Sets the font strikeout setting.
void	set_fixed_pitch (bool setting=true)
	Sets the font fixed pitch setting.
void	set_anti_alias (bool setting=true)
	Sets the font anti-alias setting.

---

Detailed Description

Font description class.

This class allows you to setup a more advanced description when creating a font.

---

Constructor & Destructor Documentation

CL_FontDescription::CL_FontDescription (   )

Constructs a font description with default values.

CL_FontDescription::CL_FontDescription (  const CL_FontDescription &  copy  )

Constructs a FontDescription. Parameters: copy  = Font Description

virtual CL_FontDescription::~CL_FontDescription (   )  [virtual]

---

Member Function Documentation

void CL_FontDescription::clone (  const CL_FontDescription &  copy  )

static CL_FontDescription CL_FontDescription::create_null_object (   )  [static]

Create null object. Returns: Font Description

bool CL_FontDescription::get_anti_alias (   )  const

Get the font anti-alias setting.

bool CL_FontDescription::get_anti_alias_set (   )  const

Returns true if set_anti_alias() was called. (Else, the anti-alias default setting depends on the implementation.

int CL_FontDescription::get_average_width (   )  const

Returns the font average width.

float CL_FontDescription::get_escapement (   )  const

Returns the font escapement.

bool CL_FontDescription::get_fixed_pitch (   )  const

Returns the font fixed pitch setting.

int CL_FontDescription::get_height (   )  const

Returns the font height.

bool CL_FontDescription::get_italic (   )  const

Returns the font italic setting.

float CL_FontDescription::get_orientation (   )  const

Returns the font orientation.

bool CL_FontDescription::get_strikeout (   )  const

Returns the font strikeout setting.

const CL_String& CL_FontDescription::get_typeface_name (   )  const

Returns the typeface name.

bool CL_FontDescription::get_underline (   )  const

Returns the font underline setting.

int CL_FontDescription::get_weight (   )  const

Returns the font weight.

bool CL_FontDescription::is_null (   )  const

Is Null. Returns: true = null

CL_FontDescription& CL_FontDescription::operator= (  const CL_FontDescription &  copy  )

Copy assignment operator.

bool CL_FontDescription::operator== (  const CL_FontDescription &  other  )  const

Returns true if the font is identical.

void CL_FontDescription::set_anti_alias (  bool  setting = true  )

Sets the font anti-alias setting.

void CL_FontDescription::set_average_width (  int  value  )

Sets the font average width.

void CL_FontDescription::set_escapement (  float  value  )

Sets the font escapement.

void CL_FontDescription::set_fixed_pitch (  bool  setting = true  )

Sets the font fixed pitch setting.

void CL_FontDescription::set_height (  int  value  )

Sets the font height.

void CL_FontDescription::set_italic (  bool  setting = true  )

Sets the font italic setting.

void CL_FontDescription::set_orientation (  float  value  )

Sets the font orientation.

void CL_FontDescription::set_strikeout (  bool  setting = true  )

Sets the font strikeout setting.

void CL_FontDescription::set_typeface_name (  const CL_String &  name  )

Sets the typeface name.

void CL_FontDescription::set_underline (  bool  setting = true  )

Sets the font underline setting.

void CL_FontDescription::set_weight (  int  value  )

Sets the font weight.

---

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

• font_description.h

---