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

use crate::{ffi, PrintOperationResponse, WebView};
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// Controls a print operation.
    ///
    /// A #WebKitPrintOperation controls a print operation in WebKit. With
    /// a similar API to #GtkPrintOperation, it lets you set the print
    /// settings with webkit_print_operation_set_print_settings() or
    /// display the print dialog with webkit_print_operation_run_dialog().
    ///
    /// ## Properties
    ///
    ///
    /// #### `page-setup`
    ///  The initial #GtkPageSetup for the print operation.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `print-settings`
    ///  The initial #GtkPrintSettings for the print operation.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `web-view`
    ///  The #WebKitWebView that will be printed.
    ///
    /// Readable | Writeable | Construct Only
    ///
    /// ## Signals
    ///
    ///
    /// #### `failed`
    ///  Emitted when an error occurs while printing. The given @error, of the domain
    /// `WEBKIT_PRINT_ERROR`, contains further details of the failure.
    /// The #WebKitPrintOperation::finished signal is emitted after this one.
    ///
    ///
    ///
    ///
    /// #### `finished`
    ///  Emitted when the print operation has finished doing everything
    /// required for printing.
    ///
    ///
    #[doc(alias = "WebKitPrintOperation")]
    pub struct PrintOperation(Object<ffi::WebKitPrintOperation, ffi::WebKitPrintOperationClass>);

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

impl PrintOperation {
    /// Create a new #WebKitPrintOperation to print @web_view contents.
    /// ## `web_view`
    /// a #WebKitWebView
    ///
    /// # Returns
    ///
    /// a new #WebKitPrintOperation.
    #[doc(alias = "webkit_print_operation_new")]
    pub fn new(web_view: &impl IsA<WebView>) -> PrintOperation {
        skip_assert_initialized!();
        unsafe {
            from_glib_full(ffi::webkit_print_operation_new(
                web_view.as_ref().to_glib_none().0,
            ))
        }
    }

    // rustdoc-stripper-ignore-next
    /// Creates a new builder-pattern struct instance to construct [`PrintOperation`] objects.
    ///
    /// This method returns an instance of [`PrintOperationBuilder`](crate::builders::PrintOperationBuilder) which can be used to create [`PrintOperation`] objects.
    pub fn builder() -> PrintOperationBuilder {
        PrintOperationBuilder::new()
    }

    /// Return the current page setup of @self.
    ///
    /// It returns [`None`] until
    /// either webkit_print_operation_set_page_setup() or webkit_print_operation_run_dialog()
    /// have been called.
    ///
    /// # Returns
    ///
    /// the current #GtkPageSetup of @self.
    #[doc(alias = "webkit_print_operation_get_page_setup")]
    #[doc(alias = "get_page_setup")]
    #[doc(alias = "page-setup")]
    pub fn page_setup(&self) -> Option<gtk::PageSetup> {
        unsafe {
            from_glib_none(ffi::webkit_print_operation_get_page_setup(
                self.to_glib_none().0,
            ))
        }
    }

    /// Return the current print settings of @self.
    ///
    /// It returns [`None`] until
    /// either webkit_print_operation_set_print_settings() or webkit_print_operation_run_dialog()
    /// have been called.
    ///
    /// # Returns
    ///
    /// the current #GtkPrintSettings of @self.
    #[doc(alias = "webkit_print_operation_get_print_settings")]
    #[doc(alias = "get_print_settings")]
    #[doc(alias = "print-settings")]
    pub fn print_settings(&self) -> Option<gtk::PrintSettings> {
        unsafe {
            from_glib_none(ffi::webkit_print_operation_get_print_settings(
                self.to_glib_none().0,
            ))
        }
    }

    /// Start a print operation using current print settings and page setup.
    ///
    /// Start a print operation using current print settings and page setup
    /// without showing the print dialog. If either print settings or page setup
    /// are not set with webkit_print_operation_set_print_settings() and
    /// webkit_print_operation_set_page_setup(), the default options will be used
    /// and the print job will be sent to the default printer.
    /// The #WebKitPrintOperation::finished signal is emitted when the printing
    /// operation finishes. If an error occurs while printing the signal
    /// #WebKitPrintOperation::failed is emitted before #WebKitPrintOperation::finished.
    ///
    /// If the app is running in a sandbox, this function only works if printing to
    /// a file that is in a location accessible to the sandbox, usually acquired
    /// through the File Chooser portal. This function will not work for physical
    /// printers when running in a sandbox.
    #[doc(alias = "webkit_print_operation_print")]
    pub fn print(&self) {
        unsafe {
            ffi::webkit_print_operation_print(self.to_glib_none().0);
        }
    }

