Struct pango::FontMetrics
source · #[repr(transparent)]pub struct FontMetrics { /* private fields */ }
Expand description
A FontMetrics
structure holds the overall metric information
for a font.
The information in a FontMetrics
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:
Implementations§
source§impl FontMetrics
impl FontMetrics
source§impl FontMetrics
impl FontMetrics
sourcepub fn approximate_char_width(&self) -> i32
pub fn approximate_char_width(&self) -> i32
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.
Returns
the character width, in Pango units.
sourcepub fn approximate_digit_width(&self) -> i32
pub fn approximate_digit_width(&self) -> i32
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.
Returns
the digit width, in Pango units.
sourcepub fn ascent(&self) -> i32
pub fn ascent(&self) -> i32
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.)
Returns
the ascent, in Pango units.
sourcepub fn descent(&self) -> i32
pub fn descent(&self) -> i32
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.)
Returns
the descent, in Pango units.
sourcepub fn height(&self) -> i32
Available on crate feature v1_44
only.
pub fn height(&self) -> i32
v1_44
only.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.
Returns
the height, in Pango units
sourcepub fn strikethrough_position(&self) -> i32
pub fn strikethrough_position(&self) -> i32
Gets the suggested position to draw the strikethrough.
The value returned is the distance above the baseline of the top of the strikethrough.
Returns
the suggested strikethrough position, in Pango units.
sourcepub fn strikethrough_thickness(&self) -> i32
pub fn strikethrough_thickness(&self) -> i32
Gets the suggested thickness to draw for the strikethrough.
Returns
the suggested strikethrough thickness, in Pango units.
sourcepub fn underline_position(&self) -> i32
pub fn underline_position(&self) -> i32
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.
Returns
the suggested underline position, in Pango units.
sourcepub fn underline_thickness(&self) -> i32
pub fn underline_thickness(&self) -> i32
Gets the suggested thickness to draw for the underline.
Returns
the suggested underline thickness, in Pango units.
Trait Implementations§
source§impl Clone for FontMetrics
impl Clone for FontMetrics
source§impl Debug for FontMetrics
impl Debug for FontMetrics
source§impl From<FontMetrics> for Value
impl From<FontMetrics> for Value
source§fn from(s: FontMetrics) -> Self
fn from(s: FontMetrics) -> Self
source§impl HasParamSpec for FontMetrics
impl HasParamSpec for FontMetrics
type ParamSpec = ParamSpecBoxed
§type SetValue = FontMetrics
type SetValue = FontMetrics
type BuilderFn = fn(_: &str) -> ParamSpecBoxedBuilder<'_, FontMetrics>
fn param_spec_builder() -> Self::BuilderFn
source§impl Hash for FontMetrics
impl Hash for FontMetrics
source§impl Ord for FontMetrics
impl Ord for FontMetrics
source§fn cmp(&self, other: &FontMetrics) -> Ordering
fn cmp(&self, other: &FontMetrics) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<FontMetrics> for FontMetrics
impl PartialEq<FontMetrics> for FontMetrics
source§fn eq(&self, other: &FontMetrics) -> bool
fn eq(&self, other: &FontMetrics) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<FontMetrics> for FontMetrics
impl PartialOrd<FontMetrics> for FontMetrics
source§fn partial_cmp(&self, other: &FontMetrics) -> Option<Ordering>
fn partial_cmp(&self, other: &FontMetrics) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl StaticType for FontMetrics
impl StaticType for FontMetrics
source§fn static_type() -> Type
fn static_type() -> Type
Self
.