Fonts

Fonts — Structures representing abstract fonts

Synopsis



            PangoFontDescription;
#define     PANGO_TYPE_FONT_DESCRIPTION
enum        PangoStyle;
#define     PANGO_TYPE_STYLE
enum        PangoWeight;
#define     PANGO_TYPE_WEIGHT
enum        PangoVariant;
#define     PANGO_TYPE_VARIANT
enum        PangoStretch;
#define     PANGO_TYPE_STRETCH
enum        PangoFontMask;
#define     PANGO_TYPE_FONT_MASK
PangoFontDescription* pango_font_description_new
                                            (void);
PangoFontDescription* pango_font_description_copy
                                            (const PangoFontDescription *desc);
PangoFontDescription* pango_font_description_copy_static
                                            (const PangoFontDescription *desc);
guint       pango_font_description_hash     (const PangoFontDescription *desc);
gboolean    pango_font_description_equal    (const PangoFontDescription *desc1,
                                             const PangoFontDescription *desc2);
void        pango_font_description_free     (PangoFontDescription *desc);
void        pango_font_descriptions_free    (PangoFontDescription **descs,
                                             int n_descs);
void        pango_font_description_set_family
                                            (PangoFontDescription *desc,
                                             const char *family);
void        pango_font_description_set_family_static
                                            (PangoFontDescription *desc,
                                             const char *family);
const char* pango_font_description_get_family
                                            (const PangoFontDescription *desc);
void        pango_font_description_set_style
                                            (PangoFontDescription *desc,
                                             PangoStyle style);
PangoStyle  pango_font_description_get_style
                                            (const PangoFontDescription *desc);
void        pango_font_description_set_variant
                                            (PangoFontDescription *desc,
                                             PangoVariant variant);
PangoVariant pango_font_description_get_variant
                                            (const PangoFontDescription *desc);
void        pango_font_description_set_weight
                                            (PangoFontDescription *desc,
                                             PangoWeight weight);
PangoWeight pango_font_description_get_weight
                                            (const PangoFontDescription *desc);
void        pango_font_description_set_stretch
                                            (PangoFontDescription *desc,
                                             PangoStretch stretch);
PangoStretch pango_font_description_get_stretch
                                            (const PangoFontDescription *desc);
void        pango_font_description_set_size (PangoFontDescription *desc,
                                             gint size);
gint        pango_font_description_get_size (const PangoFontDescription *desc);
void        pango_font_description_set_absolute_size
                                            (PangoFontDescription *desc,
                                             double size);
gboolean    pango_font_description_get_size_is_absolute
                                            (const PangoFontDescription *desc);
PangoFontMask pango_font_description_get_set_fields
                                            (const PangoFontDescription *desc);
void        pango_font_description_unset_fields
                                            (PangoFontDescription *desc,
                                             PangoFontMask to_unset);
void        pango_font_description_merge    (PangoFontDescription *desc,
                                             const PangoFontDescription *desc_to_merge,
                                             gboolean replace_existing);
void        pango_font_description_merge_static
                                            (PangoFontDescription *desc,
                                             const PangoFontDescription *desc_to_merge,
                                             gboolean replace_existing);
gboolean    pango_font_description_better_match
                                            (const PangoFontDescription *desc,
                                             const PangoFontDescription *old_match,
                                             const PangoFontDescription *new_match);
PangoFontDescription* pango_font_description_from_string
                                            (const char *str);
char*       pango_font_description_to_string
                                            (const PangoFontDescription *desc);
char*       pango_font_description_to_filename
                                            (const PangoFontDescription *desc);

            PangoFontMetrics;
#define     PANGO_TYPE_FONT_METRICS
PangoFontMetrics* pango_font_metrics_ref    (PangoFontMetrics *metrics);
void        pango_font_metrics_unref        (PangoFontMetrics *metrics);
int         pango_font_metrics_get_ascent   (PangoFontMetrics *metrics);
int         pango_font_metrics_get_descent  (PangoFontMetrics *metrics);
int         pango_font_metrics_get_approximate_char_width
                                            (PangoFontMetrics *metrics);
int         pango_font_metrics_get_approximate_digit_width
                                            (PangoFontMetrics *metrics);
int         pango_font_metrics_get_underline_thickness
                                            (PangoFontMetrics *metrics);
int         pango_font_metrics_get_underline_position
                                            (PangoFontMetrics *metrics);
int         pango_font_metrics_get_strikethrough_thickness
                                            (PangoFontMetrics *metrics);
int         pango_font_metrics_get_strikethrough_position
                                            (PangoFontMetrics *metrics);

            PangoFont;
#define     PANGO_TYPE_FONT
#define     PANGO_FONT                      (object)
#define     PANGO_IS_FONT                   (object)
PangoEngineShape* pango_font_find_shaper    (PangoFont *font,
                                             PangoLanguage *language,
                                             guint32 ch);
PangoFontDescription* pango_font_describe   (PangoFont *font);
PangoCoverage* pango_font_get_coverage      (PangoFont *font,
                                             PangoLanguage *language);
void        pango_font_get_glyph_extents    (PangoFont *font,
                                             PangoGlyph glyph,
                                             PangoRectangle *ink_rect,
                                             PangoRectangle *logical_rect);
PangoFontMetrics* pango_font_get_metrics    (PangoFont *font,
                                             PangoLanguage *language);

            PangoFontFamily;
#define     PANGO_TYPE_FONT_FAMILY
#define     PANGO_FONT_FAMILY               (object)
#define     PANGO_IS_FONT_FAMILY            (object)
const char* pango_font_family_get_name      (PangoFontFamily *family);
gboolean    pango_font_family_is_monospace  (PangoFontFamily *family);
void        pango_font_family_list_faces    (PangoFontFamily *family,
                                             PangoFontFace ***faces,
                                             int *n_faces);

            PangoFontFace;
