pangomm: Pango::FontFamily Class Reference

A Pango::FontFamily is used to represent a family of related font faces. More...

#include <pangomm/fontfamily.h>

Inheritance diagram for Pango::FontFamily:

[legend]

Public Member Functions
	FontFamily (FontFamily &&src) noexcept

FontFamily &	operator= (FontFamily &&src) noexcept

	~FontFamily () noexcept override

PangoFontFamily *	gobj ()
	Provides access to the underlying C GObject.

const PangoFontFamily *	gobj () const
	Provides access to the underlying C GObject.

PangoFontFamily *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

std::vector< Glib::RefPtr< FontFace > >	list_faces () const
	Lists the different font faces that make up family.

Glib::ustring	get_name () const
	Gets the name of the family.

bool	is_monospace () const
	A monospace font is a font designed for text display where the the characters form a regular grid.

bool	is_variable () const
	A variable font is a font which has axes that can be modified to produce different faces.

Glib::RefPtr< FontFace >	get_face (const Glib::ustring & name={})
	Gets the `Pango::FontFace` of family with the given name.

Glib::RefPtr< const FontFace >	get_face (const Glib::ustring & name={}) const
	Gets the `Pango::FontFace` of family with the given name.

Glib::PropertyProxy_ReadOnly< GType >	property_item_type () const
	The type of items contained in this list.

Glib::PropertyProxy_ReadOnly< unsigned int >	property_n_items () const
	The number of items contained in this list.

Glib::PropertyProxy_ReadOnly< Glib::ustring >	property_name () const
	The name of the family.

Glib::PropertyProxy_ReadOnly< bool >	property_is_monospace () const
	Is this a monospace font.

Glib::PropertyProxy_ReadOnly< bool >	property_is_variable () const
	Is this a variable font.

Public Member Functions inherited from Glib::Object
	Object (const Object &)=delete

Object &	operator= (const Object &)=delete

	Object (Object &&src) noexcept

Object &	operator= (Object &&src) noexcept

void *	get_data (const QueryQuark &key)

void	set_data (const Quark &key, void *data)

void	set_data_with_c_callback (const Quark &key, void *data, GDestroyNotify notify)

void	set_data (const Quark &key, void *data, DestroyNotify notify)

void	remove_data (const QueryQuark &quark)

void *	steal_data (const QueryQuark &quark)

Glib::RefPtr< Glib::Object >	wrap (GObject *object, bool take_copy=false)

Public Member Functions inherited from Glib::ObjectBase
	ObjectBase (const ObjectBase &)=delete

ObjectBase &	operator= (const ObjectBase &)=delete

void	set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value)

void	get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const

void	set_property (const Glib::ustring &property_name, const PropertyType &value)

void	get_property (const Glib::ustring &property_name, PropertyType &value) const

PropertyType	get_property (const Glib::ustring &property_name) const

sigc::connection	connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void()> &slot)

sigc::connection	connect_property_changed (const Glib::ustring &property_name, sigc::slot< void()> &&slot)

void	freeze_notify ()

void	thaw_notify ()

virtual void	reference () const

virtual void	unreference () const

GObject *	gobj ()

const GObject *	gobj () const

GObject *	gobj_copy () const

Public Member Functions inherited from sigc::trackable
	trackable () noexcept

	trackable (const trackable &src) noexcept

	trackable (trackable &&src) noexcept

	~trackable ()

void	add_destroy_notify_callback (notifiable *data, func_destroy_notify func) const

void	notify_callbacks ()

trackable &	operator= (const trackable &src)

trackable &	operator= (trackable &&src) noexcept

void	remove_destroy_notify_callback (notifiable *data) const

Public Member Functions inherited from Gio::ListModel
	ListModel (ListModel &&src) noexcept

ListModel &	operator= (ListModel &&src) noexcept

	~ListModel () noexcept override

GListModel *	gobj ()

const GListModel *	gobj () const

GType	get_item_type () const

guint	get_n_items () const