    /// Run the print dialog and start printing.
    ///
    /// Run the print dialog and start printing using the options selected by
    /// the user. This method returns when the print dialog is closed.
    /// If the print dialog is cancelled [`PrintOperationResponse::Cancel`][crate::PrintOperationResponse::Cancel]
    /// is returned. If the user clicks on the print button, [`PrintOperationResponse::Print`][crate::PrintOperationResponse::Print]
    /// is returned and the print operation starts. In this case, the #WebKitPrintOperation::finished
    /// signal is emitted when the operation finishes. If an error occurs while printing, the signal
    /// #WebKitPrintOperation::failed is emitted before #WebKitPrintOperation::finished.
    /// If the print dialog is not cancelled current print settings and page setup of @self
    /// are updated with options selected by the user when Print button is pressed in print dialog.
    /// You can get the updated print settings and page setup by calling
    /// webkit_print_operation_get_print_settings() and webkit_print_operation_get_page_setup()
    /// after this method.
    /// ## `parent`
    /// transient parent of the print dialog
    ///
    /// # Returns
    ///
    /// the #WebKitPrintOperationResponse of the print dialog
    #[doc(alias = "webkit_print_operation_run_dialog")]
    pub fn run_dialog(&self, parent: Option<&impl IsA<gtk::Window>>) -> PrintOperationResponse {
        unsafe {
            from_glib(ffi::webkit_print_operation_run_dialog(
                self.to_glib_none().0,
                parent.map(|p| p.as_ref()).to_glib_none().0,
            ))
        }
    }

    /// Set the current page setup of @self.
    ///
    /// Current page setup is used for the
    /// initial values of the print dialog when webkit_print_operation_run_dialog() is called.
    /// ## `page_setup`
    /// a #GtkPageSetup to set
    #[doc(alias = "webkit_print_operation_set_page_setup")]
    #[doc(alias = "page-setup")]
    pub fn set_page_setup(&self, page_setup: &gtk::PageSetup) {
        unsafe {
            ffi::webkit_print_operation_set_page_setup(
                self.to_glib_none().0,
                page_setup.to_glib_none().0,
            );
        }
    }

    /// Set the current print settings of @self.
    ///
    /// Set the current print settings of @self. Current print settings are used for
    /// the initial values of the print dialog when webkit_print_operation_run_dialog() is called.
    /// ## `print_settings`
    /// a #GtkPrintSettings to set
    #[doc(alias = "webkit_print_operation_set_print_settings")]
    #[doc(alias = "print-settings")]
    pub fn set_print_settings(&self, print_settings: &gtk::PrintSettings) {
        unsafe {
            ffi::webkit_print_operation_set_print_settings(
                self.to_glib_none().0,
                print_settings.to_glib_none().0,
            );
        }
    }

    /// The #WebKitWebView that will be printed.
    #[doc(alias = "web-view")]
    pub fn web_view(&self) -> Option<WebView> {
        ObjectExt::property(self, "web-view")
    }

    /// Emitted when an error occurs while printing. The given @error, of the domain
    /// `WEBKIT_PRINT_ERROR`, contains further details of the failure.
    /// The #WebKitPrintOperation::finished signal is emitted after this one.
    /// ## `error`
    /// the #GError that was triggered
    #[doc(alias = "failed")]
    pub fn connect_failed<F: Fn(&Self, &glib::Error) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn failed_trampoline<F: Fn(&PrintOperation, &glib::Error) + 'static>(
            this: *mut ffi::WebKitPrintOperation,
            error: *mut glib::ffi::GError,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this), &from_glib_borrow(error))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"failed\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    failed_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Emitted when the print operation has finished doing everything
    /// required for printing.
    #[doc(alias = "finished")]
    pub fn connect_finished<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn finished_trampoline<F: Fn(&PrintOperation) + 'static>(
            this: *mut ffi::WebKitPrintOperation,
            f: glib::ffi::gpointer,
        ) {
            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 _,
                b"finished\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    finished_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "page-setup")]
    pub fn connect_page_setup_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_page_setup_trampoline<F: Fn(&PrintOperation) + 'static>(
            this: *mut ffi::WebKitPrintOperation,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            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 _,
                b"notify::page-setup\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_page_setup_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "print-settings")]
    pub fn connect_print_settings_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_print_settings_trampoline<F: Fn(&PrintOperation) + 'static>(
            this: *mut ffi::WebKitPrintOperation,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            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 _,
                b"notify::print-settings\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_print_settings_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl Default for PrintOperation {
    fn default() -> Self {
        glib::object::Object::new::<Self>()
    }
}

// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`PrintOperation`] objects.
///
/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
#[must_use = "The builder must be built to be used"]
pub struct PrintOperationBuilder {
    builder: glib::object::ObjectBuilder<'static, PrintOperation>,
}

impl PrintOperationBuilder {
    fn new() -> Self {
        Self {
            builder: glib::object::Object::builder(),
        }
    }

    /// The initial #GtkPageSetup for the print operation.
    pub fn page_setup(self, page_setup: &gtk::PageSetup) -> Self {
        Self {
            builder: self.builder.property("page-setup", page_setup.clone()),
        }
    }

    /// The initial #GtkPrintSettings for the print operation.
    pub fn print_settings(self, print_settings: &gtk::PrintSettings) -> Self {
        Self {
            builder: self
                .builder
                .property("print-settings", print_settings.clone()),
        }
    }

    /// The #WebKitWebView that will be printed.
    pub fn web_view(self, web_view: &impl IsA<WebView>) -> Self {
        Self {
            builder: self.builder.property("web-view", web_view.clone().upcast()),
        }
    }

    // rustdoc-stripper-ignore-next
    /// Build the [`PrintOperation`].
    #[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
    pub fn build(self) -> PrintOperation {
        self.builder.build()
    }
}