#define     PANGO_TYPE_FONT_FACE
#define     PANGO_FONT_FACE                 (object)
#define     PANGO_IS_FONT_FACE              (object)
const char* pango_font_face_get_face_name   (PangoFontFace *face);
void        pango_font_face_list_sizes      (PangoFontFace *face,
                                             int **sizes,
                                             int *n_sizes);
PangoFontDescription* pango_font_face_describe
                                            (PangoFontFace *face);

            PangoFontMap;
#define     PANGO_TYPE_FONT_MAP
#define     PANGO_FONT_MAP                  (object)
#define     PANGO_IS_FONT_MAP               (object)
            PangoFontMapClass;
#define     PANGO_FONT_MAP_CLASS            (klass)
#define     PANGO_IS_FONT_MAP_CLASS         (klass)
#define     PANGO_FONT_MAP_GET_CLASS        (obj)
PangoFont*  pango_font_map_load_font        (PangoFontMap *fontmap,
                                             PangoContext *context,
                                             const PangoFontDescription *desc);
PangoFontset* pango_font_map_load_fontset   (PangoFontMap *fontmap,
                                             PangoContext *context,
                                             const PangoFontDescription *desc,
                                             PangoLanguage *language);
void        pango_font_map_list_families    (PangoFontMap *fontmap,
                                             PangoFontFamily ***families,
                                             int *n_families);
const char* pango_font_map_get_shape_engine_type
                                            (PangoFontMap *fontmap);

            PangoFontset;
#define     PANGO_TYPE_FONTSET
            PangoFontsetClass;
PangoFont*  pango_fontset_get_font          (PangoFontset *fontset,
                                             guint wc);
PangoFontMetrics* pango_fontset_get_metrics (PangoFontset *fontset);
gboolean    (*PangoFontsetForeachFunc)      (PangoFontset *fontset,
                                             PangoFont *font,
                                             gpointer data);
void        pango_fontset_foreach           (PangoFontset *fontset,
                                             PangoFontsetForeachFunc func,
                                             gpointer data);
            PangoFontsetSimple;
#define     PANGO_TYPE_FONTSET_SIMPLE
PangoFontsetSimple* pango_fontset_simple_new
                                            (PangoLanguage *language);
void        pango_fontset_simple_append     (PangoFontsetSimple *fontset,
                                             PangoFont *font);
int         pango_fontset_simple_size       (PangoFontsetSimple *fontset);


Object Hierarchy

  GObject
   +----PangoFont
         +----PangoFcFont
  GObject
   +----PangoFontFamily
  GObject
   +----PangoFontFace
  GObject
   +----PangoFontMap
         +----PangoFcFontMap
  GObject
   +----PangoFontset
         +----PangoFontsetSimple
  GObject
   +----PangoFontset
         +----PangoFontsetSimple

Description

Pango supports a flexible architecture where a particular rendering architecture can supply an implementation of fonts. The PangoFont structure represents an abstract rendering-system-indepent font. Pango provides routines to list available fonts, and to load a font of a given description.

Details

PangoFontDescription

typedef struct _PangoFontDescription PangoFontDescription;

The PangoFontDescription structure represents the description of an ideal font. These structures are used both to list what fonts are available on the system and also for specifying the characteristics of a font to load.


PANGO_TYPE_FONT_DESCRIPTION

#define PANGO_TYPE_FONT_DESCRIPTION (pango_font_description_get_type ())

The GObject type for PangoFontDescription.


enum PangoStyle

typedef enum {
  PANGO_STYLE_NORMAL,
  PANGO_STYLE_OBLIQUE,
  PANGO_STYLE_ITALIC
} PangoStyle;

An enumeration specifying the various slant styles possible for a font.

PANGO_STYLE_NORMAL the font is upright.
PANGO_STYLE_OBLIQUE the font is slanted, but in a roman style.
PANGO_STYLE_ITALIC the font is slanted in an italic style.

PANGO_TYPE_STYLE

#define PANGO_TYPE_STYLE (pango_style_get_type())

The GObject type for PangoStyle.


enum PangoWeight

typedef enum {
  PANGO_WEIGHT_ULTRALIGHT = 200,
  PANGO_WEIGHT_LIGHT = 300,
  PANGO_WEIGHT_NORMAL = 400,
  PANGO_WEIGHT_SEMIBOLD = 600,
  PANGO_WEIGHT_BOLD = 700,
  PANGO_WEIGHT_ULTRABOLD = 800,
  PANGO_WEIGHT_HEAVY = 900
} PangoWeight;

An enumeration specifying the weight (boldness) of a font. This is a numerical value ranging from 100 to 900, but there are some predefined values:

PANGO_WEIGHT_ULTRALIGHTthe ultralight weight (= 200)
PANGO_WEIGHT_LIGHT the light weight (=300)
PANGO_WEIGHT_NORMALthe default weight (= 400)
PANGO_WEIGHT_SEMIBOLDa weight intermediate between normal and bold (=600)
PANGO_WEIGHT_BOLDthe bold weight (= 700)
PANGO_WEIGHT_ULTRABOLDthe ultrabold weight (= 800)
PANGO_WEIGHT_HEAVYthe heavy weight (= 900)

PANGO_TYPE_WEIGHT

#define PANGO_TYPE_WEIGHT (pango_weight_get_type())

The GObject type for PangoWeight.


enum PangoVariant

typedef enum {
  PANGO_VARIANT_NORMAL,
  PANGO_VARIANT_SMALL_CAPS
} PangoVariant;

An enumeration specifying capitalization variant of the font.

PANGO_VARIANT_NORMALA normal font.
PANGO_VARIANT_SMALL_CAPSA font with the lower case characters replaced by smaller variants of the capital characters.

PANGO_TYPE_VARIANT

#define PANGO_TYPE_VARIANT (pango_variant_get_type())

