Package ch.bailu.gtk.pango

Class FontDescription

java.lang.Object
ch.bailu.gtk.type.Type
ch.bailu.gtk.type.Pointer
ch.bailu.gtk.type.Record
ch.bailu.gtk.pango.FontDescription
All Implemented Interfaces:
PointerInterface
public class FontDescription extends Record
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.

https://docs.gtk.org/Pango/struct.FontDescription.html

  • Constructor Details

    • FontDescription

      public FontDescription(PointerContainer pointer)

    • FontDescription

      public FontDescription()
      Creates a new font description structure with all fields unset.

  • Method Details

    • getClassHandler

      public static ClassHandler getClassHandler()

    • betterMatch

      public boolean betterMatch(@Nullable FontDescription old_match, @Nonnull FontDescription new_match)
      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:
      old_match - a `PangoFontDescription`, or %NULL
      new_match - a `PangoFontDescription`
      Returns:
      %TRUE if @new_match is a better match

    • copy

      public FontDescription copy()
      Make a copy of a `PangoFontDescription`.
      Returns:
      the newly allocated `PangoFontDescription`, which should be freed with [method@Pango.FontDescription.free], or %NULL if @desc was %NULL.

    • copyStatic

      public FontDescription copyStatic()
      Make a copy of a `PangoFontDescription`, but don't duplicate
      allocated fields.

      This is like [method@Pango.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:
      the newly allocated `PangoFontDescription`, which should be freed with [method@Pango.FontDescription.free], or %NULL if @desc was %NULL.

    • equal

      public boolean equal(@Nonnull FontDescription desc2)
      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:
      desc2 - another `PangoFontDescription`
      Returns:
      %TRUE if the two font descriptions are identical, %FALSE otherwise.

    • free

      public void free()
      Frees a font description.

    • getFamily

      public Str getFamily()
      Gets the family name field of a font description.

      See [method@Pango.FontDescription.set_family].
      Returns:
      the family name field for the font description, or %NULL if not previously set. This has the same life-time as the font description itself and should not be freed.

    • getGravity

      public int getGravity()
      Gets the gravity field of a font description.

      See [method@Pango.FontDescription.set_gravity].
      Returns:
      the gravity field for the font description. Use [method@Pango.FontDescription.get_set_fields] to find out if the field was explicitly set or not.

    • getSetFields

      public int getSetFields()
      Determines which fields in a font description have been set.
      Returns:
      a bitmask with bits set corresponding to the fields in @desc that have been set.

    • getSize

      public int getSize()
      Gets the size field of a font description.

      See [method@Pango.FontDescription.set_size].
      Returns:
      the size field for the font description in points or device units. You must call [method@Pango.FontDescription.get_size_is_absolute] to find out which is the case. Returns 0 if the size field has not previously been set or it has been set to 0 explicitly. Use [method@Pango.FontDescription.get_set_fields] to find out if the field was explicitly set or not.

    • getSizeIsAbsolute

      public boolean getSizeIsAbsolute()
      Determines whether the size of the font is in points (not absolute)
      or device units (absolute).

      See [method@Pango.FontDescription.set_size]
      and [method@Pango.FontDescription.set_absolute_size].
      Returns:
      whether the size for the font description is in points or device units. Use [method@Pango.FontDescription.get_set_fields] to find out if the size field of the font description was explicitly set or not.

    • getStretch

      public int getStretch()
      Gets the stretch field of a font description.

      See [method@Pango.FontDescription.set_stretch].
      Returns:
      the stretch field for the font description. Use [method@Pango.FontDescription.get_set_fields] to find out if the field was explicitly set or not.

    • getStyle

      public int getStyle()
      Gets the style field of a `PangoFontDescription`.

      See [method@Pango.FontDescription.set_style].
      Returns:
      the style field for the font description. Use [method@Pango.FontDescription.get_set_fields] to find out if the field was explicitly set or not.

    • getVariant

      public int getVariant()
      Gets the variant field of a `PangoFontDescription`.

      See [method@Pango.FontDescription.set_variant].
      Returns:
      the variant field for the font description. Use [method@Pango.FontDescription.get_set_fields] to find out if the field was explicitly set or not.

    • getVariations

      public Str getVariations()
      Gets the variations field of a font description.

      See [method@Pango.FontDescription.set_variations].
      Returns:
      the variations field for the font description, or %NULL if not previously set. This has the same life-time as the font description itself and should not be freed.

    • getWeight

      public int getWeight()
      Gets the weight field of a font description.

      See [method@Pango.FontDescription.set_weight].
      Returns:
      the weight field for the font description. Use [method@Pango.FontDescription.get_set_fields] to find out if the field was explicitly set or not.

    • hash

      public int hash()
      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:
      the hash value.

    • merge

      public void merge(@Nullable FontDescription desc_to_merge, boolean 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.

      If @desc_to_merge is %NULL, this function performs nothing.
      Parameters:
      desc_to_merge - the `PangoFontDescription` to merge from, or %NULL
      replace_existing - if %TRUE, replace fields in @desc with the corresponding values from @desc_to_merge, even if they are already exist.

    • mergeStatic

      public void mergeStatic(@Nonnull FontDescription desc_to_merge, boolean replace_existing)
      Merges the fields that are set in @desc_to_merge into the fields in
      @desc, without copying allocated fields.

      This is like [method@Pango.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 - 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.

    • setAbsoluteSize

      public void setAbsoluteSize(double size)
      Sets the size field of a font description, in device units.

      This is mutually exclusive with [method@Pango.FontDescription.set_size]
      which sets the font size in points.
      Parameters:
      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.

    • setFamily

      public void setFamily(@Nonnull Str 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.
      Parameters:
      family - a string representing the family name.

    • setFamily

      public void setFamily(String 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.
      Parameters:
      family - a string representing the family name.

    • setFamilyStatic

      public void setFamilyStatic(@Nonnull Str family)
      Sets the family name field of a font description, without copying the string.

      This is like [method@Pango.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 - a string representing the family name

    • setFamilyStatic

      public void setFamilyStatic(String family)
      Sets the family name field of a font description, without copying the string.

      This is like [method@Pango.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 - a string representing the family name

    • setGravity

      public void setGravity(int gravity)
      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 - the gravity for the font description.

    • setSize

      public void setSize(int size)
      Sets the size field of a font description in fractional points.

      This is mutually exclusive with
      [method@Pango.FontDescription.set_absolute_size].
      Parameters:
      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 [method@Pango.FontDescription.set_absolute_size] if you need a particular size in device units.

    • setStretch

      public void setStretch(int stretch)
      Sets the stretch field of a font description.

      The [enum@Pango.Stretch] field specifies how narrow or
      wide the font should be.
      Parameters:
      stretch - the stretch for the font description

    • setStyle

      public void setStyle(int style)
      Sets the style field of a `PangoFontDescription`.

      The [enum@Pango.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 - the style for the font description

    • setVariant

      public void setVariant(int variant)
      Sets the variant field of a font description.

      The [enum@Pango.Variant] can either be %PANGO_VARIANT_NORMAL
      or %PANGO_VARIANT_SMALL_CAPS.
      Parameters:
      variant - the variant type for the font description.

    • setVariations

      public void setVariations(@Nullable Str variations)
      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](https://harfbuzz.github.io/harfbuzz-hb-ot-var.html#hb-ot-var-get-axis-infos).
      Parameters:
      variations - a string representing the variations

    • setVariations

      public void setVariations(String variations)
      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](https://harfbuzz.github.io/harfbuzz-hb-ot-var.html#hb-ot-var-get-axis-infos).
      Parameters:
      variations - a string representing the variations

    • setVariationsStatic

      public void setVariationsStatic(@Nonnull Str variations)
      Sets the variations field of a font description.

      This is like [method@Pango.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 - a string representing the variations

    • setVariationsStatic

      public void setVariationsStatic(String variations)
      Sets the variations field of a font description.

      This is like [method@Pango.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 - a string representing the variations

    • setWeight

      public void setWeight(int 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 [enum@Pango.Weight] enumeration, other
      intermediate numeric values are possible.
      Parameters:
      weight - the weight for the font description.

    • toFilename

      public Str toFilename()
      Creates a filename representation of a font description.

      The filename is identical to the result from calling
      [method@Pango.FontDescription.to_string], but with underscores
      instead of characters that are untypical in filenames, and in
      lower case only.
      Returns:
      a new string that must be freed with g_free().

    • toStr

      public Str toStr()
      Creates a string representation of a font description.

      See [func@Pango.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:
      a new string that must be freed with g_free().

    • unsetFields

      public void unsetFields(int to_unset)
      Unsets some of the fields in a `PangoFontDescription`.

      The unset fields will get back to their default values.
      Parameters:
      to_unset - bitmask of fields in the @desc to unset.

    • fromString

      public static FontDescription fromString(@Nonnull Str str)
      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 representation of a font description.
      Returns:
      a new `PangoFontDescription`.

    • getTypeID

      public static long getTypeID()

    • getParentTypeID

      public static long getParentTypeID()

    • getTypeSize

      public static TypeSystem.TypeSize getTypeSize()

    • getParentTypeSize

      public static TypeSystem.TypeSize getParentTypeSize()

    • getInstanceSize

      public static int getInstanceSize()