gtk4/auto/

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

glib::wrapper! {
    /// Represents a printer.
    ///
    /// You only need to deal directly with printers if you use the
    /// non-portable [`PrintUnixDialog`][crate::PrintUnixDialog] API.
    ///
    /// A [`Printer`][crate::Printer] allows to get status information about the printer,
    /// such as its description, its location, the number of queued jobs,
    /// etc. Most importantly, a [`Printer`][crate::Printer] object can be used to create
    /// a [`PrintJob`][crate::PrintJob] object, which lets you print to the printer.
    ///
    /// ## Properties
    ///
    ///
    /// #### `accepting-jobs`
    ///  [`true`] if the printer is accepting jobs.
    ///
    /// Readable
    ///
    ///
    /// #### `accepts-pdf`
    ///  [`true`] if this printer can accept PDF.
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `accepts-ps`
    ///  [`true`] if this printer can accept PostScript.
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `icon-name`
    ///  Icon name to use for the printer.
    ///
    /// Readable
    ///
    ///
    /// #### `is-virtual`
    ///  [`false`] if this represents a real hardware device.
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `job-count`
    ///  Number of jobs queued in the printer.
    ///
    /// Readable
    ///
    ///
    /// #### `location`
    ///  Information about the location of the printer.
    ///
    /// Readable
    ///
    ///
    /// #### `name`
    ///  The name of the printer.
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `paused`
    ///  [`true`] if this printer is paused.
    ///
    /// A paused printer still accepts jobs, but it does
    /// not print them.
    ///
    /// Readable
    ///
    ///
    /// #### `state-message`
    ///  String giving the current status of the printer.
    ///
    /// Readable
    ///
    /// ## Signals
    ///
    ///
    /// #### `details-acquired`
    ///  Emitted in response to a request for detailed information
    /// about a printer from the print backend.
    ///
    /// The @success parameter indicates if the information was
    /// actually obtained.
    ///
    ///
    ///
    /// # Implements
    ///
    /// [`trait@glib::ObjectExt`]
    #[doc(alias = "GtkPrinter")]
    pub struct Printer(Object<ffi::GtkPrinter>);

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

impl Printer {
    /// Returns whether the printer accepts input in
    /// PDF format.
    ///
    /// # Returns
    ///
    /// [`true`] if @self accepts PDF
    #[doc(alias = "gtk_printer_accepts_pdf")]
    #[doc(alias = "accepts-pdf")]
    pub fn accepts_pdf(&self) -> bool {
        unsafe { from_glib(ffi::gtk_printer_accepts_pdf(self.to_glib_none().0)) }
    }

    /// Returns whether the printer accepts input in
    /// PostScript format.
    ///
    /// # Returns
    ///
    /// [`true`] if @self accepts PostScript
    #[doc(alias = "gtk_printer_accepts_ps")]
    #[doc(alias = "accepts-ps")]
    pub fn accepts_ps(&self) -> bool {
        unsafe { from_glib(ffi::gtk_printer_accepts_ps(self.to_glib_none().0)) }
    }

    #[doc(alias = "gtk_printer_compare")]
    pub fn compare(&self, b: &Printer) -> i32 {
        unsafe { ffi::gtk_printer_compare(self.to_glib_none().0, b.to_glib_none().0) }
    }

    /// Returns the printer’s capabilities.
    ///
    /// This is useful when you’re using [`PrintUnixDialog`][crate::PrintUnixDialog]’s
    /// manual-capabilities setting and need to know which settings
    /// the printer can handle and which you must handle yourself.
    ///
    /// This will return 0 unless the printer’s details are
    /// available, see [`has_details()`][Self::has_details()] and
    /// [`request_details()`][Self::request_details()].
    ///
    /// # Returns
    ///
    /// the printer’s capabilities
    #[doc(alias = "gtk_printer_get_capabilities")]
    #[doc(alias = "get_capabilities")]
    pub fn capabilities(&self) -> PrintCapabilities {
        unsafe { from_glib(ffi::gtk_printer_get_capabilities(self.to_glib_none().0)) }
    }

    /// Returns default page size of @self.
    ///
    /// # Returns
    ///
    /// a newly allocated [`PageSetup`][crate::PageSetup] with default page size
    ///   of the printer.
    #[doc(alias = "gtk_printer_get_default_page_size")]
    #[doc(alias = "get_default_page_size")]
    pub fn default_page_size(&self) -> PageSetup {
        unsafe {
            from_glib_full(ffi::gtk_printer_get_default_page_size(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the description of the printer.
    ///
    /// # Returns
    ///
    /// the description of @self
    #[doc(alias = "gtk_printer_get_description")]
    #[doc(alias = "get_description")]
    pub fn description(&self) -> glib::GString {
        unsafe { from_glib_none(ffi::gtk_printer_get_description(self.to_glib_none().0)) }
    }

    /// Retrieve the hard margins of @self.
    ///
    /// These are the margins that define the area at the borders
    /// of the paper that the printer cannot print to.
    ///
    /// Note: This will not succeed unless the printer’s details are
    /// available, see [`has_details()`][Self::has_details()] and
    /// [`request_details()`][Self::request_details()].
    ///
    /// # Returns
    ///
    /// [`true`] iff the hard margins were retrieved
    ///
    /// ## `top`
    /// a location to store the top margin in
    ///
    /// ## `bottom`
    /// a location to store the bottom margin in
    ///
    /// ## `left`
    /// a location to store the left margin in
    ///
    /// ## `right`
    /// a location to store the right margin in
    #[doc(alias = "gtk_printer_get_hard_margins")]
    #[doc(alias = "get_hard_margins")]
    pub fn hard_margins(&self) -> Option<(f64, f64, f64, f64)> {
        unsafe {
            let mut top = std::mem::MaybeUninit::uninit();
            let mut bottom = std::mem::MaybeUninit::uninit();
            let mut left = std::mem::MaybeUninit::uninit();
            let mut right = std::mem::MaybeUninit::uninit();
            let ret = from_glib(ffi::gtk_printer_get_hard_margins(
                self.to_glib_none().0,
                top.as_mut_ptr(),
                bottom.as_mut_ptr(),
                left.as_mut_ptr(),
                right.as_mut_ptr(),
            ));
            if ret {
                Some((
                    top.assume_init(),
                    bottom.assume_init(),
                    left.assume_init(),
                    right.assume_init(),
                ))
            } else {
                None
            }
        }
    }

    /// Retrieve the hard margins of @self for @paper_size.
    ///
    /// These are the margins that define the area at the borders
    /// of the paper that the printer cannot print to.
    ///
    /// Note: This will not succeed unless the printer’s details are
    /// available, see [`has_details()`][Self::has_details()] and
    /// [`request_details()`][Self::request_details()].
    /// ## `paper_size`
    /// a [`PaperSize`][crate::PaperSize]
    ///
    /// # Returns
    ///
    /// [`true`] iff the hard margins were retrieved
    ///
    /// ## `top`
    /// a location to store the top margin in
    ///
    /// ## `bottom`
    /// a location to store the bottom margin in
    ///
    /// ## `left`
    /// a location to store the left margin in
    ///
    /// ## `right`
    /// a location to store the right margin in
    #[doc(alias = "gtk_printer_get_hard_margins_for_paper_size")]
    #[doc(alias = "get_hard_margins_for_paper_size")]
    pub fn hard_margins_for_paper_size(
        &self,
        paper_size: &mut PaperSize,
    ) -> Option<(f64, f64, f64, f64)> {
        unsafe {
            let mut top = std::mem::MaybeUninit::uninit();
            let mut bottom = std::mem::MaybeUninit::uninit();
            let mut left = std::mem::MaybeUninit::uninit();
            let mut right = std::mem::MaybeUninit::uninit();
            let ret = from_glib(ffi::gtk_printer_get_hard_margins_for_paper_size(
                self.to_glib_none().0,
                paper_size.to_glib_none_mut().0,
                top.as_mut_ptr(),
                bottom.as_mut_ptr(),
                left.as_mut_ptr(),
                right.as_mut_ptr(),
            ));
            if ret {
                Some((
                    top.assume_init(),
                    bottom.assume_init(),
                    left.assume_init(),
                    right.assume_init(),
                ))
            } else {
                None
            }
        }
    }

    /// Gets the name of the icon to use for the printer.
    ///
    /// # Returns
    ///
    /// the icon name for @self
    #[doc(alias = "gtk_printer_get_icon_name")]
    #[doc(alias = "get_icon_name")]
    #[doc(alias = "icon-name")]
    pub fn icon_name(&self) -> glib::GString {
        unsafe { from_glib_none(ffi::gtk_printer_get_icon_name(self.to_glib_none().0)) }
    }

    /// Gets the number of jobs currently queued on the printer.
    ///
    /// # Returns
    ///
    /// the number of jobs on @self
    #[doc(alias = "gtk_printer_get_job_count")]
    #[doc(alias = "get_job_count")]
    #[doc(alias = "job-count")]
    pub fn job_count(&self) -> i32 {
        unsafe { ffi::gtk_printer_get_job_count(self.to_glib_none().0) }
    }

    /// Returns a description of the location of the printer.
    ///
    /// # Returns
    ///
    /// the location of @self
    #[doc(alias = "gtk_printer_get_location")]
    #[doc(alias = "get_location")]
    pub fn location(&self) -> glib::GString {
        unsafe { from_glib_none(ffi::gtk_printer_get_location(self.to_glib_none().0)) }
    }

    /// Returns the name of the printer.
    ///
    /// # Returns
    ///
    /// the name of @self
    #[doc(alias = "gtk_printer_get_name")]
    #[doc(alias = "get_name")]
    pub fn name(&self) -> glib::GString {
        unsafe { from_glib_none(ffi::gtk_printer_get_name(self.to_glib_none().0)) }
    }

    /// Returns the state message describing the current state
    /// of the printer.
    ///
    /// # Returns
    ///
    /// the state message of @self
    #[doc(alias = "gtk_printer_get_state_message")]
    #[doc(alias = "get_state_message")]
    #[doc(alias = "state-message")]
    pub fn state_message(&self) -> glib::GString {
        unsafe { from_glib_none(ffi::gtk_printer_get_state_message(self.to_glib_none().0)) }
    }

    /// Returns whether the printer details are available.
    ///
    /// # Returns
    ///
    /// [`true`] if @self details are available
    #[doc(alias = "gtk_printer_has_details")]
    pub fn has_details(&self) -> bool {
        unsafe { from_glib(ffi::gtk_printer_has_details(self.to_glib_none().0)) }
    }

    /// Returns whether the printer is accepting jobs
    ///
    /// # Returns
    ///
    /// [`true`] if @self is accepting jobs
    #[doc(alias = "gtk_printer_is_accepting_jobs")]
    #[doc(alias = "accepting-jobs")]
    pub fn is_accepting_jobs(&self) -> bool {
        unsafe { from_glib(ffi::gtk_printer_is_accepting_jobs(self.to_glib_none().0)) }
    }

    /// Returns whether the printer is currently active (i.e.
    /// accepts new jobs).
    ///
    /// # Returns
    ///
    /// [`true`] if @self is active
    #[doc(alias = "gtk_printer_is_active")]
    pub fn is_active(&self) -> bool {
        unsafe { from_glib(ffi::gtk_printer_is_active(self.to_glib_none().0)) }
    }

    /// Returns whether the printer is the default printer.
    ///
    /// # Returns
    ///
    /// [`true`] if @self is the default
    #[doc(alias = "gtk_printer_is_default")]
    pub fn is_default(&self) -> bool {
        unsafe { from_glib(ffi::gtk_printer_is_default(self.to_glib_none().0)) }
    }

    /// Returns whether the printer is currently paused.
    ///
    /// A paused printer still accepts jobs, but it is not
    /// printing them.
    ///
    /// # Returns
    ///
    /// [`true`] if @self is paused
    #[doc(alias = "gtk_printer_is_paused")]
    #[doc(alias = "paused")]
    pub fn is_paused(&self) -> bool {
        unsafe { from_glib(ffi::gtk_printer_is_paused(self.to_glib_none().0)) }
    }

    /// Returns whether the printer is virtual (i.e. does not
    /// represent actual printer hardware, but something like
    /// a CUPS class).
    ///
    /// # Returns
    ///
    /// [`true`] if @self is virtual
    #[doc(alias = "gtk_printer_is_virtual")]
    #[doc(alias = "is-virtual")]
    pub fn is_virtual(&self) -> bool {
        unsafe { from_glib(ffi::gtk_printer_is_virtual(self.to_glib_none().0)) }
    }

    /// Lists all the paper sizes @self supports.
    ///
    /// This will return and empty list unless the printer’s details
    /// are available, see [`has_details()`][Self::has_details()] and
    /// [`request_details()`][Self::request_details()].
    ///
    /// # Returns
    ///
    /// a newly
    ///   allocated list of newly allocated [`PageSetup`][crate::PageSetup]s.
    #[doc(alias = "gtk_printer_list_papers")]
    pub fn list_papers(&self) -> Vec<PageSetup> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(ffi::gtk_printer_list_papers(
                self.to_glib_none().0,
            ))
        }
    }

    /// Requests the printer details.
    ///
    /// When the details are available, the
    /// [`details-acquired`][struct@crate::Printer#details-acquired] signal
    /// will be emitted on @self.
    #[doc(alias = "gtk_printer_request_details")]
    pub fn request_details(&self) {
        unsafe {
            ffi::gtk_printer_request_details(self.to_glib_none().0);
        }
    }

    /// Emitted in response to a request for detailed information
    /// about a printer from the print backend.
    ///
    /// The @success parameter indicates if the information was
    /// actually obtained.
    /// ## `success`
    /// [`true`] if the details were successfully acquired
    #[doc(alias = "details-acquired")]
    pub fn connect_details_acquired<F: Fn(&Self, bool) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn details_acquired_trampoline<F: Fn(&Printer, bool) + 'static>(
            this: *mut ffi::GtkPrinter,
            success: glib::ffi::gboolean,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this), from_glib(success))
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"details-acquired".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    details_acquired_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "accepting-jobs")]
    pub fn connect_accepting_jobs_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_accepting_jobs_trampoline<F: Fn(&Printer) + 'static>(
            this: *mut ffi::GtkPrinter,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this))
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::accepting-jobs".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_accepting_jobs_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "icon-name")]
    pub fn connect_icon_name_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_icon_name_trampoline<F: Fn(&Printer) + 'static>(
            this: *mut ffi::GtkPrinter,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this))
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::icon-name".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_icon_name_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "job-count")]
    pub fn connect_job_count_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_job_count_trampoline<F: Fn(&Printer) + 'static>(
            this: *mut ffi::GtkPrinter,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this))
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::job-count".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_job_count_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "location")]
    pub fn connect_location_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_location_trampoline<F: Fn(&Printer) + 'static>(
            this: *mut ffi::GtkPrinter,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this))
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::location".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_location_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "paused")]
    pub fn connect_paused_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_paused_trampoline<F: Fn(&Printer) + 'static>(
            this: *mut ffi::GtkPrinter,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this))
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::paused".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_paused_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "state-message")]
    pub fn connect_state_message_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_state_message_trampoline<F: Fn(&Printer) + 'static>(
            this: *mut ffi::GtkPrinter,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this))
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::state-message".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_state_message_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl std::fmt::Display for Printer {
    #[inline]
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        f.write_str(&self.name())
    }
}