The GObject type for PangoVariant.


enum PangoStretch

typedef enum {
  PANGO_STRETCH_ULTRA_CONDENSED,
  PANGO_STRETCH_EXTRA_CONDENSED,
  PANGO_STRETCH_CONDENSED,
  PANGO_STRETCH_SEMI_CONDENSED,
  PANGO_STRETCH_NORMAL,
  PANGO_STRETCH_SEMI_EXPANDED,
  PANGO_STRETCH_EXPANDED,
  PANGO_STRETCH_EXTRA_EXPANDED,
  PANGO_STRETCH_ULTRA_EXPANDED
} PangoStretch;

An enumeration specifying the width of the font relative to other designs within a family.

PANGO_STRETCH_ULTRA_CONDENSED
PANGO_STRETCH_EXTRA_CONDENSED
PANGO_STRETCH_CONDENSED
PANGO_STRETCH_SEMI_CONDENSED
PANGO_STRETCH_NORMALthe normal width
PANGO_STRETCH_SEMI_EXPANDED
PANGO_STRETCH_EXPANDED
PANGO_STRETCH_EXTRA_EXPANDED
PANGO_STRETCH_ULTRA_EXPANDED

PANGO_TYPE_STRETCH

#define PANGO_TYPE_STRETCH (pango_stretch_get_type())

The GObject type for PangoStretch.


enum PangoFontMask

typedef enum {
  PANGO_FONT_MASK_FAMILY  = 1 << 0,
  PANGO_FONT_MASK_STYLE   = 1 << 1,
  PANGO_FONT_MASK_VARIANT = 1 << 2,
  PANGO_FONT_MASK_WEIGHT  = 1 << 3,
  PANGO_FONT_MASK_STRETCH = 1 << 4,
  PANGO_FONT_MASK_SIZE    = 1 << 5
} PangoFontMask;

The bits in a PangoFontMask correspond to fields in a PangoFontDescription that have been set.

PANGO_FONT_MASK_FAMILYthe font family is specified.
PANGO_FONT_MASK_STYLEthe font style is specified.
PANGO_FONT_MASK_VARIANTthe font variant is specified.
PANGO_FONT_MASK_WEIGHTthe font weight is specified.
PANGO_FONT_MASK_STRETCHthe font stretch is specified.
PANGO_FONT_MASK_SIZEthe font size is specified.

PANGO_TYPE_FONT_MASK

#define PANGO_TYPE_FONT_MASK (pango_font_mask_get_type())

The GObject type for PangoFontMask.


pango_font_description_new ()

PangoFontDescription* pango_font_description_new
                                            (void);

Creates a new font description structure with all fields unset.

Returns : the newly-created PangoFontDescription. Use pango_font_description_free() to free the result.

pango_font_description_copy ()

PangoFontDescription* pango_font_description_copy
                                            (const PangoFontDescription *desc);

Make a copy of a PangoFontDescription.

desc : a PangoFontDescription
Returns : a newly-allocated PangoFontDescription. This value must be freed using pango_font_description_free().

pango_font_description_copy_static ()

PangoFontDescription* pango_font_description_copy_static
                                            (const PangoFontDescription *desc);

Like pango_font_description_copy(), but only a shallow copy is made of the family name and other allocated fields. The result can only be used until desc is modififed or freed. This is meant to be used when the copy is only needed temporarily.

desc : a PangoFontDescription
Returns : a newly-allocated PangoFontDescription. This value must be freed using pango_font_description_free().

pango_font_description_hash ()

guint       pango_font_description_hash     (const PangoFontDescription *desc);

Computes a hash of a PangoFontDescription structure suitable to be used, for example, as an argument to g_hash_table_new().

desc : a PangoFontDescription
Returns : the hash value.

pango_font_description_equal ()

gboolean    pango_font_description_equal    (const PangoFontDescription *desc1,
                                             const PangoFontDescription *desc2);

Compares two font descriptions for equality.

desc1 : a PangoFontDescription
desc2 : another PangoFontDescription
Returns : TRUE if the two font descriptions are proveably identical. (Two font descriptions may result in identical fonts being loaded, but still compare FALSE.)

pango_font_description_free ()

void        pango_font_description_free     (PangoFontDescription *desc);

Frees a font description.


pango_font_descriptions_free ()

void        pango_font_descriptions_free    (PangoFontDescription **descs,
                                             int n_descs);

Frees a list of font descriptions from pango_font_map_list_fonts()

descs : a pointer to an array of PangoFontDescription
n_descs : number of font descriptions in descs

pango_font_description_set_family ()

void        pango_font_description_set_family
                                            (PangoFontDescription *desc,
                                             const char *family);

Sets the family name field of a font description. The family name represents a family of related font styles, and will resolve to a particular PangoFontFamily. In some uses of PangoFontDescription, it is also possible to use a comma separated list of family names for this field.

desc : a PangoFontDescription.
family : a string representing the family name.

pango_font_description_set_family_static ()

void        pango_font_description_set_family_static
                                            (PangoFontDescription *desc,
                                             const char *family);

Like pango_font_description_set_family(), except that no copy of family is made. The caller must make sure that the string passed in stays around until desc has been freed or the name is set again. This function can be used if family is a static string such as a C string literal, or if desc is only needed temporarily.

desc : a PangoFontDescription
family : a string representing the family name.

pango_font_description_get_family ()

const char* pango_font_description_get_family
                                            (const PangoFontDescription *desc);

Gets the family name field of a font description. See pango_font_description_set_family().

desc : a PangoFontDescription.
Returns : The family name field. (Will be NULL if not previously set.)

pango_font_description_set_style ()

void        pango_font_description_set_style
                                            (PangoFontDescription *desc,
                                             PangoStyle style);

