cairomm: Cairo::Win32ScaledFont Class Reference

cairomm 1.19.0

Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Cairo::Win32ScaledFont Class Reference

Scaled Font implementation for Microsoft Windows fonts. More...

`#include <cairomm/win32_font.h>`

Inheritance diagram for Cairo::Win32ScaledFont:
[legend]

## Public Member Functions
void | select_font (HDC hdc)
| Selects the font into the given device context and changes the map mode and world transformation of the device context to match that of the font.
void | done_font ()
| Releases any resources allocated by select_font()
double | get_metrics_factor () const
| Gets a scale factor between logical coordinates in the coordinate space used by select_font() (that is, the coordinate system used by the Windows functions to return metrics) and font space coordinates.
void | get_logical_to_device (Matrix &logical_to_device) const
| Gets the transformation mapping the logical space used by this scaled font to device space.
void | get_device_to_logical (Matrix &device_to_logical) const
| Gets the transformation mapping device space to the logical space used by this scaled font.
Public Member Functions inherited from Cairo::ScaledFont
cobject * | cobj ()
| Provides acces to the underlying C cairo object.
const cobject * | cobj () const
| Provides acces to the underlying C cairo object.
| ScaledFont (cobject *cobj, bool has_reference=false)
| Create a C++ wrapper object from the C instance.
| ScaledFont (const ScaledFont &)=delete
ScaledFont & | operator= (const ScaledFont &)=delete
virtual | ~ScaledFont ()
void | get_extents (FontExtents &extents) const
| Gets the metrics for a ScaledFont.
void | get_text_extents (const std::string &utf8, TextExtents &extents) const
| Gets the extents for a string of text.
void | get_glyph_extents (const std::vector< Glyph > &glyphs, TextExtents &extents) const
| Gets the extents for an array of glyphs.
RefPtr< FontFace > | get_font_face () const
| The FontFace with which this ScaledFont was created.
void | get_font_options (FontOptions &options) const
| Gets the FontOptions with which the ScaledFont was created.
void | get_font_matrix (Matrix &font_matrix) const
| Gets the font matrix with which the ScaledFont was created.
void | get_ctm (Matrix &ctm) const
| Gets the CTM with which the ScaledFont was created.
FontType | get_type () const
| Gets the type of scaled Font.
void | text_to_glyphs (double x, double y, const std::string &utf8, std::vector< Glyph > &glyphs, std::vector< TextCluster > &clusters, TextClusterFlags &cluster_flags)
void | get_scale_matrix (Matrix &scale_matrix) const
| Stores the scale matrix of this scaled font into matrix.

## Static Public Member Functions
static RefPtr< Win32ScaledFont > | create (const RefPtr< Win32FontFace > &font_face, const Matrix &font_matrix, const Matrix &ctm, const FontOptions &options=FontOptions())
| Creates a scaled font for the given Win32FontFace.
Static Public Member Functions inherited from Cairo::ScaledFont
static RefPtr< ScaledFont > | create (const RefPtr< FontFace > &font_face, const Matrix &font_matrix, const Matrix &ctm, const FontOptions &options=FontOptions())
| Creates a ScaledFont object from a font face and matrices that describe the size of the font and the environment in which it will be used.

## Protected Member Functions
| Win32ScaledFont (const RefPtr< Win32FontFace > &font_face, const Matrix &font_matrix, const Matrix &ctm, const FontOptions &options=FontOptions())
Protected Member Functions inherited from Cairo::ScaledFont
| ScaledFont (const RefPtr< FontFace > &font_face, const Matrix &font_matrix, const Matrix &ctm, const FontOptions &options=FontOptions())

## Additional Inherited Members
Public Types inherited from Cairo::ScaledFont
typedef cairo_scaled_font_t | cobject
| The underlying C cairo object type.
Protected Attributes inherited from Cairo::ScaledFont
cobject * | m_cobject
| The underlying C cairo object that is wrapped by this ScaledFont.

## Detailed Description

Scaled Font implementation for Microsoft Windows fonts.

Since
  1.8

## Constructor & Destructor Documentation

## ◆ Win32ScaledFont()

Cairo::Win32ScaledFont::Win32ScaledFont | ( | const RefPtr< Win32FontFace > & | font_face,
|  | const Matrix & | font_matrix,
|  | const Matrix & | ctm,
|  | const FontOptions & | options = `FontOptions()`
| ) |  |
| protected

## Member Function Documentation

## ◆ create()

static RefPtr< Win32ScaledFont > Cairo::Win32ScaledFont::create | ( | const RefPtr< Win32FontFace > & | font_face,
|  | const Matrix & | font_matrix,
|  | const Matrix & | ctm,
|  | const FontOptions & | options = `FontOptions()`
| ) |  |
| static

Creates a scaled font for the given Win32FontFace.

Since
  1.8

## ◆ done_font()

void Cairo::Win32ScaledFont::done_font | ( |  | ) |

Releases any resources allocated by select_font()

Since
  1.8

## ◆ get_device_to_logical()

void Cairo::Win32ScaledFont::get_device_to_logical | ( | Matrix & | device_to_logical | ) | const

Gets the transformation mapping device space to the logical space used by this scaled font.

Parameters

  device_to_logical | matrix to return

Since
  1.8

## ◆ get_logical_to_device()

void Cairo::Win32ScaledFont::get_logical_to_device | ( | Matrix & | logical_to_device | ) | const

Gets the transformation mapping the logical space used by this scaled font to device space.

Parameters

  logical_to_device | matrix to return

Since
  1.8

## ◆ get_metrics_factor()

double Cairo::Win32ScaledFont::get_metrics_factor | ( |  | ) | const

Gets a scale factor between logical coordinates in the coordinate space used by select_font() (that is, the coordinate system used by the Windows functions to return metrics) and font space coordinates.

Returns
  factor to multiply logical units by to get font space coordinates.

Since
  1.8

## ◆ select_font()

void Cairo::Win32ScaledFont::select_font | ( | HDC | hdc | ) |

Selects the font into the given device context and changes the map mode and world transformation of the device context to match that of the font.

This function is intended for use when using layout APIs such as Uniscribe to do text layout with the cairo font. After finishing using the device context, you must call done_font() to release any resources allocated by this function.

See get_metrics_factor() for converting logical coordinates from the device context to font space.

Normally, calls to SaveDC() and RestoreDC() would be made around the use of this function to preserve the original graphics state.

Parameters

  scaled_font | A cairo_scaled_font_t from the Win32 font backend. Such an object can be created with Win32FontFace::create_for_logfontw().
  hdc | a device context

Since
  1.8

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

- cairomm/win32_font.h