Glib::RefPtr< Glib::ObjectBase >	get_object (guint position)

Glib::RefPtr< const Glib::ObjectBase >	get_object (guint position) const

Glib::RefPtr< T_item >	get_typed_object (guint position)

Glib::RefPtr< const T_item >	get_typed_object (guint position) const

Glib::SignalProxy< void(guint, guint, guint)>	signal_items_changed ()

Public Member Functions inherited from Glib::Interface
	Interface ()

	Interface (Interface &&src) noexcept

Interface &	operator= (Interface &&src) noexcept

	Interface (const Glib::Interface_Class &interface_class)

	Interface (GObject *castitem)

	~Interface () noexcept override

	Interface (const Interface &)=delete

Interface &	operator= (const Interface &)=delete

GObject *	gobj ()

const GObject *	gobj () const

Static Public Member Functions
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.

Static Public Member Functions inherited from Gio::ListModel
static void	add_interface (GType gtype_implementer)

static GType	get_type ()

Related Symbols
(Note that these are not member symbols.)
Glib::RefPtr< Pango::FontFamily >	wrap (PangoFontFamily *object, bool take_copy=false)
	A Glib::wrap() method for this object.

Additional Inherited Members
Public Types inherited from Glib::Object
typedef void(*)(gpointer data	DestroyNotify)

Public Types inherited from sigc::trackable
typedef internal::func_destroy_notify	func_destroy_notify

Public Types inherited from sigc::notifiable
typedef internal::func_destroy_notify	func_destroy_notify

Protected Member Functions inherited from Glib::Object
	Object ()

	Object (const Glib::ConstructParams &construct_params)

	Object (GObject *castitem)

	~Object () noexcept override

Protected Member Functions inherited from Glib::ObjectBase
	ObjectBase ()

	ObjectBase (const char *custom_type_name)

	ObjectBase (const std::type_info &custom_type_info)

	ObjectBase (ObjectBase &&src) noexcept

ObjectBase &	operator= (ObjectBase &&src) noexcept

virtual	~ObjectBase () noexcept=0

void	initialize (GObject *castitem)

void	initialize_move (GObject castitem, Glib::ObjectBase previous_wrapper)

Protected Member Functions inherited from Gio::ListModel
	ListModel ()

void	items_changed (guint position, guint removed, guint added)

virtual GType	get_item_type_vfunc ()

virtual guint	get_n_items_vfunc ()

virtual gpointer	get_item_vfunc (guint position)

Glib::RefPtr< Gio::ListModel >	wrap (GListModel *object, bool take_copy=false)

Detailed Description

A Pango::FontFamily is used to represent a family of related font faces.

The faces in a family share a common design, but differ in slant, weight, width and other aspects.

Constructor & Destructor Documentation

◆ FontFamily()

Pango::FontFamily::FontFamily ( FontFamily && src )

noexcept

◆ ~FontFamily()

Pango::FontFamily::~FontFamily ( )

overridenoexcept

Member Function Documentation

◆ get_face() [1/2]

Glib::RefPtr< FontFace > Pango::FontFamily::get_face ( const Glib::ustring & name = {} )

Gets the Pango::FontFace of family with the given name.

Since pangomm 1.46:

Parameters

name	The name of a face. If the name is `nullptr`, the family's default face (fontconfig calls it "Regular") will be returned.

Returns: The Pango::FontFace, or nullptr if no face with the given name exists.

◆ get_face() [2/2]

Glib::RefPtr< const FontFace > Pango::FontFamily::get_face ( const Glib::ustring & name = {} ) const

Gets the Pango::FontFace of family with the given name.

Since pangomm 1.46:

Parameters

name	The name of a face. If the name is `nullptr`, the family's default face (fontconfig calls it "Regular") will be returned.

Returns: The Pango::FontFace, or nullptr if no face with the given name exists.

◆ get_name()

Glib::ustring Pango::FontFamily::get_name ( ) const

Gets the name of the family.

