pangocairo/auto/

functions.rs

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use crate::ffi;
use glib::{prelude::*, translate::*};

/// Gets the resolution for the context.
///
/// See [`context_set_resolution()`][crate::context_set_resolution()]
/// ## `context`
/// a [`pango::Context`][crate::pango::Context], from a pangocairo font map
///
/// # Returns
///
/// the resolution in "dots per inch". A negative value will
///   be returned if no resolution has previously been set.
#[doc(alias = "pango_cairo_context_get_resolution")]
pub fn context_get_resolution(context: &pango::Context) -> f64 {
    unsafe { ffi::pango_cairo_context_get_resolution(context.to_glib_none().0) }
}

//#[doc(alias = "pango_cairo_context_get_shape_renderer")]
//pub fn context_get_shape_renderer(context: &pango::Context, data: /*Unimplemented*/Option<Basic: Pointer>) -> /*Unimplemented*/Fn(&cairo::Context, /*Ignored*/pango::AttrShape, bool) {
//    unsafe { TODO: call ffi:pango_cairo_context_get_shape_renderer() }
//}

/// Sets the font options used when rendering text with this context.
///
/// These options override any options that [`update_context()`][crate::update_context()]
/// derives from the target surface.
/// ## `context`
/// a [`pango::Context`][crate::pango::Context], from a pangocairo font map
/// ## `options`
/// a [`cairo::FontOptions`][crate::cairo::FontOptions], or [`None`] to unset
///   any previously set options. A copy is made.
#[doc(alias = "pango_cairo_context_set_font_options")]
pub fn context_set_font_options(context: &pango::Context, options: Option<&cairo::FontOptions>) {
    unsafe {
        ffi::pango_cairo_context_set_font_options(
            context.to_glib_none().0,
            options.to_glib_none().0,
        );
    }
}

/// Sets the resolution for the context.
///
/// This is a scale factor between points specified in a `PangoFontDescription`
/// and Cairo units. The default value is 96, meaning that a 10 point font will
/// be 13 units high. (10 * 96. / 72. = 13.3).
/// ## `context`
/// a [`pango::Context`][crate::pango::Context], from a pangocairo font map
/// ## `dpi`
/// the resolution in "dots per inch". (Physical inches aren't actually
///   involved; the terminology is conventional.) A 0 or negative value
///   means to use the resolution from the font map.
#[doc(alias = "pango_cairo_context_set_resolution")]
pub fn context_set_resolution(context: &pango::Context, dpi: f64) {
    unsafe {
        ffi::pango_cairo_context_set_resolution(context.to_glib_none().0, dpi);
    }
}

//#[doc(alias = "pango_cairo_context_set_shape_renderer")]
//pub fn context_set_shape_renderer(context: &pango::Context, func: /*Unimplemented*/Fn(&cairo::Context, /*Ignored*/pango::AttrShape, bool), data: /*Unimplemented*/Option<Basic: Pointer>) {
//    unsafe { TODO: call ffi:pango_cairo_context_set_shape_renderer() }
//}

/// Creates a context object set up to match the current transformation
/// and target surface of the Cairo context.
///
/// This context can then be
/// used to create a layout using [`pango::Layout::new()`][crate::pango::Layout::new()].
///
/// This function is a convenience function that creates a context using
/// the default font map, then updates it to @cr. If you just need to
/// create a layout for use with @cr and do not need to access [`pango::Context`][crate::pango::Context]
/// directly, you can use [`create_layout()`][crate::create_layout()] instead.
/// ## `cr`
/// a Cairo context
///
/// # Returns
///
/// the newly created [`pango::Context`][crate::pango::Context]
#[doc(alias = "pango_cairo_create_context")]
pub fn create_context(cr: &cairo::Context) -> pango::Context {
    unsafe {
        from_glib_full(ffi::pango_cairo_create_context(mut_override(
            cr.to_glib_none().0,
        )))
    }
}

/// Creates a layout object set up to match the current transformation
/// and target surface of the Cairo context.
///
/// This layout can then be used for text measurement with functions
/// like [`Layout::size()`][crate::pango::Layout::size()] or drawing with functions like
/// [`show_layout()`][crate::show_layout()]. If you change the transformation or target
/// surface for @cr, you need to call [`update_layout()`][crate::update_layout()].
///
/// This function is the most convenient way to use Cairo with Pango,
/// however it is slightly inefficient since it creates a separate
/// [`pango::Context`][crate::pango::Context] object for each layout. This might matter in an
/// application that was laying out large amounts of text.
/// ## `cr`
/// a Cairo context
///
/// # Returns
///
/// the newly created [`pango::Layout`][crate::pango::Layout]
#[doc(alias = "pango_cairo_create_layout")]
pub fn create_layout(cr: &cairo::Context) -> pango::Layout {
    unsafe {
        from_glib_full(ffi::pango_cairo_create_layout(mut_override(
            cr.to_glib_none().0,
        )))
    }
}

