xtd::drawing::native::font_family Class Reference

Inheritance diagram for xtd::drawing::native::font_family:

Definition

Contains font family native API.

Namespace

xtd::drawing::native

Library

xtd.drawing.native

Warning

Internal use only

Protected Static Methods
static intptr	create (const xtd::string &name)
	Creates fontt family from name.
static void	destroy (intptr font_family)
	Destroys the font family.
static xtd::string	generic_serif_name ()
	Gets the generic serif name.
static xtd::string	generic_sans_serif_name ()
	Gets the generic sans serif name.
static xtd::string	generic_monospace_name ()
	Gets the generic monospace name.
static std::vector< xtd::string >	installed_font_families ()
	Gets the installed font families.
static int32	get_cell_ascent (intptr font_family, int32 em_height, bool bold, bool italic, bool underline, bool strikeout)
	Gets the cell ascent.
static int32	get_cell_descent (intptr font_family, int32 em_height, bool bold, bool italic, bool underline, bool strikeout)
	Gets the cell descent.
static int32	get_line_spacing (intptr font_family, int32 em_height, bool bold, bool italic, bool underline, bool strikeout)
	Gets the line spacing.
static xtd::string	get_name (intptr font_family, int32 language)
	Gets the font name for specifiedd language.
static bool	is_style_available (intptr font_family, bool bold, bool italic, bool underline, bool strikeout)
	Gets the style availability.

Member Function Documentation

create()

static intptr xtd::drawing::native::font_family::create ( const xtd::string &  name )

staticprotected

Creates fontt family from name.

Parameters

name	The name of the fontt family.

Returns

The created font family handle.

Warning

Internal use only

destroy()

static void xtd::drawing::native::font_family::destroy ( intptr  font_family )

staticprotected

Destroys the font family.

Parameters

font_family

The font family handle to destroy.

Warning

Internal use only

generic_serif_name()

static xtd::string xtd::drawing::native::font_family::generic_serif_name ( )

staticprotected

Gets the generic serif name.

Returns

The generic serif name.

Warning

Internal use only

generic_sans_serif_name()

static xtd::string xtd::drawing::native::font_family::generic_sans_serif_name ( )

staticprotected

Gets the generic sans serif name.

Returns

The generic sans serif name.

Warning

Internal use only

generic_monospace_name()

static xtd::string xtd::drawing::native::font_family::generic_monospace_name ( )

staticprotected

Gets the generic monospace name.

Returns

The generic monospace name.

Warning

Internal use only

installed_font_families()

static std::vector< xtd::string > xtd::drawing::native::font_family::installed_font_families ( )

staticprotected

Gets the installed font families.

Returns

The installed font families.

Warning

Internal use only

get_cell_ascent()

static int32 xtd::drawing::native::font_family::get_cell_ascent ( intptr  font_family, int32  em_height, bool  bold, bool  italic, bool  underline, bool  strikeout  )

staticprotected

Gets the cell ascent.

Parameters

font_family	The fontt family handle.
em_height	The em-height of the font family in pixels.
bold	true if font family is bold; otherwise false.
italic	true if font family is italic; otherwise false.
underline	true if font family is underline; otherwise false.
strikeout	true if font family is strikeout; otherwise false.

Returns

The cell ascent.

Warning

Internal use only

get_cell_descent()

static int32 xtd::drawing::native::font_family::get_cell_descent ( intptr  font_family, int32  em_height, bool  bold, bool  italic, bool  underline, bool  strikeout  )

staticprotected

Gets the cell descent.

Parameters

font_family	The fontt family handle.
em_height	The em-height of the font family in pixels.
bold	true if font family is bold; otherwise false.
italic	true if font family is italic; otherwise false.
underline	true if font family is underline; otherwise false.
strikeout	true if font family is strikeout; otherwise false.

Returns

The cell descent.

Warning

Internal use only

get_line_spacing()

static int32 xtd::drawing::native::font_family::get_line_spacing ( intptr  font_family, int32  em_height, bool  bold, bool  italic, bool  underline, bool  strikeout  )

staticprotected

Gets the line spacing.

Parameters

font_family	The fontt family handle.
em_height	The em-height of the font family in pixels.
bold	true if font family is bold; otherwise false.
italic	true if font family is italic; otherwise false.
underline	true if font family is underline; otherwise false.
strikeout	true if font family is strikeout; otherwise false.

Returns

The line spacing.

Warning

Internal use only

get_name()

static xtd::string xtd::drawing::native::font_family::get_name ( intptr  font_family, int32  language  )

staticprotected

Gets the font name for specifiedd language.

Parameters

font_family	The fontt family handle.
language	The language id for retreive the font family name.

Returns

The font tfamily name.

Remarks

To indicate language neutral, you should specify 0 for the language parameter. For a listing of the available languages and sublanguages, see the Winnt.h header file. If you have Visual Studio installed, this header file can typically be found relative to the Visual Studio installation directory at \VC\PlatformSDK\Include.

Warning

Internal use only

is_style_available()

static bool xtd::drawing::native::font_family::is_style_available ( intptr  font_family, bool  bold, bool  italic, bool  underline, bool  strikeout  )

staticprotected

Gets the style availability.

Parameters

font_family	The fontt family handle.
em_height	The em-height of the font family in pixels.
bold	true if font family is bold; otherwise false.
italic	true if font family is italic; otherwise false.
underline	true if font family is underline; otherwise false.
strikeout	true if font family is strikeout; otherwise false.

Returns

True if font family is availlable; otherwise false.

Warning

Internal use only

---

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

• xtd.drawing.native/include/xtd/drawing/native/font_family.h