The name is unique among all fonts for the font backend and can be used in a Pango::FontDescription to specify that a face from this family is desired.

Returns: The name of the family. This string is owned by the family object and must not be modified or freed.

◆ get_type()

static GType Pango::FontFamily::get_type ( )

static

Get the GType for this class, for use with the underlying GObject type system.

◆ gobj() [1/2]

PangoFontFamily * Pango::FontFamily::gobj ( )

inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const PangoFontFamily * Pango::FontFamily::gobj ( ) const

inline

Provides access to the underlying C GObject.

◆ gobj_copy()

PangoFontFamily * Pango::FontFamily::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

◆ is_monospace()

bool Pango::FontFamily::is_monospace ( ) const

A monospace font is a font designed for text display where the the characters form a regular grid.

For Western languages this would mean that the advance width of all characters are the same, but this categorization also includes Asian fonts which include double-width characters: characters that occupy two grid cells. Glib::unichar_iswide() returns a result that indicates whether a character is typically double-width in a monospace font.

The best way to find out the grid-cell size is to call Pango::FontMetrics::get_approximate_digit_width(), since the results of Pango::FontMetrics::get_approximate_char_width() may be affected by double-width characters.

Since pangomm 1.4:

Returns: true if the family is monospace.

◆ is_variable()

bool Pango::FontFamily::is_variable ( ) const

A variable font is a font which has axes that can be modified to produce different faces.

Such axes are also known as variations; see Pango::FontDescription::set_variations() for more information.

Since pangomm 1.44:

Returns: true if the family is variable.

◆ list_faces()

std::vector< Glib::RefPtr< FontFace > > Pango::FontFamily::list_faces ( ) const

Lists the different font faces that make up family.

The faces in a family share a common design, but differ in slant, weight, width and other aspects.

Returns: an array of pointers to Pango::FontFace objects.

◆ operator=()

FontFamily & Pango::FontFamily::operator= ( FontFamily && src )

noexcept

◆ property_is_monospace()

Glib::PropertyProxy_ReadOnly< bool > Pango::FontFamily::property_is_monospace ( ) const

Is this a monospace font.

Since pangomm 1.52:

Default value: false

Returns: A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_is_variable()

Glib::PropertyProxy_ReadOnly< bool > Pango::FontFamily::property_is_variable ( ) const

Is this a variable font.

Since pangomm 1.52:

Default value: false

Returns: A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_item_type()

Glib::PropertyProxy_ReadOnly< GType > Pango::FontFamily::property_item_type ( ) const

The type of items contained in this list.

Since pangomm 2.52:

Returns: A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_n_items()

Glib::PropertyProxy_ReadOnly< unsigned int > Pango::FontFamily::property_n_items ( ) const

The number of items contained in this list.

Since pangomm 2.52:

Default value: 0

Returns: A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_name()

Glib::PropertyProxy_ReadOnly< Glib::ustring > Pango::FontFamily::property_name ( ) const

The name of the family.

Since pangomm 1.52:

Default value: ""

Returns: A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

Friends And Related Symbol Documentation

◆ wrap()

Glib::RefPtr< Pango::FontFamily > wrap	(	PangoFontFamily *	object,
		bool	take_copy = `false`
	)

A Glib::wrap() method for this object.

Parameters

object	The C instance.
take_copy	False if the result should take ownership of the C instance. True if it should take a new copy or ref.

Returns: A C++ instance that wraps this C instance.

Public Member Functions

Static Public Member Functions

Related Symbols

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FontFamily()

◆ ~FontFamily()

Member Function Documentation

◆ get_face() [1/2]

◆ get_face() [2/2]

◆ get_name()

◆ get_type()

◆ gobj() [1/2]

◆ gobj() [2/2]

◆ gobj_copy()

◆ is_monospace()

◆ is_variable()

◆ list_faces()

◆ operator=()

◆ property_is_monospace()

◆ property_is_variable()

◆ property_item_type()

◆ property_n_items()

◆ property_name()

Friends And Related Symbol Documentation

◆ wrap()