/// Add a squiggly line to the current path in the specified cairo context that
/// approximately covers the given rectangle in the style of an underline used
/// to indicate a spelling error.
///
/// The width of the underline is rounded to an integer number of up/down
/// segments and the resulting rectangle is centered in the original rectangle.
/// ## `cr`
/// a Cairo context
/// ## `x`
/// The X coordinate of one corner of the rectangle
/// ## `y`
/// The Y coordinate of one corner of the rectangle
/// ## `width`
/// Non-negative width of the rectangle
/// ## `height`
/// Non-negative height of the rectangle
#[doc(alias = "pango_cairo_error_underline_path")]
pub fn error_underline_path(cr: &cairo::Context, x: f64, y: f64, width: f64, height: f64) {
    unsafe {
        ffi::pango_cairo_error_underline_path(
            mut_override(cr.to_glib_none().0),
            x,
            y,
            width,
            height,
        );
    }
}

/// Adds the glyphs in @glyphs to the current path in the specified
/// cairo context.
///
/// The origin of the glyphs (the left edge of the baseline)
/// will be at the current point of the cairo context.
/// ## `cr`
/// a Cairo context
/// ## `font`
/// a [`pango::Font`][crate::pango::Font] from a [`FontMap`][crate::FontMap]
/// ## `glyphs`
/// a [`pango::GlyphString`][crate::pango::GlyphString]
#[doc(alias = "pango_cairo_glyph_string_path")]
pub fn glyph_string_path(
    cr: &cairo::Context,
    font: &impl IsA<pango::Font>,
    glyphs: &mut pango::GlyphString,
) {
    unsafe {
        ffi::pango_cairo_glyph_string_path(
            mut_override(cr.to_glib_none().0),
            font.as_ref().to_glib_none().0,
            glyphs.to_glib_none_mut().0,
        );
    }
}

/// Adds the text in [`pango::LayoutLine`][crate::pango::LayoutLine] to the current path in the
/// specified cairo context.
///
/// The origin of the glyphs (the left edge of the line) will be
/// at the current point of the cairo context.
/// ## `cr`
/// a Cairo context
/// ## `line`
/// a [`pango::LayoutLine`][crate::pango::LayoutLine]
#[doc(alias = "pango_cairo_layout_line_path")]
pub fn layout_line_path(cr: &cairo::Context, line: &pango::LayoutLine) {
    unsafe {
        ffi::pango_cairo_layout_line_path(mut_override(cr.to_glib_none().0), line.to_glib_none().0);
    }
}

/// Adds the text in a [`pango::Layout`][crate::pango::Layout] to the current path in the
/// specified cairo context.
///
/// The top-left corner of the [`pango::Layout`][crate::pango::Layout] will be at the
/// current point of the cairo context.
/// ## `cr`
/// a Cairo context
/// ## `layout`
/// a Pango layout
#[doc(alias = "pango_cairo_layout_path")]
pub fn layout_path(cr: &cairo::Context, layout: &pango::Layout) {
    unsafe {
        ffi::pango_cairo_layout_path(mut_override(cr.to_glib_none().0), layout.to_glib_none().0);
    }
}

/// Adds components of a [`pango::Layout`][crate::pango::Layout] to the current path
/// in the specified cairo context.
///
/// The top-left corner of the [`pango::Layout`][crate::pango::Layout] will be at the
/// current point of the cairo context.
/// ## `cr`
/// a Cairo context
/// ## `layout`
/// a Pango layout
/// ## `components`
/// the components to include
#[cfg(feature = "v1_58")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_58")))]
#[doc(alias = "pango_cairo_layout_path_for_components")]
pub fn layout_path_for_components(
    cr: &cairo::Context,
    layout: &pango::Layout,
    components: pango::RenderComponent,
) {
    unsafe {
        ffi::pango_cairo_layout_path_for_components(
            mut_override(cr.to_glib_none().0),
            layout.to_glib_none().0,
            components.into_glib(),
        );
    }
}

/// Draw a squiggly line in the specified cairo context that approximately
/// covers the given rectangle in the style of an underline used to indicate a
/// spelling error.
///
/// The width of the underline is rounded to an integer
/// number of up/down segments and the resulting rectangle is centered in the
/// original rectangle.
/// ## `cr`
/// a Cairo context
/// ## `x`
/// The X coordinate of one corner of the rectangle
/// ## `y`
/// The Y coordinate of one corner of the rectangle
/// ## `width`
/// Non-negative width of the rectangle
/// ## `height`
/// Non-negative height of the rectangle
#[doc(alias = "pango_cairo_show_error_underline")]
pub fn show_error_underline(cr: &cairo::Context, x: f64, y: f64, width: f64, height: f64) {
    unsafe {
        ffi::pango_cairo_show_error_underline(
            mut_override(cr.to_glib_none().0),
            x,
            y,
            width,
            height,
        );
    }
}