Sets the style field of a PangoFontDescription. The PangoStyle enumeration describes whether the font is slanted and the manner in which it is slanted; it can be either PANGO_STYLE_NORMAL, PANGO_STYLE_ITALIC, or PANGO_STYLE_OBLIQUE. Most fonts will either have a italic style or an oblique style, but not both, and font matching in Pango will match italic specifications with oblique fonts and vice-versa if an exact match is not found.

desc : a PangoFontDescription
style : the style for the font description

pango_font_description_get_style ()

PangoStyle  pango_font_description_get_style
                                            (const PangoFontDescription *desc);

Gets the style field of a PangoFontDescription. See pango_font_description_set_style().

desc : a PangoFontDescription
Returns : the style field for the font description. Use pango_font_description_get_set_fields() to find out if the field was explicitely set or not.

pango_font_description_set_variant ()

void        pango_font_description_set_variant
                                            (PangoFontDescription *desc,
                                             PangoVariant variant);

Sets the variant field of a font description. The PangoVariant can either be PANGO_VARIANT_NORMAL or PANGO_VARIANT_SMALL_CAPS.

desc : a PangoFontDescription
variant : the variant type for the font description.

pango_font_description_get_variant ()

PangoVariant pango_font_description_get_variant
                                            (const PangoFontDescription *desc);

Gets the variant field of a PangoFontDescription. See pango_font_description_set_variant().

desc : a PangoFontDescription.
Returns : the variant field for the font description. Use pango_font_description_get_set_fields() to find out if the field was explicitely set or not.

pango_font_description_set_weight ()

void        pango_font_description_set_weight
                                            (PangoFontDescription *desc,
                                             PangoWeight weight);

Sets the weight field of a font description. The weight field specifies how bold or light the font should be. In addition to the values of the PangoWeight enumeration, other intermediate numeric values are possible.

desc : a PangoFontDescription
weight : the weight for the font description.

pango_font_description_get_weight ()

PangoWeight pango_font_description_get_weight
                                            (const PangoFontDescription *desc);

Gets the weight field of a font description. See pango_font_description_set_weight().

desc : a PangoFontDescription
Returns : the weight field for the font description. Use pango_font_description_get_set_fields() to find out if the field was explicitely set or not.

pango_font_description_set_stretch ()

void        pango_font_description_set_stretch
                                            (PangoFontDescription *desc,
                                             PangoStretch stretch);

Sets the stretch field of a font description. The stretch field specifies how narrow or wide the font should be.

desc : a PangoFontDescription
stretch : the stretch for the font description

pango_font_description_get_stretch ()

PangoStretch pango_font_description_get_stretch
                                            (const PangoFontDescription *desc);

Gets the stretch field of a font description. See pango_font_description_set_stretch().

desc : a PangoFontDescription.
Returns : the stretch field for the font description. Use pango_font_description_get_set_fields() to find out if the field was explicitely set or not.

pango_font_description_set_size ()

void        pango_font_description_set_size (PangoFontDescription *desc,
                                             gint size);

Sets the size field of a font description in fractional points. This is mutually exclusive with pango_font_description_set_absolute_size().

