Struct pango::Context

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

A Context stores global information used to control the itemization process.

The information stored by Context includes the fontmap used to look up fonts, and default values such as the default language, default gravity, or default font.

To obtain a Context, use FontMapExt::create_context().

Implementations

impl Context

pub fn new() -> Context

Creates a new Context initialized to default values.

This function is not particularly useful as it should always be followed by a set_font_map() call, and the function FontMapExt::create_context() does these two steps together and hence users are recommended to use that.

If you are using Pango as part of a higher-level system, that system may have it’s own way of create a Context. For instance, the GTK toolkit has, among others, gtk_widget_get_pango_context(). Use those instead.

Returns

the newly allocated Context, which should be freed with g_object_unref().

pub fn changed(&self)

Forces a change in the context, which will cause any Layout using this context to re-layout.

This function is only useful when implementing a new backend for Pango, something applications won’t do. Backends should call this function if they have attached extra data to the context and such data is changed.

pub fn base_dir(&self) -> Direction

Retrieves the base direction for the context.

See set_base_dir().

Returns

the base direction for the context.

pub fn base_gravity(&self) -> Gravity

Retrieves the base gravity for the context.

See set_base_gravity().

Returns

the base gravity for the context.

pub fn font_description(&self) -> Option<FontDescription>

Retrieve the default font description for the context.

Returns

a pointer to the context’s default font description. This value must not be modified or freed.

pub fn font_map(&self) -> Option<FontMap>

Gets the FontMap used to look up fonts for this context.

Returns

the font map for the Context. This value is owned by Pango and should not be unreferenced.

pub fn gravity(&self) -> Gravity

Retrieves the gravity for the context.

This is similar to base_gravity(), except for when the base gravity is Gravity::Auto for which Gravity::for_matrix() is used to return the gravity from the current context matrix.

Returns

the resolved gravity for the context.

pub fn gravity_hint(&self) -> GravityHint

Retrieves the gravity hint for the context.

See set_gravity_hint() for details.

Returns

the gravity hint for the context.

pub fn language(&self) -> Option<Language>

Retrieves the global language tag for the context.

Returns

the global language tag.

pub fn matrix(&self) -> Option<Matrix>

Gets the transformation matrix that will be applied when rendering with this context.

See set_matrix().

Returns

the matrix, or None if no matrix has been set (which is the same as the identity matrix). The returned matrix is owned by Pango and must not be modified or freed.

pub fn metrics( &self, desc: Option<&FontDescription>, language: Option<&Language> ) -> Option<FontMetrics>

Get overall metric information for a particular font description.

Since the metrics may be substantially different for different scripts, a language tag can be provided to indicate that the metrics should be retrieved that correspond to the script(s) used by that language.

The FontDescription is interpreted in the same way as by itemize(), and the family name may be a comma separated list of names. If characters from multiple of these families would be used to render the string, then the returned fonts would be a composite of the metrics for the fonts loaded for the individual families.

desc

a FontDescription structure. None means that the font description from the context will be used.

language

language tag used to determine which script to get the metrics for. None means that the language tag from the context will be used. If no language tag is set on the context, metrics for the default language (as determined by Language::default() will be returned.

Returns

a FontMetrics object. The caller must call Pango::FontMetrics::unref() when finished using the object.

pub fn is_round_glyph_positions(&self) -> bool

Available on crate feature v1_44 only.

Returns whether font rendering with this context should round glyph positions and widths.

pub fn serial(&self) -> u32

Returns the current serial number of @self.

The serial number is initialized to an small number larger than zero when a new context is created and is increased whenever the context is changed using any of the setter functions, or the FontMap it uses to find fonts has changed. The serial may wrap, but will never have the value 0. Since it can wrap, never compare it with “less than”, always use “not equals”.

This can be used to automatically detect changes to a Context, and is only useful when implementing objects that need update when their Context changes, like Layout.

Returns

The current serial number of @self.

pub fn list_families(&self) -> Vec<FontFamily>

List all families for a context.

Returns

families

location to store a pointer to an array of FontFamily. This array should be freed with g_free().

pub fn load_font(&self, desc: &FontDescription) -> Option<Font>

Loads the font in one of the fontmaps in the context that is the closest match for @desc.

desc

a FontDescription describing the font to load

Returns

the newly allocated Font that was loaded, or None if no font matched.

pub fn load_fontset( &self, desc: &FontDescription, language: &Language ) -> Option<Fontset>

Load a set of fonts in the context that can be used to render a font matching @desc.

desc

a FontDescription describing the fonts to load

language

a Language the fonts will be used for

Returns

the newly allocated Fontset loaded, or None if no font matched.

pub fn set_base_dir(&self, direction: Direction)

Sets the base direction for the context.

The base direction is used in applying the Unicode bidirectional algorithm; if the @direction is Direction::Ltr or Direction::Rtl, then the value will be used as the paragraph direction in the Unicode bidirectional algorithm. A value of Direction::WeakLtr or Direction::WeakRtl is used only for paragraphs that do not contain any strong characters themselves.

direction

the new base direction

pub fn set_base_gravity(&self, gravity: Gravity)

Sets the base gravity for the context.

The base gravity is used in laying vertical text out.

gravity

the new base gravity

pub fn set_font_description(&self, desc: &FontDescription)

Set the default font description for the context

desc

the new pango font description

pub fn set_font_map(&self, font_map: &impl IsA<FontMap>)

Sets the font map to be searched when fonts are looked-up in this context.

This is only for internal use by Pango backends, a Context obtained via one of the recommended methods should already have a suitable font map.

font_map

the FontMap to set.

pub fn set_gravity_hint(&self, hint: GravityHint)

Sets the gravity hint for the context.

The gravity hint is used in laying vertical text out, and is only relevant if gravity of the context as returned by gravity() is set to Gravity::East or Gravity::West.

hint

the new gravity hint

pub fn set_language(&self, language: &Language)

Sets the global language tag for the context.

The default language for the locale of the running process can be found using Language::default().

language

the new language tag.

pub fn set_matrix(&self, matrix: Option<&Matrix>)

Sets the transformation matrix that will be applied when rendering with this context.

Note that reported metrics are in the user space coordinates before the application of the matrix, not device-space coordinates after the application of the matrix. So, they don’t scale with the matrix, though they may change slightly for different matrices, depending on how the text is fit to the pixel grid.

matrix

a Matrix, or None to unset any existing matrix. (No matrix set is the same as setting the identity matrix.)

pub fn set_round_glyph_positions(&self, round_positions: bool)

Available on crate feature v1_44 only.

Sets whether font rendering with this context should round glyph positions and widths to integral positions, in device units.

This is useful when the renderer can’t handle subpixel positioning of glyphs.

The default value is to round glyph positions, to remain compatible with previous Pango behavior.

round_positions

whether to round glyph positions

Trait Implementations

impl Clone for Context

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 Context

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

Formats the value using the given formatter.

impl Default for Context

fn default() -> Self

Returns the “default value” for a type.

impl Display for Context

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

Formats the value using the given formatter.

impl Hash for Context

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

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 Context

fn cmp(&self, other: &Self) -> 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 ParentClassIs for Context

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for Context

fn eq(&self, other: &OT) -> 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<OT: ObjectType> PartialOrd<OT> for Context

fn partial_cmp(&self, other: &OT) -> 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 Context

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Context