gtk4/auto/

file_launcher.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::{Window, ffi};
use glib::{
    prelude::*,
    signal::{SignalHandlerId, connect_raw},
    translate::*,
};
use std::{boxed::Box as Box_, pin::Pin};

glib::wrapper! {
    /// Asynchronous API to open a file with an application.
    ///
    /// [`FileLauncher`][crate::FileLauncher] collects the arguments that are needed to open the file.
    ///
    /// Depending on system configuration, user preferences and available APIs, this
    /// may or may not show an app chooser dialog or launch the default application
    /// right away.
    ///
    /// The operation is started with the [`launch()`][Self::launch()] function.
    ///
    /// To launch uris that don't represent files, use [`UriLauncher`][crate::UriLauncher].
    ///
    /// ## Properties
    ///
    ///
    /// #### `always-ask`
    ///  Whether to ask the user to choose an app for opening the file. If `FALSE`,
    /// the file might be opened with a default app or the previous choice.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `file`
    ///  The file to launch.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `writable`
    ///  Whether to make the file writable for the handler.
    ///
    /// Readable | Writeable
    ///
    /// # Implements
    ///
    /// [`trait@glib::ObjectExt`]
    #[doc(alias = "GtkFileLauncher")]
    pub struct FileLauncher(Object<ffi::GtkFileLauncher, ffi::GtkFileLauncherClass>);

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

impl FileLauncher {
    /// Creates a new [`FileLauncher`][crate::FileLauncher] object.
    /// ## `file`
    /// the file to open
    ///
    /// # Returns
    ///
    /// the new [`FileLauncher`][crate::FileLauncher]
    #[doc(alias = "gtk_file_launcher_new")]
    pub fn new(file: Option<&impl IsA<gio::File>>) -> FileLauncher {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_full(ffi::gtk_file_launcher_new(
                file.map(|p| p.as_ref()).to_glib_none().0,
            ))
        }
    }

    /// Returns whether to ask the user which app to use.
    ///
    /// # Returns
    ///
    /// true if always asking the user
    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    #[doc(alias = "gtk_file_launcher_get_always_ask")]
    #[doc(alias = "get_always_ask")]
    #[doc(alias = "always-ask")]
    pub fn must_always_ask(&self) -> bool {
        unsafe { from_glib(ffi::gtk_file_launcher_get_always_ask(self.to_glib_none().0)) }
    }

    /// Gets the file that will be opened.
    ///
    /// # Returns
    ///
    /// the file
    #[doc(alias = "gtk_file_launcher_get_file")]
    #[doc(alias = "get_file")]
    pub fn file(&self) -> Option<gio::File> {
        unsafe { from_glib_none(ffi::gtk_file_launcher_get_file(self.to_glib_none().0)) }
    }

    /// Returns whether to make the file writable for the handler.
    ///
    /// # Returns
    ///
    /// true if the file will be made writable
    #[cfg(feature = "v4_14")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_14")))]
    #[doc(alias = "gtk_file_launcher_get_writable")]
    #[doc(alias = "get_writable")]
    #[doc(alias = "writable")]
    pub fn is_writable(&self) -> bool {
        unsafe { from_glib(ffi::gtk_file_launcher_get_writable(self.to_glib_none().0)) }
    }

    /// Launches an application to open the file.
    ///
    /// This may present an app chooser dialog to the user.
    /// ## `parent`
    /// the parent window
    /// ## `cancellable`
    /// a cancellable to cancel the operation
    /// ## `callback`
    /// a callback to call when the
    ///   operation is complete
    #[doc(alias = "gtk_file_launcher_launch")]
    pub fn launch<P: FnOnce(Result<(), glib::Error>) + 'static>(
        &self,
        parent: Option<&impl IsA<Window>>,
        cancellable: Option<&impl IsA<gio::Cancellable>>,
        callback: P,
    ) {
        let main_context = glib::MainContext::ref_thread_default();
        let is_main_context_owner = main_context.is_owner();
        let has_acquired_main_context = (!is_main_context_owner)
            .then(|| main_context.acquire().ok())
            .flatten();
        assert!(
            is_main_context_owner || has_acquired_main_context.is_some(),
            "Async operations only allowed if the thread is owning the MainContext"
        );

        let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
            Box_::new(glib::thread_guard::ThreadGuard::new(callback));
        unsafe extern "C" fn launch_trampoline<P: FnOnce(Result<(), glib::Error>) + 'static>(
            _source_object: *mut glib::gobject_ffi::GObject,
            res: *mut gio::ffi::GAsyncResult,
            user_data: glib::ffi::gpointer,
        ) {
            unsafe {
                let mut error = std::ptr::null_mut();
                ffi::gtk_file_launcher_launch_finish(_source_object as *mut _, res, &mut error);
                let result = if error.is_null() {
                    Ok(())
                } else {
                    Err(from_glib_full(error))
                };
                let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
                    Box_::from_raw(user_data as *mut _);
                let callback: P = callback.into_inner();
                callback(result);
            }
        }
        let callback = launch_trampoline::<P>;
        unsafe {
            ffi::gtk_file_launcher_launch(
                self.to_glib_none().0,
                parent.map(|p| p.as_ref()).to_glib_none().0,
                cancellable.map(|p| p.as_ref()).to_glib_none().0,
                Some(callback),
                Box_::into_raw(user_data) as *mut _,
            );
        }
    }

    pub fn launch_future(
        &self,
        parent: Option<&(impl IsA<Window> + Clone + 'static)>,
    ) -> Pin<Box_<dyn std::future::Future<Output = Result<(), glib::Error>> + 'static>> {
        let parent = parent.map(ToOwned::to_owned);
        Box_::pin(gio::GioFuture::new(self, move |obj, cancellable, send| {
            obj.launch(
                parent.as_ref().map(::std::borrow::Borrow::borrow),
                Some(cancellable),
                move |res| {
                    send.resolve(res);
                },
            );
        }))
    }

    /// Launches a file manager to show the file in its parent directory.
    ///
    /// This is only supported for native files. It will fail if @file
    /// is e.g. a http:// uri.
    /// ## `parent`
    /// the parent window
    /// ## `cancellable`
    /// a cancellable to cancel the operation
    /// ## `callback`
    /// a callback to call when the
    ///   operation is complete
    #[doc(alias = "gtk_file_launcher_open_containing_folder")]
    pub fn open_containing_folder<P: FnOnce(Result<(), glib::Error>) + 'static>(
        &self,
        parent: Option<&impl IsA<Window>>,
        cancellable: Option<&impl IsA<gio::Cancellable>>,
        callback: P,
    ) {
        let main_context = glib::MainContext::ref_thread_default();
        let is_main_context_owner = main_context.is_owner();
        let has_acquired_main_context = (!is_main_context_owner)
            .then(|| main_context.acquire().ok())
            .flatten();
        assert!(
            is_main_context_owner || has_acquired_main_context.is_some(),
            "Async operations only allowed if the thread is owning the MainContext"
        );

        let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
            Box_::new(glib::thread_guard::ThreadGuard::new(callback));
        unsafe extern "C" fn open_containing_folder_trampoline<
            P: FnOnce(Result<(), glib::Error>) + 'static,
        >(
            _source_object: *mut glib::gobject_ffi::GObject,
            res: *mut gio::ffi::GAsyncResult,
            user_data: glib::ffi::gpointer,
        ) {
            unsafe {
                let mut error = std::ptr::null_mut();
                ffi::gtk_file_launcher_open_containing_folder_finish(
                    _source_object as *mut _,
                    res,
                    &mut error,
                );
                let result = if error.is_null() {
                    Ok(())
                } else {
                    Err(from_glib_full(error))
                };
                let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
                    Box_::from_raw(user_data as *mut _);
                let callback: P = callback.into_inner();
                callback(result);
            }
        }
        let callback = open_containing_folder_trampoline::<P>;
        unsafe {
            ffi::gtk_file_launcher_open_containing_folder(
                self.to_glib_none().0,
                parent.map(|p| p.as_ref()).to_glib_none().0,
                cancellable.map(|p| p.as_ref()).to_glib_none().0,
                Some(callback),
                Box_::into_raw(user_data) as *mut _,
            );
        }
    }

    pub fn open_containing_folder_future(
        &self,
        parent: Option<&(impl IsA<Window> + Clone + 'static)>,
    ) -> Pin<Box_<dyn std::future::Future<Output = Result<(), glib::Error>> + 'static>> {
        let parent = parent.map(ToOwned::to_owned);
        Box_::pin(gio::GioFuture::new(self, move |obj, cancellable, send| {
            obj.open_containing_folder(
                parent.as_ref().map(::std::borrow::Borrow::borrow),
                Some(cancellable),
                move |res| {
                    send.resolve(res);
                },
            );
        }))
    }

    /// Sets whether to always ask the user which app to use.
    ///
    /// If false, the file might be opened with a default app
    /// or the previous choice.
    /// ## `always_ask`
    /// whether to always ask
    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    #[doc(alias = "gtk_file_launcher_set_always_ask")]
    #[doc(alias = "always-ask")]
    pub fn set_always_ask(&self, always_ask: bool) {
        unsafe {
            ffi::gtk_file_launcher_set_always_ask(self.to_glib_none().0, always_ask.into_glib());
        }
    }

    /// Sets the file that will be opened.
    /// ## `file`
    /// the file
    #[doc(alias = "gtk_file_launcher_set_file")]
    #[doc(alias = "file")]
    pub fn set_file(&self, file: Option<&impl IsA<gio::File>>) {
        unsafe {
            ffi::gtk_file_launcher_set_file(
                self.to_glib_none().0,
                file.map(|p| p.as_ref()).to_glib_none().0,
            );
        }
    }

    /// Sets whether to make the file writable for the handler.
    /// ## `writable`
    /// whether to make the file writable
    #[cfg(feature = "v4_14")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_14")))]
    #[doc(alias = "gtk_file_launcher_set_writable")]
    #[doc(alias = "writable")]
    pub fn set_writable(&self, writable: bool) {
        unsafe {
            ffi::gtk_file_launcher_set_writable(self.to_glib_none().0, writable.into_glib());
        }
    }

    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    #[doc(alias = "always-ask")]
    pub fn connect_always_ask_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_always_ask_trampoline<F: Fn(&FileLauncher) + 'static>(
            this: *mut ffi::GtkFileLauncher,
            _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::always-ask".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_always_ask_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[cfg(feature = "v4_10")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_10")))]
    #[doc(alias = "file")]
    pub fn connect_file_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_file_trampoline<F: Fn(&FileLauncher) + 'static>(
            this: *mut ffi::GtkFileLauncher,
            _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::file".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_file_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[cfg(feature = "v4_14")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_14")))]
    #[doc(alias = "writable")]
    pub fn connect_writable_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_writable_trampoline<F: Fn(&FileLauncher) + 'static>(
            this: *mut ffi::GtkFileLauncher,
            _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::writable".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_writable_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}