desc : a PangoFontDescription
size : the size of the font in points, scaled by PANGO_SCALE. (That is, a size value of 10 * PANGO_SCALE is a 10 point font. The conversion factor between points and device units depends on system configuration and the output device. For screen display, a logical DPI of 96 is common, in which case a 10 point font corresponds to a 10 * (96 / 72) = 13.3 pixel font. Use pango_font_description_set_absolute_size() if you need a particular size in device units.

pango_font_description_get_size ()

gint        pango_font_description_get_size (const PangoFontDescription *desc);

Gets the size field of a font description. See pango_font_description_get_size().

desc : a PangoFontDescription
Returns : the size field for the font description in points or device units. You must call pango_font_description_get_size_is_absolute() to find out which is the case. Returns 0 if the size field has not previously been set. pango_font_description_get_set_fields() to find out if the field was explicitely set or not.

pango_font_description_set_absolute_size ()

void        pango_font_description_set_absolute_size
                                            (PangoFontDescription *desc,
                                             double size);

Sets the size field of a font description, in device units. This is mutually exclusive with pango_font_description_set_size().

desc : a PangoFontDescription
size : the new size, in pango units. There are PANGO_SCALE Pango units in one device unit. For an output backend where a device unit is a pixel, a size value of 10 * PANGO_SCALE gives a 10 pixel font.

Since 1.8


pango_font_description_get_size_is_absolute ()

gboolean    pango_font_description_get_size_is_absolute
                                            (const PangoFontDescription *desc);

Determines whether the size of the font is in points or device units. See pango_font_description_set_size() and pango_font_description_set_absolute_size().

desc : a PangoFontDescription
Returns : whether the the size for the font description is in points or device units. Use pango_font_description_get_set_fields() to find out if the size field of the font description was explicitely set or not.

Since 1.8


pango_font_description_get_set_fields ()

PangoFontMask pango_font_description_get_set_fields
                                            (const PangoFontDescription *desc);

Determines which fields in a font description have been set.

desc : a PangoFontDescription
Returns : a bitmask with bits set corresponding to the fields in desc that have been set.

pango_font_description_unset_fields ()

void        pango_font_description_unset_fields
                                            (PangoFontDescription *desc,
                                             PangoFontMask to_unset);

Unsets some of the fields in a PangoFontDescription. Note that this merely marks the fields cleared, it does not clear the settings for those fields, to clear a family name set with pango_font_description_set_family_static() so that it won't be returned by subsequent calls to pango_font_description_get_family(), you must actually call pango_font_description_set_family (desc, NULL);

desc : a PangoFontDescription
to_unset : bitmask of fields in the desc to unset.

pango_font_description_merge ()

void        pango_font_description_merge    (PangoFontDescription *desc,
                                             const PangoFontDescription *desc_to_merge,
                                             gboolean replace_existing);

Merges the fields that are set in desc_to_merge into the fields in desc. If replace_existing is FALSE, only fields in desc that are not already set are affected. If TRUE, then fields that are already set will be replaced as well.

desc : a PangoFontDescription
desc_to_merge : the PangoFontDescription to merge from
replace_existing : if TRUE, replace fields in desc with the corresponding values from desc_to_merge, even if they are already exist.

pango_font_description_merge_static ()

void        pango_font_description_merge_static
                                            (PangoFontDescription *desc,
                                             const PangoFontDescription *desc_to_merge,
                                             gboolean replace_existing);

Like pango_font_description_merge(), but only a shallow copy is made of the family name and other allocated fields. desc can only be used until desc_to_merge is modified or freed. This is meant to be used when the merged font description is only needed temporarily.

desc : a PangoFontDescription
desc_to_merge : the PangoFontDescription to merge from
replace_existing : if TRUE, replace fields in desc with the corresponding values from desc_to_merge, even if they are already exist.

pango_font_description_better_match ()

gboolean    pango_font_description_better_match
                                            (const PangoFontDescription *desc,
                                             const PangoFontDescription *old_match,
                                             const PangoFontDescription *new_match);

Determines if the style attributes of new_match are a closer match for desc than old_match, or if old_match is NULL, determines if new_match is a match at all. Approximate matching is done for weight and style; other attributes must match exactly.

desc : a PangoFontDescription
old_match : a PangoFontDescription, or NULL
new_match : a PangoFontDescription
Returns : TRUE if new_match is a better match

pango_font_description_from_string ()

PangoFontDescription* pango_font_description_from_string
                                            (const char *str);

Creates a new font description from a string representation in the form "[FAMILY-LIST] [STYLE-OPTIONS] [SIZE]", where FAMILY-LIST is a comma separated list of families optionally terminated by a comma, STYLE_OPTIONS is a whitespace separated list of words where each WORD describes one of style, variant, weight, or stretch, and SIZE is an decimal number (size in points). Any one of the options may be absent. If FAMILY-LIST is absent, then the family_name field of the resulting font description will be initialized to NULL. If STYLE-OPTIONS is missing, then all style options will be set to the default values. If SIZE is missing, the size in the resulting font description will be set to 0.

str : string representation of a font description.
Returns : a new PangoFontDescription.

pango_font_description_to_string ()

char*       pango_font_description_to_string
                                            (const PangoFontDescription *desc);

Creates a string representation of a font description. See pango_font_description_from_string() for a description of the format of the string representation. The family list in the string description will only have a terminating comma if the last word of the list is a valid style option.

desc : a PangoFontDescription
Returns : a new string that must be freed with g_free().

pango_font_description_to_filename ()

char*       pango_font_description_to_filename
                                            (const PangoFontDescription *desc);

Creates a filename representation of a font description. The filename is identical to the result from calling pango_font_description_to_string(), but with underscores instead of characters that are untypical in filenames, and in lower case only.

desc : a PangoFontDescription
Returns : a new string that must be freed with g_free().

PangoFontMetrics

typedef struct {
  guint ref_count;
  
  int ascent;
  int descent;
  int approximate_char_width;
  int approximate_digit_width;
  int underline_position;
  int underline_thickness;
  int strikethrough_position;
  int strikethrough_thickness;
} PangoFontMetrics;

A PangoFontMetrics structure holds the overall metric information for a font (possibly restricted to a script). The fields of this structure are private to implementations of a font backend. See the documentation of the corresponding getters for documentation of their meaning.


PANGO_TYPE_FONT_METRICS

#define PANGO_TYPE_FONT_METRICS  (pango_font_metrics_get_type ())

The GObject type for PangoFontMetrics.


pango_font_metrics_ref ()

PangoFontMetrics* pango_font_metrics_ref    (PangoFontMetrics *metrics);

Increases the reference count of a font metrics structure.

metrics : a PangoFontMetrics structure
Returns : metrics

pango_font_metrics_unref ()

void        pango_font_metrics_unref        (PangoFontMetrics *metrics);

Decreases the reference count of a font metrics structure. If the result is zero, frees the structure and any associated memory.

metrics : a PangoFontMetrics structure

pango_font_metrics_get_ascent ()

int         pango_font_metrics_get_ascent   (PangoFontMetrics *metrics);

Gets the ascent from a font metrics structure. The ascent is the distance from the baseline to the logical top of a line of text. (The logical top may be above or below the top of the actual drawn ink. It is necessary to lay out the text to figure where the ink will be.)

metrics : a PangoFontMetrics structure
Returns : the ascent, in pango units. (1 point == PANGO_SCALE pango units.)

pango_font_metrics_get_descent ()

int         pango_font_metrics_get_descent  (PangoFontMetrics *metrics);

Gets the descent from a font metrics structure. The descent is the distance from the baseline to the logical bottom of a line of text. (The logical bottom may be above or below the bottom of the actual drawn ink. It is necessary to lay out the text to figure where the ink will be.)

metrics : a PangoFontMetrics structure
Returns : the descent, in pango units. (1 point == PANGO_SCALE pango units.)

pango_font_metrics_get_approximate_char_width ()

int         pango_font_metrics_get_approximate_char_width
                                            (PangoFontMetrics *metrics);

Gets the approximate character width for a font metrics structure. This is merely a representative value useful, for example, for determining the initial size for a window. Actual characters in text will be wider and narrower than this.

metrics : a PangoFontMetrics structure
Returns : the character width, in pango units. (1 point == PANGO_SCALE pango units.)

pango_font_metrics_get_approximate_digit_width ()

int         pango_font_metrics_get_approximate_digit_width
                                            (PangoFontMetrics *metrics);

Gets the approximate digit width for a font metrics structure. This is merely a representative value useful, for example, for determining the initial size for a window. Actual digits in text can be wider and narrower than this, though this value is generally somewhat more accurate than the result of pango_font_metrics_get_approximate_digit_width().

metrics : a PangoFontMetrics structure
Returns : the digit width, in pango units. (1 point == PANGO_SCALE pango units.)

pango_font_metrics_get_underline_thickness ()

int         pango_font_metrics_get_underline_thickness
                                            (PangoFontMetrics *metrics);

Gets the suggested thickness to draw for the underline.

metrics : a PangoFontMetrics structure
Returns : the suggested underline thickness, in Pango units.

Since 1.6


pango_font_metrics_get_underline_position ()

int         pango_font_metrics_get_underline_position
                                            (PangoFontMetrics *metrics);

Gets the suggested position to draw the underline. The value returned is the distance above the baseline of the top of the underline. Since most fonts have underline positions beneath the baseline, this value is typically negative.

metrics : a PangoFontMetrics structure
Returns : the suggested underline position, in Pango units.

Since 1.6


pango_font_metrics_get_strikethrough_thickness ()

int         pango_font_metrics_get_strikethrough_thickness
                                            (PangoFontMetrics *metrics);

Gets the suggested thickness to draw for the strikethrough.

metrics : a PangoFontMetrics structure
Returns : the suggested strikethrough thickness, in Pango units.

Since 1.6


pango_font_metrics_get_strikethrough_position ()

int         pango_font_metrics_get_strikethrough_position
                                            (PangoFontMetrics *metrics);

Gets the suggested position to draw the strikethrough. The value returned is the distance above the baseline of the top of the strikethrough.

metrics : a PangoFontMetrics structure
Returns : the suggested strikethrough position, in Pango units.

Since 1.6


PangoFont

typedef struct _PangoFont PangoFont;

The PangoFont structure is used to represent a font in a rendering-system-independent matter. To create an implementation of a PangoFont, the rendering-system specific code should malloc a larger structure that contains a nested PangoFont, fill in the klass member of the nested PangoFont with a pointer to a appropriate PangoFontClass, then call pango_font_init() on the structure.

The PangoFont structure contains one member which the implementation fills in:


PANGO_TYPE_FONT

#define PANGO_TYPE_FONT              (pango_font_get_type ())

The GObject type for PangoFont.


PANGO_FONT()

#define PANGO_FONT(object)           (G_TYPE_CHECK_INSTANCE_CAST ((object), PANGO_TYPE_FONT, PangoFont))

Casts a GObject to a PangoFont.

object :a GObject.

PANGO_IS_FONT()

#define PANGO_IS_FONT(object)        (G_TYPE_CHECK_INSTANCE_TYPE ((object), PANGO_TYPE_FONT))

Returns TRUE if object is a PangoFont.

object :a GObject.

pango_font_find_shaper ()

PangoEngineShape* pango_font_find_shaper    (PangoFont *font,
                                             PangoLanguage *language,
                                             guint32 ch);

Finds the best matching shaper for a font for a particular language tag and character point.

font : a PangoFont
language : the language tag
ch : the ISO-10646 character code.
Returns : the best matching shaper.

pango_font_describe ()

PangoFontDescription* pango_font_describe   (PangoFont *font);

Returns a description of the font.

font : a PangoFont
Returns : a newly-allocated PangoFontDescription object.

pango_font_get_coverage ()

PangoCoverage* pango_font_get_coverage      (PangoFont *font,
                                             PangoLanguage *language);

Computes the coverage map for a given font and language tag.

font : a PangoFont
language : the language tag
Returns : a newly-allocated PangoCoverage object.

pango_font_get_glyph_extents ()

void        pango_font_get_glyph_extents    (PangoFont *font,
                                             PangoGlyph glyph,
                                             PangoRectangle *ink_rect,
                                             PangoRectangle *logical_rect);

Gets the logical and ink extents of a glyph within a font. The coordinate system for each rectangle has its origin at the base line and horizontal origin of the character with increasing coordinates extending to the right and down. The macros PANGO_ASCENT(), PANGO_DESCENT(), PANGO_LBEARING(), and PANGO_RBEARING can be used to convert from the extents rectangle to more traditional font metrics. The units of the rectangles are in 1/PANGO_SCALE of a device unit.

font : a PangoFont
glyph : the glyph index
ink_rect : rectangle used to store the extents of the glyph as drawn or NULL to indicate that the result is not needed.
logical_rect : rectangle used to store the logical extents of the glyph or NULL to indicate that the result is not needed.

pango_font_get_metrics ()

PangoFontMetrics* pango_font_get_metrics    (PangoFont *font,
                                             PangoLanguage *language);

Gets overall metric information for a font. Since the metrics may be substantially different for different scripts, a language tag can be provided to indicate that the metrics should be retrieved that correspond to the script(s) used by that language.

font : a PangoFont
language : language tag used to determine which script to get the metrics for, or NULL to indicate to get the metrics for the entire font.
Returns : a PangoFontMetrics object. The caller must call pango_font_metrics_unref() when finished using the object.

PangoFontFamily

typedef struct _PangoFontFamily PangoFontFamily;

The PangoFontFamily structure 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.


PANGO_TYPE_FONT_FAMILY

#define PANGO_TYPE_FONT_FAMILY              (pango_font_family_get_type ())

The GObject type for PangoFontFamily.


PANGO_FONT_FAMILY()

#define PANGO_FONT_FAMILY(object)           (G_TYPE_CHECK_INSTANCE_CAST ((object), PANGO_TYPE_FONT_FAMILY, PangoFontFamily))

Casts a GObject to a PangoFontFamily.

object :a GObject.

PANGO_IS_FONT_FAMILY()

#define PANGO_IS_FONT_FAMILY(object)        (G_TYPE_CHECK_INSTANCE_TYPE ((object), PANGO_TYPE_FONT_FAMILY))

Returns TRUE if object is a PangoFontFamily.

object :a GObject.

pango_font_family_get_name ()

const char* pango_font_family_get_name      (PangoFontFamily *family);

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

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

pango_font_family_is_monospace ()

gboolean    pango_font_family_is_monospace  (PangoFontFamily *family);

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. g_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_font_metrics_get_approximate_digit_width(), since the results of pango_font_metrics_get_approximate_char_width() may be affected by double-width characters.

family : a PangoFontFamily
Returns : TRUE if the family is monospace.

pango_font_family_list_faces ()

void        pango_font_family_list_faces    (PangoFontFamily *family,
                                             PangoFontFace ***faces,
                                             int *n_faces);

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.

family : a PangoFontFamily
faces : location to store an array of pointers to PangoFontFace objects, or NULL. This array should be freed with g_free() when it is no longer needed.
n_faces : location to store number of elements in faces.

PangoFontFace

typedef struct _PangoFontFace PangoFontFace;

The PangoFontFace structure is used to represent a group of fonts with the same family, slant, weight, width, but varying sizes.


PANGO_TYPE_FONT_FACE

#define PANGO_TYPE_FONT_FACE              (pango_font_face_get_type ())

The GObject type for PangoFontFace.


PANGO_FONT_FACE()

#define PANGO_FONT_FACE(object)           (G_TYPE_CHECK_INSTANCE_CAST ((object), PANGO_TYPE_FONT_FACE, PangoFontFace))

Casts a GObject to a PangoFontFace.

object :a GObject.

PANGO_IS_FONT_FACE()

#define PANGO_IS_FONT_FACE(object)        (G_TYPE_CHECK_INSTANCE_TYPE ((object), PANGO_TYPE_FONT_FACE))

Returns TRUE if object is a PangoFontFace.

object :a GObject.

pango_font_face_get_face_name ()

const char* pango_font_face_get_face_name   (PangoFontFace *face);

Gets a name representing the style of this face among the different faces in the PangoFontFamily for the face. This name is unique among all faces in the family and is suitable for displaying to users.

face : a PangoFontFace.
Returns : the face name for the face. This string is owned by the face object and must not be modified or freed.

pango_font_face_list_sizes ()

void        pango_font_face_list_sizes      (PangoFontFace *face,
                                             int **sizes,
                                             int *n_sizes);

List the available sizes for a font. This is only applicable to bitmap fonts. For scalable fonts, stores NULL at the location pointed to by sizes and 0 at the location pointed to by n_sizes. The sizes returned are in pango units and are sorted in ascending order.

face : a PangoFontFace.
sizes : location to store a pointer to an array of int. This array should be freed with g_free().
n_sizes : location to store the number of elements in sizes

Since 1.4


pango_font_face_describe ()

PangoFontDescription* pango_font_face_describe
                                            (PangoFontFace *face);

Returns the family, style, variant, weight and stretch of a PangoFontFace. The size field of the resulting font description will be unset.

face : a PangoFontFace
Returns : a newly-created PangoFontDescription structure holding the description of the face. Use pango_font_description_free() to free the result.

PangoFontMap

typedef struct _PangoFontMap PangoFontMap;

The PangoFontMap represents the set of fonts available for a particular rendering system. This is a virtual object with implementations being specific to particular rendering systems. To create an implementation of a PangoFontMap, the rendering-system specific code should malloc a larger structure that contains a nested PangoFontMap, fill in the klass member of the nested PangoFontMap with a pointer to a appropriate PangoFontMapClass, then call pango_font_map_init() on the structure.

The PangoFont structure contains one member which the implementation fills in:


PANGO_TYPE_FONT_MAP

#define PANGO_TYPE_FONT_MAP              (pango_font_map_get_type ())

The GObject type for PangoFontMap.


PANGO_FONT_MAP()

#define PANGO_FONT_MAP(object)           (G_TYPE_CHECK_INSTANCE_CAST ((object), PANGO_TYPE_FONT_MAP, PangoFontMap))

Casts a GObject to a PangoFontMap.

object :a GObject.

PANGO_IS_FONT_MAP()

#define PANGO_IS_FONT_MAP(object)        (G_TYPE_CHECK_INSTANCE_TYPE ((object), PANGO_TYPE_FONT_MAP))

Returns TRUE if object is a PangoFontMap.

object :a GObject.

PangoFontMapClass

typedef struct {
  GObjectClass parent_class;

  
  PangoFont *   (*load_font)     (PangoFontMap               *fontmap,
				  PangoContext               *context,
				  const PangoFontDescription *desc);
  void          (*list_families) (PangoFontMap               *fontmap,
				  PangoFontFamily          ***families,
				  int                        *n_families);
  PangoFontset *(*load_fontset)  (PangoFontMap               *fontmap,
				  PangoContext               *context,
				  const PangoFontDescription *desc,
				  PangoLanguage              *language);
  
  const char *shape_engine_type;
} PangoFontMapClass;

The PangoFontMapClass structure holds the virtual functions for a particular PangoFontMap implementation.

GObjectClass parent_class;
load_font ()a function to load a font with a given description. See pango_font_map_load_font()
list_families ()A function to list available font families. See pango_font_map_list_families().
load_fontset ()
const char *shape_engine_type;

PANGO_FONT_MAP_CLASS()

#define PANGO_FONT_MAP_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), PANGO_TYPE_FONT_MAP, PangoFontMapClass))

Casts a GObject to a PangoFontMapClass.

klass :a GObject.

PANGO_IS_FONT_MAP_CLASS()

#define PANGO_IS_FONT_MAP_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), PANGO_TYPE_FONT_MAP))

Returns TRUE if klass is a subtype of PangoFontMapClass.

klass :a GObject.

PANGO_FONT_MAP_GET_CLASS()

#define PANGO_FONT_MAP_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), PANGO_TYPE_FONT_MAP, PangoFontMapClass))

Returns the type of a PangoFontMap.

obj :a PangoFontMap.

pango_font_map_load_font ()

PangoFont*  pango_font_map_load_font        (PangoFontMap *fontmap,
                                             PangoContext *context,
                                             const PangoFontDescription *desc);

Load the font in the fontmap that is the closest match for desc.

fontmap : a PangoFontMap
context : the PangoContext the font will be used with
desc : a PangoFontDescription describing the font to load
Returns :the font loaded, or NULL if no font matched.

pango_font_map_load_fontset ()

PangoFontset* pango_font_map_load_fontset   (PangoFontMap *fontmap,
                                             PangoContext *context,
                                             const PangoFontDescription *desc,
                                             PangoLanguage *language);

Load a set of fonts in the fontmap that can be used to render a font matching desc.

fontmap : a PangoFontMap
context : the PangoContext the font will be used with
desc : a PangoFontDescription describing the font to load
language : a PangoLanguage the fonts will be used for
Returns :the fontset, or NULL if no font matched.

pango_font_map_list_families ()

void        pango_font_map_list_families    (PangoFontMap *fontmap,
                                             PangoFontFamily ***families,
                                             int *n_families);

List all families for a fontmap.

fontmap : a PangoFontMap
families : location to store a pointer to an array of PangoFontFamily *. This array should be freed with g_free().
n_families : location to store the number of elements in descs

pango_font_map_get_shape_engine_type ()

const char* pango_font_map_get_shape_engine_type
                                            (PangoFontMap *fontmap);

Returns the render ID for shape engines for this fontmap. See the render_type field of PangoEngineInfo.

fontmap : a PangoFontmap
Returns : the ID string for shape engines for this fontmap. Owned by Pango, should not be modified or freed.

Since 1.4


PangoFontset

typedef struct _PangoFontset PangoFontset;

A PangoFontset represents a set of PangoFont to use when rendering text. It is the result of resolving a PangoFontDescription against a particular PangoContext. It has operations for finding the component font for a particular Unicode character, and for finding a composite set of metrics for the entire fontset.


PANGO_TYPE_FONTSET

#define PANGO_TYPE_FONTSET              (pango_fontset_get_type ())

The GObject type for PangoFontset.


PangoFontsetClass

typedef struct {
  GObjectClass parent_class;

   
  PangoFont *       (*get_font)     (PangoFontset     *fontset,
				     guint             wc);

  PangoFontMetrics *(*get_metrics)  (PangoFontset     *fontset);
  PangoLanguage *   (*get_language) (PangoFontset     *fontset);
  void              (*foreach)      (PangoFontset           *fontset,
				     PangoFontsetForeachFunc func,
				     gpointer                data);
} PangoFontsetClass;

The PangoFontsetClass structure holds the virtual functions for a particular PangoFontset implementation.

GObjectClass parent_class;
get_font ()a function to get the font in the fontset that contains the best glyph for the given unicode character; see pango_fontset_get_font().
get_metrics ()a function to get overall metric information for the fonts in the fontset; see pango_fontset_get_metrics().
get_language ()a function to get the language of the fontset.
foreach ()

pango_fontset_get_font ()

PangoFont*  pango_fontset_get_font          (PangoFontset *fontset,
                                             guint wc);

Returns the font in the fontset that contains the best glyph for the unicode character wc.

fontset : a PangoFontset
wc : a unicode character
Returns : a PangoFont. The caller must call g_object_unref when finished with the font.

pango_fontset_get_metrics ()

PangoFontMetrics* pango_fontset_get_metrics (PangoFontset *fontset);

Get overall metric information for the fonts in the fontset.

fontset : a PangoFontset
Returns : a PangoFontMetrics object. The caller must call pango_font_metrics_unref() when finished using the object.

PangoFontsetForeachFunc ()

gboolean    (*PangoFontsetForeachFunc)      (PangoFontset *fontset,
                                             PangoFont *font,
                                             gpointer data);

A callback function used by pango_fontset_foreach() when enumerating the fonts in a fontset.

fontset : a PangoFontset
font : a font from fontset
data : callback data
Returns : if TRUE, stop iteration and return immediately.

Since 1.4


pango_fontset_foreach ()

void        pango_fontset_foreach           (PangoFontset *fontset,
                                             PangoFontsetForeachFunc func,
                                             gpointer data);

Iterates through all the fonts in a fontset, calling func for each one. If func returns TRUE, that stops the iteration.

fontset : a PangoFontset
func : Callback function
data : data to pass to the callback function

Since 1.4


PangoFontsetSimple

typedef struct _PangoFontsetSimple PangoFontsetSimple;

PangoFontSetSimple is a implementation of the abstract PangoFontSet base class in terms of an array of fonts, which the creator provides when constructing the PangoFontSetSimple.


PANGO_TYPE_FONTSET_SIMPLE

#define PANGO_TYPE_FONTSET_SIMPLE       (pango_fontset_simple_get_type ())

The GObject type for PangoFontsetSimple.


pango_fontset_simple_new ()

PangoFontsetSimple* pango_fontset_simple_new
                                            (PangoLanguage *language);

Creates a new PangoFontsetSimple for the given language.

language : a PangoLanguage tag
Returns : a newly-allocated PangoFontsetSimple.

pango_fontset_simple_append ()

void        pango_fontset_simple_append     (PangoFontsetSimple *fontset,
                                             PangoFont *font);

Adds a font to the fontset.

fontset : a PangoFontsetSimple.
font : a PangoFont.

pango_fontset_simple_size ()

int         pango_fontset_simple_size       (PangoFontsetSimple *fontset);

Returns the number of fonts in the fontset.

fontset : a PangoFontsetSimple.
Returns : the size of fontset.