A Pango::FontFamily is used to represent a family of related font faces. More...
#include <pangomm/fontfamily.h>
Public Member Functions | |
| FontFamily (FontFamily && src) noexcept | |
| FontFamily & | operator= (FontFamily && src) noexcept |
| ~FontFamily () noexcept override | |
| PangoFontFamily * | gobj () |
| Provides access to the underlying C GObject. More... | |
| const PangoFontFamily * | gobj () const |
| Provides access to the underlying C GObject. More... | |
| PangoFontFamily * | gobj_copy () |
| Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More... | |
| std::vector< Glib::RefPtr< FontFace > > | list_faces () const |
| Lists the different font faces that make up family. More... | |
| Glib::ustring | get_name () const |
| Gets the name of the family. More... | |
| bool | is_monospace () const |
| A monospace font is a font designed for text display where the the characters form a regular grid. More... | |
| bool | is_variable () const |
| A variable font is a font which has axes that can be modified to produce different faces. More... | |
| Glib::RefPtr< FontFace > | get_face (const Glib::ustring & name={}) |
Gets the Pango::FontFace of family with the given name. More... | |
| Glib::RefPtr< const FontFace > | get_face (const Glib::ustring & name={}) const |
Gets the Pango::FontFace of family with the given name. More... | |
| Glib::PropertyProxy_ReadOnly< GType > | property_item_type () const |
| The type of items contained in this list. More... | |
| Glib::PropertyProxy_ReadOnly< unsigned int > | property_n_items () const |
| The number of items contained in this list. More... | |
| Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_name () const |
| The name of the family. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_is_monospace () const |
| Is this a monospace font. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_is_variable () const |
| Is this a variable font. More... | |
Static Public Member Functions | |
| static GType | get_type () |
| Get the GType for this class, for use with the underlying GObject type system. More... | |
Related Functions | |
(Note that these are not member functions.) | |
| Glib::RefPtr< Pango::FontFamily > | wrap (PangoFontFamily * object, bool take_copy=false) |
| A Glib::wrap() method for this object. More... | |
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()
|
noexcept |
◆ ~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.
- 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, ornullptrif 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.
- 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, ornullptrif 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 |
Get the GType for this class, for use with the underlying GObject type system.
◆ gobj() [1/2]
|
inline |
Provides access to the underlying C GObject.
◆ gobj() [2/2]
|
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.
- Returns
trueif 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.
- Returns
trueif 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=()
|
noexcept |
◆ property_is_monospace()
| Glib::PropertyProxy_ReadOnly< bool > Pango::FontFamily::property_is_monospace | ( | ) | const |
Is this a monospace font.
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.
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.
- 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.
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.
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 Function Documentation
◆ wrap()
|
related |
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.
