gtk4/auto/

print_operation_preview.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::{PageSetup, PrintContext, ffi};
use glib::{
    object::ObjectType as _,
    prelude::*,
    signal::{SignalHandlerId, connect_raw},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// The interface that is used to implement print preview.
    ///
    /// A [`PrintOperationPreview`][crate::PrintOperationPreview] object is passed to the
    /// [`preview`][struct@crate::PrintOperation#preview] signal by
    /// [`PrintOperation`][crate::PrintOperation].
    ///
    /// ## Signals
    ///
    ///
    /// #### `got-page-size`
    ///  Emitted once for each page that gets rendered to the preview.
    ///
    /// A handler for this signal should update the @context
    /// according to @page_setup and set up a suitable cairo
    /// context, using [`PrintContext::set_cairo_context()`][crate::PrintContext::set_cairo_context()].
    ///
    ///
    ///
    ///
    /// #### `ready`
    ///  The ::ready signal gets emitted once per preview operation,
    /// before the first page is rendered.
    ///
    /// A handler for this signal can be used for setup tasks.
    ///
    ///
    ///
    /// # Implements
    ///
    /// [`PrintOperationPreviewExt`][trait@crate::prelude::PrintOperationPreviewExt]
    #[doc(alias = "GtkPrintOperationPreview")]
    pub struct PrintOperationPreview(Interface<ffi::GtkPrintOperationPreview, ffi::GtkPrintOperationPreviewIface>);

    match fn {
        type_ => || ffi::gtk_print_operation_preview_get_type(),
    }
}

impl PrintOperationPreview {
    pub const NONE: Option<&'static PrintOperationPreview> = None;
}

/// Trait containing all [`struct@PrintOperationPreview`] methods.
///
/// # Implementors
///
/// [`PrintOperationPreview`][struct@crate::PrintOperationPreview], [`PrintOperation`][struct@crate::PrintOperation]
pub trait PrintOperationPreviewExt: IsA<PrintOperationPreview> + 'static {
    /// Ends a preview.
    ///
    /// This function must be called to finish a custom print preview.
    #[doc(alias = "gtk_print_operation_preview_end_preview")]
    fn end_preview(&self) {
        unsafe {
            ffi::gtk_print_operation_preview_end_preview(self.as_ref().to_glib_none().0);
        }
    }

    /// Returns whether the given page is included in the set of pages that
    /// have been selected for printing.
    /// ## `page_nr`
    /// a page number
    ///
    /// # Returns
    ///
    /// [`true`] if the page has been selected for printing
    #[doc(alias = "gtk_print_operation_preview_is_selected")]
    fn is_selected(&self, page_nr: i32) -> bool {
        unsafe {
            from_glib(ffi::gtk_print_operation_preview_is_selected(
                self.as_ref().to_glib_none().0,
                page_nr,
            ))
        }
    }

    /// Renders a page to the preview.
    ///
    /// This is using the print context that was passed to the
    /// [`preview`][struct@crate::PrintOperation#preview] handler together
    /// with @self.
    ///
    /// A custom print preview should use this function to render
    /// the currently selected page.
    ///
    /// Note that this function requires a suitable cairo context to
    /// be associated with the print context.
    /// ## `page_nr`
    /// the page to render
    #[doc(alias = "gtk_print_operation_preview_render_page")]
    fn render_page(&self, page_nr: i32) {
        unsafe {
            ffi::gtk_print_operation_preview_render_page(self.as_ref().to_glib_none().0, page_nr);
        }
    }

    /// Emitted once for each page that gets rendered to the preview.
    ///
    /// A handler for this signal should update the @context
    /// according to @page_setup and set up a suitable cairo
    /// context, using [`PrintContext::set_cairo_context()`][crate::PrintContext::set_cairo_context()].
    /// ## `context`
    /// the current [`PrintContext`][crate::PrintContext]
    /// ## `page_setup`
    /// the [`PageSetup`][crate::PageSetup] for the current page
    #[doc(alias = "got-page-size")]
    fn connect_got_page_size<F: Fn(&Self, &PrintContext, &PageSetup) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn got_page_size_trampoline<
            P: IsA<PrintOperationPreview>,
            F: Fn(&P, &PrintContext, &PageSetup) + 'static,
        >(
            this: *mut ffi::GtkPrintOperationPreview,
            context: *mut ffi::GtkPrintContext,
            page_setup: *mut ffi::GtkPageSetup,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(
                    PrintOperationPreview::from_glib_borrow(this).unsafe_cast_ref(),
                    &from_glib_borrow(context),
                    &from_glib_borrow(page_setup),
                )
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"got-page-size".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    got_page_size_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// The ::ready signal gets emitted once per preview operation,
    /// before the first page is rendered.
    ///
    /// A handler for this signal can be used for setup tasks.
    /// ## `context`
    /// the current [`PrintContext`][crate::PrintContext]
    #[doc(alias = "ready")]
    fn connect_ready<F: Fn(&Self, &PrintContext) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn ready_trampoline<
            P: IsA<PrintOperationPreview>,
            F: Fn(&P, &PrintContext) + 'static,
        >(
            this: *mut ffi::GtkPrintOperationPreview,
            context: *mut ffi::GtkPrintContext,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(
                    PrintOperationPreview::from_glib_borrow(this).unsafe_cast_ref(),
                    &from_glib_borrow(context),
                )
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"ready".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    ready_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl<O: IsA<PrintOperationPreview>> PrintOperationPreviewExt for O {}