package ocgtk

  1. Overview
  2. Docs
OCaml bindings for GTK 4

Install 

dune-project
 Dependency

github.com Edit opam file Versions (2)

Authors

  1. C
    Chris Armstrong

Maintainers

  1. H
    hello@chrisarmstrong.dev

Sources

v0.1-preview2.tar.gz
sha256=4e50fdb5093136a10fc8ffbe388e44cbcb70d52f8afdd48863ec7e22580ff054

doc/ocgtk.pango/Ocgtk_pango/Pango/Wrappers/Font_metrics/index.html

Module Wrappers.Font_metrics

type t = [ `font_metrics ] Gobject.obj

A `PangoFontMetrics` structure holds the overall metric information for a font.

The information in a `PangoFontMetrics` structure may be 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.

For an overview of the most important metrics, see:

<picture> <source srcset="fontmetrics-dark.png" media="(prefers-color-scheme: dark)"> <img alt="Font metrics" src="fontmetrics-light.png"> </picture>

val ref : t -> t option

Increase the reference count of a font metrics structure by one.

val get_underline_thickness : t -> int

Gets the suggested thickness to draw for the underline.

val get_underline_position : t -> int

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.

val get_strikethrough_thickness : t -> int

Gets the suggested thickness to draw for the strikethrough.

val get_strikethrough_position : t -> int

Gets the suggested position to draw the strikethrough.

The value returned is the distance *above* the baseline of the top of the strikethrough.

val get_height : t -> int

Gets the line height from a font metrics structure.

The line height is the recommended distance between successive baselines in wrapped text using this font.

If the line height is not available, 0 is returned.

val get_descent : t -> int

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

val get_ascent : t -> int

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

val get_approximate_digit_width : t -> int

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 or narrower than this, though this value is generally somewhat more accurate than the result of pango_font_metrics_get_approximate_char_width() for digits.

val get_approximate_char_width : t -> int

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.

val get_type : unit -> Gobject.Type.t