cairoLib.FontOption.FontOption Class Reference

List of all members.

Detailed Description

Description.


Public Member Functions

cairo_font_options_tgetFontOptionStruct ()
 this (cairo_font_options_t *cairo_font_options)
 Sets our main struct and passes it to the parent class.
cairo_font_options_tcopy ()
 Allocates a new font options object copying the option values from original.
void destroy ()
 Destroys a cairo_font_options_t object created with with cairo_font_options_create() or cairo_font_options_copy().
cairo_status_t status ()
 Checks whether an error has previously occurred for this font options object options: a cairo_font_options_t Returns: CAIRO_STATUS_SUCCESS or CAIRO_STATUS_NO_MEMORY.
void merge (cairo_font_options_t *other)
 Merges non-default options from other into options, replacing existing values.
ulong hash ()
 Compute a hash for the font options object; this value will be useful when storing an object containing a cairo_font_options_t in a hash table.
cairo_bool_t equal (cairo_font_options_t *other)
 Compares two font options objects for equality.
void setAntialias (cairo_antialias_t antialias)
 Sets the antiliasing mode for the font options object.
cairo_antialias_t getAntialias ()
 Gets the antialising mode for the font options object.
void setSubpixelOrder (cairo_subpixel_order_t subpixelOrder)
 Sets the subpixel order for the font options object.
cairo_subpixel_order_t getSubpixelOrder ()
 Gets the subpixel order for the font options object.
void setHintStyle (cairo_hint_style_t hintStyle)
 Sets the hint style for font outlines for the font options object.
cairo_hint_style_t getHintStyle ()
 Gets the hint style for font outlines for the font options object.
void setHintMetrics (cairo_hint_metrics_t hintMetrics)
 Sets the metrics hinting mode for the font options object.
cairo_hint_metrics_t getHintMetrics ()
 Gets the metrics hinting mode for the font options object.

Static Public Member Functions

static cairo_font_options_tcreate ()
 Allocates a new font options object with all options initialized to default values.

Protected Member Functions

void * getStruct ()
 the main Gtk struct as a void*

Protected Attributes

cairo_font_options_tcairo_font_options
 the main Gtk struct


Constructor & Destructor Documentation

cairoLib.FontOption.FontOption.this ( cairo_font_options_t cairo_font_options  ) 

Sets our main struct and passes it to the parent class.


Member Function Documentation

cairo_font_options_t* cairoLib.FontOption.FontOption.copy (  ) 

Allocates a new font options object copying the option values from original.

original: a cairo_font_options_t Returns: a newly allocated cairo_font_options_t. Free with cairo_font_options_destroy(). This function always returns a valid pointer; if memory cannot be allocated, then a special error object is returned where all operations on the object do nothing. You can check for this with cairo_font_options_status().

static cairo_font_options_t* cairoLib.FontOption.FontOption.create (  )  [static]

Allocates a new font options object with all options initialized to default values.

Returns: a newly allocated cairo_font_options_t. Free with cairo_font_options_destroy(). This function always returns a valid pointer; if memory cannot be allocated, then a special error object is returned where all operations on the object do nothing. You can check for this with cairo_font_options_status().

void cairoLib.FontOption.FontOption.destroy (  ) 

Destroys a cairo_font_options_t object created with with cairo_font_options_create() or cairo_font_options_copy().

options: a cairo_font_options_t

cairo_bool_t cairoLib.FontOption.FontOption.equal ( cairo_font_options_t other  ) 

Compares two font options objects for equality.

options: a cairo_font_options_t other: another cairo_font_options_t Returns: TRUE if all fields of the two font options objects match

cairo_antialias_t cairoLib.FontOption.FontOption.getAntialias (  ) 

Gets the antialising mode for the font options object.

options: a cairo_font_options_t Returns: the antialiasing mode

cairo_font_options_t* cairoLib.FontOption.FontOption.getFontOptionStruct (  ) 

cairo_hint_metrics_t cairoLib.FontOption.FontOption.getHintMetrics (  ) 

Gets the metrics hinting mode for the font options object.

See the documentation for cairo_hint_metrics_t for full details. options: a cairo_font_options_t Returns: the metrics hinting mode for the font options object

cairo_hint_style_t cairoLib.FontOption.FontOption.getHintStyle (  ) 

Gets the hint style for font outlines for the font options object.

See the documentation for cairo_hint_style_t for full details. options: a cairo_font_options_t Returns: the hint style for the font options object

void* cairoLib.FontOption.FontOption.getStruct (  )  [protected]

the main Gtk struct as a void*

cairo_subpixel_order_t cairoLib.FontOption.FontOption.getSubpixelOrder (  ) 

Gets the subpixel order for the font options object.

See the documentation for cairo_subpixel_order_t for full details. options: a cairo_font_options_t Returns: the subpixel order for the font options object

ulong cairoLib.FontOption.FontOption.hash (  ) 

Compute a hash for the font options object; this value will be useful when storing an object containing a cairo_font_options_t in a hash table.

options: a cairo_font_options_t Returns: the hash value for the font options object. The return value can be cast to a 32-bit type if a 32-bit hash value is needed.

void cairoLib.FontOption.FontOption.merge ( cairo_font_options_t other  ) 

Merges non-default options from other into options, replacing existing values.

This operation can be thought of as somewhat similar to compositing other onto options with the operation of CAIRO_OPERATION_OVER. options: a cairo_font_options_t other: another cairo_font_options_t

void cairoLib.FontOption.FontOption.setAntialias ( cairo_antialias_t  antialias  ) 

Sets the antiliasing mode for the font options object.

This specifies the type of antialiasing to do when rendering text. options: a cairo_font_options_t antialias: the new antialiasing mode

void cairoLib.FontOption.FontOption.setHintMetrics ( cairo_hint_metrics_t  hintMetrics  ) 

Sets the metrics hinting mode for the font options object.

This controls whether metrics are quantized to integer values in device units. See the documentation for cairo_hint_metrics_t for full details. options: a cairo_font_options_t hint_metrics: the new metrics hinting mode

void cairoLib.FontOption.FontOption.setHintStyle ( cairo_hint_style_t  hintStyle  ) 

Sets the hint style for font outlines for the font options object.

This controls whether to fit font outlines to the pixel grid, and if so, whether to optimize for fidelity or contrast. See the documentation for cairo_hint_style_t for full details. options: a cairo_font_options_t hint_style: the new hint style

void cairoLib.FontOption.FontOption.setSubpixelOrder ( cairo_subpixel_order_t  subpixelOrder  ) 

Sets the subpixel order for the font options object.

The subpixel order specifies the order of color elements within each pixel on the display device when rendering with an antialiasing mode of CAIRO_ANTIALIAS_SUBPIXEL. See the documentation for cairo_subpixel_order_t for full details. options: a cairo_font_options_t subpixel_order: the new subpixel order

cairo_status_t cairoLib.FontOption.FontOption.status (  ) 

Checks whether an error has previously occurred for this font options object options: a cairo_font_options_t Returns: CAIRO_STATUS_SUCCESS or CAIRO_STATUS_NO_MEMORY.


Member Data Documentation

cairo_font_options_t* cairoLib.FontOption.FontOption.cairo_font_options [protected]

the main Gtk struct


SourceForge.net Logo DSource.org Logo digitalmars.com Logo