Struct pango::FontMetrics

#[repr(transparent)]
pub struct FontMetrics { /* private fields */ }

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

impl FontMetrics

pub fn as_ptr(&self) -> *mut PangoFontMetrics

Return the inner pointer to the underlying C value.

impl FontMetrics

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.

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.

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.

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.

pub fn height(&self) -> i32

Available on crate feature 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

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.

pub fn strikethrough_thickness(&self) -> i32

Gets the suggested thickness to draw for the strikethrough.

Returns

the suggested strikethrough thickness, in Pango units.

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.

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

impl Clone for FontMetrics

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FontMetrics

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for FontMetrics

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for FontMetrics

fn cmp(&self, other: &FontMetrics) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<FontMetrics> for FontMetrics

fn eq(&self, other: &FontMetrics) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<FontMetrics> for FontMetrics

fn partial_cmp(&self, other: &FontMetrics) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for FontMetrics

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for FontMetrics

impl StructuralEq for FontMetrics

impl StructuralPartialEq for FontMetrics