Gjsify LogoGjsify Logo

A PangoFontDescription describes a font in an implementation-independent manner.

PangoFontDescription structures are used both to list what fonts are available on the system and also for specifying the characteristics of a font to load.

record

Hierarchy

  • FontDescription

Index

Constructors

Properties

name: string

Methods

  • Determines if the style attributes of new_match are a closer match for desc than those of old_match are, or if old_match is %NULL, determines if new_match is a match at all.

    Approximate matching is done for weight and style; other style attributes must match exactly. Style attributes are all attributes other than family and size-related attributes. Approximate matching for style considers %PANGO_STYLE_OBLIQUE and %PANGO_STYLE_ITALIC as matches, but not as good a match as when the styles are equal.

    Note that old_match must match desc.

    Parameters

    Returns boolean

  • Make a copy of a PangoFontDescription, but don't duplicate allocated fields.

    This is like [methodPango.FontDescription.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 modified or freed. This is meant to be used when the copy is only needed temporarily.

    Returns FontDescription

  • Compares two font descriptions for equality.

    Two font descriptions are considered equal if the fonts they describe are provably identical. This means that their masks do not have to match, as long as other fields are all the same. (Two font descriptions may result in identical fonts being loaded, but still compare %FALSE.)

    Parameters

    Returns boolean

  • free(): void
  • get_family(): string
  • Gets the family name field of a font description.

    See [methodPango.FontDescription.set_family].

    Returns string

  • get_size(): number
  • get_size_is_absolute(): boolean
  • Determines whether the size of the font is in points (not absolute) or device units (absolute).

    See [methodPango.FontDescription.set_size] and [methodPango.FontDescription.set_absolute_size].

    Returns boolean

  • get_variations(): string
  • Gets the variations field of a font description.

    See [methodPango.FontDescription.set_variations].

    Returns string

  • hash(): number
  • Computes a hash of a PangoFontDescription structure.

    This is suitable to be used, for example, as an argument to g_hash_table_new(). The hash value is independent of desc->mask.

    Returns number

  • 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.

    If desc_to_merge is %NULL, this function performs nothing.

    Parameters

    • desc_to_merge: FontDescription

      the PangoFontDescription to merge from, or %NULL

    • replace_existing: boolean

      if %TRUE, replace fields in desc with the corresponding values from desc_to_merge, even if they are already exist.

    Returns void

  • merge_static(desc_to_merge: FontDescription, replace_existing: boolean): void
  • Merges the fields that are set in desc_to_merge into the fields in desc, without copying allocated fields.

    This is like [methodPango.FontDescription.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.

    Parameters

    • desc_to_merge: FontDescription

      the PangoFontDescription to merge from

    • replace_existing: boolean

      if %TRUE, replace fields in desc with the corresponding values from desc_to_merge, even if they are already exist.

    Returns void

  • set_absolute_size(size: number): void
  • Sets the size field of a font description, in device units.

    This is mutually exclusive with [methodPango.FontDescription.set_size] which sets the font size in points.

    Parameters

    • size: number

      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.

    Returns void

  • set_family(family: string): void
  • 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.

    Parameters

    • family: string

      a string representing the family name.

    Returns void

  • set_family_static(family: string): void
  • Sets the family name field of a font description, without copying the string.

    This is like [methodPango.FontDescription.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.

    Parameters

    • family: string

      a string representing the family name

    Returns void

  • Sets the gravity field of a font description.

    The gravity field specifies how the glyphs should be rotated. If gravity is %PANGO_GRAVITY_AUTO, this actually unsets the gravity mask on the font description.

    This function is seldom useful to the user. Gravity should normally be set on a PangoContext.

    Parameters

    • gravity: Pango.Gravity

      the gravity for the font description.

    Returns void

  • set_size(size: number): void
  • Sets the size field of a font description in fractional points.

    This is mutually exclusive with [methodPango.FontDescription.set_absolute_size].

    Parameters

    • size: number

      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 [methodPango.FontDescription.set_absolute_size] if you need a particular size in device units.

    Returns void

  • set_stretch(stretch: Stretch): void
  • Sets the stretch field of a font description.

    The [enumPango.Stretch] field specifies how narrow or wide the font should be.

    Parameters

    • stretch: Stretch

      the stretch for the font description

    Returns void

  • Sets the style field of a PangoFontDescription.

    The [enumPango.Style] 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.

    Parameters

    • style: Pango.Style

      the style for the font description

    Returns void

  • Sets the variant field of a font description.

    The [enumPango.Variant] can either be %PANGO_VARIANT_NORMAL or %PANGO_VARIANT_SMALL_CAPS.

    Parameters

    • variant: Pango.Variant

      the variant type for the font description.

    Returns void

  • set_variations(variations: string): void
  • Sets the variations field of a font description.

    OpenType font variations allow to select a font instance by specifying values for a number of axes, such as width or weight.

    The format of the variations string is

    AXIS1=VALUE,AXIS2=VALUE...
    

    with each AXIS a 4 character tag that identifies a font axis, and each VALUE a floating point number. Unknown axes are ignored, and values are clamped to their allowed range.

    Pango does not currently have a way to find supported axes of a font. Both harfbuzz and freetype have API for this. See for example hb_ot_var_get_axis_infos.

    Parameters

    • variations: string

      a string representing the variations

    Returns void

  • set_variations_static(variations: string): void
  • Sets the variations field of a font description.

    This is like [methodPango.FontDescription.set_variations], except that no copy of variations 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 variations is a static string such as a C string literal, or if desc is only needed temporarily.

    Parameters

    • variations: string

      a string representing the variations

    Returns void

  • set_weight(weight: Weight): void
  • 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 [enumPango.Weight] enumeration, other intermediate numeric values are possible.

    Parameters

    • weight: Weight

      the weight for the font description.

    Returns void

  • to_filename(): string
  • Creates a filename representation of a font description.

    The filename is identical to the result from calling [methodPango.FontDescription.to_string], but with underscores instead of characters that are untypical in filenames, and in lower case only.

    Returns string

  • to_string(): string
  • Creates a string representation of a font description.

    See [funcPango.FontDescription.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.

    Returns string

  • Unsets some of the fields in a PangoFontDescription.

    The unset fields will get back to their default values.

    Parameters

    • to_unset: FontMask

      bitmask of fields in the desc to unset.

    Returns void

  • Creates a new font description from a string representation.

    The string must have the form

    "\[FAMILY-LIST] \[STYLE-OPTIONS] \[SIZE] \[VARIATIONS]",
    

    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, stretch, or gravity, and SIZE is a decimal number (size in points) or optionally followed by the unit modifier "px" for absolute size. VARIATIONS is a comma-separated list of font variation specifications of the form "`axis=`value" (the = sign is optional).

    The following words are understood as styles: "Normal", "Roman", "Oblique", "Italic".

    The following words are understood as variants: "Small-Caps", "All-Small-Caps", "Petite-Caps", "All-Petite-Caps", "Unicase", "Title-Caps".

    The following words are understood as weights: "Thin", "Ultra-Light", "Extra-Light", "Light", "Semi-Light", "Demi-Light", "Book", "Regular", "Medium", "Semi-Bold", "Demi-Bold", "Bold", "Ultra-Bold", "Extra-Bold", "Heavy", "Black", "Ultra-Black", "Extra-Black".

    The following words are understood as stretch values: "Ultra-Condensed", "Extra-Condensed", "Condensed", "Semi-Condensed", "Semi-Expanded", "Expanded", "Extra-Expanded", "Ultra-Expanded".

    The following words are understood as gravity values: "Not-Rotated", "South", "Upside-Down", "North", "Rotated-Left", "East", "Rotated-Right", "West".

    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.

    A typical example:

    "Cantarell Italic Light 15 \`wght=`200"
    

    Parameters

    • str: string

      string representation of a font description.

    Returns FontDescription

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method