/// Draws the glyphs in @glyph_item in the specified cairo context,
///
/// embedding the text associated with the glyphs in the output if the
/// output format supports it (PDF for example), otherwise it acts
/// similar to [`show_glyph_string()`][crate::show_glyph_string()].
///
/// The origin of the glyphs (the left edge of the baseline) will
/// be drawn at the current point of the cairo context.
///
/// Note that @text is the start of the text for layout, which is then
/// indexed by `glyph_item->item->offset`.
/// ## `cr`
/// a Cairo context
/// ## `text`
/// the UTF-8 text that @glyph_item refers to
/// ## `glyph_item`
/// a [`pango::GlyphItem`][crate::pango::GlyphItem]
#[doc(alias = "pango_cairo_show_glyph_item")]
pub fn show_glyph_item(cr: &cairo::Context, text: &str, glyph_item: &mut pango::GlyphItem) {
    unsafe {
        ffi::pango_cairo_show_glyph_item(
            mut_override(cr.to_glib_none().0),
            text.to_glib_none().0,
            glyph_item.to_glib_none_mut().0,
        );
    }
}

/// Draws the glyphs in @glyphs in the specified cairo context.
///
/// The origin of the glyphs (the left edge of the baseline) will
/// be drawn at the current point of the cairo context.
/// ## `cr`
/// a Cairo context
/// ## `font`
/// a [`pango::Font`][crate::pango::Font] from a [`FontMap`][crate::FontMap]
/// ## `glyphs`
/// a [`pango::GlyphString`][crate::pango::GlyphString]
#[doc(alias = "pango_cairo_show_glyph_string")]
pub fn show_glyph_string(
    cr: &cairo::Context,
    font: &impl IsA<pango::Font>,
    glyphs: &mut pango::GlyphString,
) {
    unsafe {
        ffi::pango_cairo_show_glyph_string(
            mut_override(cr.to_glib_none().0),
            font.as_ref().to_glib_none().0,
            glyphs.to_glib_none_mut().0,
        );
    }
}

/// Draws a [`pango::Layout`][crate::pango::Layout] in the specified cairo context.
///
/// The top-left corner of the [`pango::Layout`][crate::pango::Layout] will be drawn
/// at the current point of the cairo context.
/// ## `cr`
/// a Cairo context
/// ## `layout`
/// a Pango layout
#[doc(alias = "pango_cairo_show_layout")]
pub fn show_layout(cr: &cairo::Context, layout: &pango::Layout) {
    unsafe {
        ffi::pango_cairo_show_layout(mut_override(cr.to_glib_none().0), layout.to_glib_none().0);
    }
}

/// Draws a [`pango::LayoutLine`][crate::pango::LayoutLine] in the specified cairo context.
///
/// The origin of the glyphs (the left edge of the line) will
/// be drawn at the current point of the cairo context.
/// ## `cr`
/// a Cairo context
/// ## `line`
/// a [`pango::LayoutLine`][crate::pango::LayoutLine]
#[doc(alias = "pango_cairo_show_layout_line")]
pub fn show_layout_line(cr: &cairo::Context, line: &pango::LayoutLine) {
    unsafe {
        ffi::pango_cairo_show_layout_line(mut_override(cr.to_glib_none().0), line.to_glib_none().0);
    }
}

/// Updates a [`pango::Context`][crate::pango::Context] previously created for use with Cairo to
/// match the current transformation and target surface of a Cairo
/// context.
///
/// If any layouts have been created for the context, it's necessary
/// to call [`Layout::context_changed()`][crate::pango::Layout::context_changed()] on those layouts.
/// ## `cr`
/// a Cairo context
/// ## `context`
/// a [`pango::Context`][crate::pango::Context], from a pangocairo font map
#[doc(alias = "pango_cairo_update_context")]
pub fn update_context(cr: &cairo::Context, context: &pango::Context) {
    unsafe {
        ffi::pango_cairo_update_context(
            mut_override(cr.to_glib_none().0),
            context.to_glib_none().0,
        );
    }
}

/// Updates the private [`pango::Context`][crate::pango::Context] of a [`pango::Layout`][crate::pango::Layout] created with
/// [`create_layout()`][crate::create_layout()] to match the current transformation and target
/// surface of a Cairo context.
/// ## `cr`
/// a Cairo context
/// ## `layout`
/// a [`pango::Layout`][crate::pango::Layout], from [`create_layout()`][crate::create_layout()]
#[doc(alias = "pango_cairo_update_layout")]
pub fn update_layout(cr: &cairo::Context, layout: &pango::Layout) {
    unsafe {
        ffi::pango_cairo_update_layout(mut_override(cr.to_glib_none().0), layout.to_glib_none().0);
    }
}