1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
// 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;
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::{boxed::Box as Box_, pin::Pin};
glib::wrapper! {
/// A [`UriLauncher`][crate::UriLauncher] object collects the arguments that are needed to open a uri
/// with an application.
///
/// 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.
/// This API follows the GIO async pattern, and the result can be obtained by
/// calling `Gtk::UriLauncher::launch_finish()`.
///
/// To launch a file, use [`FileLauncher`][crate::FileLauncher].
///
/// ## Properties
///
///
/// #### `uri`
/// The uri to launch.
///
/// Readable | Writeable
///
/// # Implements
///
/// [`trait@glib::ObjectExt`]
#[doc(alias = "GtkUriLauncher")]
pub struct UriLauncher(Object<ffi::GtkUriLauncher, ffi::GtkUriLauncherClass>);
match fn {
type_ => || ffi::gtk_uri_launcher_get_type(),
}
}
impl UriLauncher {
/// Creates a new [`UriLauncher`][crate::UriLauncher] object.
/// ## `uri`
/// the uri to open
///
/// # Returns
///
/// the new [`UriLauncher`][crate::UriLauncher]
#[doc(alias = "gtk_uri_launcher_new")]
pub fn new(uri: &str) -> UriLauncher {
assert_initialized_main_thread!();
unsafe { from_glib_full(ffi::gtk_uri_launcher_new(uri.to_glib_none().0)) }
}
// rustdoc-stripper-ignore-next
/// Creates a new builder-pattern struct instance to construct [`UriLauncher`] objects.
///
/// This method returns an instance of [`UriLauncherBuilder`](crate::builders::UriLauncherBuilder) which can be used to create [`UriLauncher`] objects.
pub fn builder() -> UriLauncherBuilder {
UriLauncherBuilder::new()
}
/// Gets the uri that will be opened.
///
/// # Returns
///
/// the uri
#[doc(alias = "gtk_uri_launcher_get_uri")]
#[doc(alias = "get_uri")]
pub fn uri(&self) -> Option<glib::GString> {
unsafe { from_glib_none(ffi::gtk_uri_launcher_get_uri(self.to_glib_none().0)) }
}
/// Launch an application to open the uri.
///
/// This may present an app chooser dialog to the user.
///
/// The @callback will be called when the operation is completed.
/// It should call `Gtk::UriLauncher::launch_finish()` to obtain
/// the result.
/// ## `parent`
/// the parent [`Window`][crate::Window]
/// ## `cancellable`
/// a `GCancellable` to cancel the operation
/// ## `callback`
/// a callback to call when the operation is complete
#[doc(alias = "gtk_uri_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,
) {
let mut error = std::ptr::null_mut();
let _ = ffi::gtk_uri_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_uri_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);
},
);
}))
}
/// Sets the uri that will be opened.
/// ## `uri`
/// the uri
#[doc(alias = "gtk_uri_launcher_set_uri")]
pub fn set_uri(&self, uri: Option<&str>) {
unsafe {
ffi::gtk_uri_launcher_set_uri(self.to_glib_none().0, uri.to_glib_none().0);
}
}
#[cfg(feature = "v4_10")]
#[cfg_attr(docsrs, doc(cfg(feature = "v4_10")))]
#[doc(alias = "uri")]
pub fn connect_uri_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_uri_trampoline<F: Fn(&UriLauncher) + 'static>(
this: *mut ffi::GtkUriLauncher,
_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::uri\0".as_ptr() as *const _,
Some(std::mem::transmute::<_, unsafe extern "C" fn()>(
notify_uri_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
#[cfg(feature = "v4_10")]
#[cfg_attr(docsrs, doc(cfg(feature = "v4_10")))]
impl Default for UriLauncher {
fn default() -> Self {
glib::object::Object::new::<Self>()
}
}
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`UriLauncher`] 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 UriLauncherBuilder {
builder: glib::object::ObjectBuilder<'static, UriLauncher>,
}
impl UriLauncherBuilder {
fn new() -> Self {
Self {
builder: glib::object::Object::builder(),
}
}
/// The uri to launch.
#[cfg(feature = "v4_10")]
#[cfg_attr(docsrs, doc(cfg(feature = "v4_10")))]
pub fn uri(self, uri: impl Into<glib::GString>) -> Self {
Self {
builder: self.builder.property("uri", uri.into()),
}
}
// rustdoc-stripper-ignore-next
/// Build the [`UriLauncher`].
#[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
pub fn build(self) -> UriLauncher {
self.builder.build()
}
}