Font description class. More...

#include <font_description.h>

Public Types

enum  Charset {
  charset_default, charset_ansi, charset_baltic, charset_chinesebig5,
  charset_easteurope, charset_gb2312, charset_greek, charset_hangul,
  charset_mac, charset_oem, charset_russian, charset_shiftjis,
  charset_symbol, charset_turkish, charset_vietnamese, charset_johab,
  charset_arabic, charset_hebrew, charset_thai
}
 

Public Member Functions

 FontDescription ()
 Constructs a font description with default values. More...
 
virtual ~FontDescription ()
 
FontDescription clone () const
 
bool get_anti_alias () const
 Get the font anti-alias setting (defaults to true) More...
 
float get_average_width () const
 Returns the font average width. More...
 
Charset get_charset () const
 Get the font charset More...
 
float get_escapement () const
 Returns the font escapement. More...
 
float get_height () const
 Returns the font height. More...
 
float get_line_height () const
 Returns the distance between each line. More...
 
float get_orientation () const
 Returns the font orientation. More...
 
FontStyle get_style () const
 Returns the font style. More...
 
bool get_subpixel () const
 Get the font subpixel rendering setting (defaults to true) More...
 
std::string get_unique_id () const
 Returns an unique string identifying this font description. More...
 
FontWeight get_weight () const
 Returns the font weight. More...
 
bool is_null () const
 Returns true if this object is invalid. More...
 
 operator bool () const
 
FontDescriptionoperator= (const FontDescription &copy)
 Copy assignment operator (does not copy the description, use clone() if you want that) More...
 
bool operator== (const FontDescription &other) const
 Returns true if the font is identical Line_height is excluded. More...
 
void set_anti_alias (bool setting=true)
 Sets the font anti-alias setting (defaults to true) More...
 
void set_average_width (float value=0.0f)
 Sets the font average width. More...
 
void set_charset (Charset new_charset)
 Sets the font charset (defaults to charset_default) More...
 
void set_escapement (float value)
 Sets the font escapement. More...
 
void set_height (float value=20.0f)
 Sets the font height. More...
 
void set_line_height (float height)
 Sets the distance between each line. More...
 
void set_orientation (float value)
 Sets the font orientation. More...
 
void set_style (FontStyle setting=FontStyle::normal)
 Sets the font style. More...
 
void set_subpixel (bool setting=true)
 Sets the font subpixel rendering setting (defaults to true) More...
 
void set_weight (FontWeight value=FontWeight::normal)
 Sets the font weight. More...
 
void throw_if_null () const
 Throw an exception if this object is invalid. More...
 

Static Public Member Functions

static FontDescription create_null_object ()
 Create null object. More...
 

Detailed Description

Font description class.

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

Constructor & Destructor Documentation

clan::FontDescription::FontDescription ( )

Constructs a font description with default values.

virtual clan::FontDescription::~FontDescription ( )
virtual

Member Function Documentation

FontDescription clan::FontDescription::clone ( ) const
static FontDescription clan::FontDescription::create_null_object ( )
static

Create null object.

Returns
Font Description
bool clan::FontDescription::get_anti_alias ( ) const

Get the font anti-alias setting (defaults to true)

float clan::FontDescription::get_average_width ( ) const

Returns the font average width.

0.0f = Use default

Charset clan::FontDescription::get_charset ( ) const

Get the font charset

float clan::FontDescription::get_escapement ( ) const

Returns the font escapement.

float clan::FontDescription::get_height ( ) const

Returns the font height.

float clan::FontDescription::get_line_height ( ) const

Returns the distance between each line.

float clan::FontDescription::get_orientation ( ) const

Returns the font orientation.

FontStyle clan::FontDescription::get_style ( ) const

Returns the font style.

bool clan::FontDescription::get_subpixel ( ) const

Get the font subpixel rendering setting (defaults to true)

std::string clan::FontDescription::get_unique_id ( ) const

Returns an unique string identifying this font description.

This is useful for placing font descriptions in a map. Line_height is excluded.

FontWeight clan::FontDescription::get_weight ( ) const

Returns the font weight.

bool clan::FontDescription::is_null ( ) const
inline

Returns true if this object is invalid.

clan::FontDescription::operator bool ( ) const
inlineexplicit
FontDescription& clan::FontDescription::operator= ( const FontDescription copy)

Copy assignment operator (does not copy the description, use clone() if you want that)

bool clan::FontDescription::operator== ( const FontDescription other) const

Returns true if the font is identical Line_height is excluded.

void clan::FontDescription::set_anti_alias ( bool  setting = true)

Sets the font anti-alias setting (defaults to true)

void clan::FontDescription::set_average_width ( float  value = 0.0f)

Sets the font average width.

0.0f = Use default

void clan::FontDescription::set_charset ( Charset  new_charset)

Sets the font charset (defaults to charset_default)

Parameters
new_charset= The charset. charset_default = Use operating systems default
void clan::FontDescription::set_escapement ( float  value)

Sets the font escapement.

void clan::FontDescription::set_height ( float  value = 20.0f)

Sets the font height.

void clan::FontDescription::set_line_height ( float  height)

Sets the distance between each line.

void clan::FontDescription::set_orientation ( float  value)

Sets the font orientation.

void clan::FontDescription::set_style ( FontStyle  setting = FontStyle::normal)

Sets the font style.

void clan::FontDescription::set_subpixel ( bool  setting = true)

Sets the font subpixel rendering setting (defaults to true)

void clan::FontDescription::set_weight ( FontWeight  value = FontWeight::normal)

Sets the font weight.

void clan::FontDescription::throw_if_null ( ) const

Throw an exception if this object is invalid.


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