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 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
// 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::ContentFormats;
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::{boxed::Box as Box_, fmt, mem::transmute, pin::Pin, ptr};
glib::wrapper! {
/// A [`ContentProvider`][crate::ContentProvider] is used to provide content for the clipboard or
/// for drag-and-drop operations in a number of formats.
///
/// To create a [`ContentProvider`][crate::ContentProvider], use [`for_value()`][Self::for_value()]
/// or [`for_bytes()`][Self::for_bytes()].
///
/// GDK knows how to handle common text and image formats out-of-the-box. See
/// [`ContentSerializer`][crate::ContentSerializer] and [`ContentDeserializer`][crate::ContentDeserializer] if you want
/// to add support for application-specific data formats.
///
/// ## Properties
///
///
/// #### `formats`
/// The possible formats that the provider can provide its data in.
///
/// Readable
///
///
/// #### `storable-formats`
/// The subset of formats that clipboard managers should store this provider's data in.
///
/// Readable
///
/// ## Signals
///
///
/// #### `content-changed`
/// Emitted whenever the content provided by this provider has changed.
///
///
///
/// # Implements
///
/// [`ContentProviderExt`][trait@crate::prelude::ContentProviderExt], [`ContentProviderExtManual`][trait@crate::prelude::ContentProviderExtManual]
#[doc(alias = "GdkContentProvider")]
pub struct ContentProvider(Object<ffi::GdkContentProvider, ffi::GdkContentProviderClass>);
match fn {
type_ => || ffi::gdk_content_provider_get_type(),
}
}
impl ContentProvider {
pub const NONE: Option<&'static ContentProvider> = None;
/// Create a content provider that provides the given @bytes as data for
/// the given @mime_type.
/// ## `mime_type`
/// the mime type
/// ## `bytes`
/// a `GBytes` with the data for @mime_type
///
/// # Returns
///
/// a new [`ContentProvider`][crate::ContentProvider]
#[doc(alias = "gdk_content_provider_new_for_bytes")]
#[doc(alias = "new_for_bytes")]
pub fn for_bytes(mime_type: &str, bytes: &glib::Bytes) -> ContentProvider {
assert_initialized_main_thread!();
unsafe {
from_glib_full(ffi::gdk_content_provider_new_for_bytes(
mime_type.to_glib_none().0,
bytes.to_glib_none().0,
))
}
}
/// Create a content provider that provides the given @value.
/// ## `value`
/// a `GValue`
///
/// # Returns
///
/// a new [`ContentProvider`][crate::ContentProvider]
#[doc(alias = "gdk_content_provider_new_for_value")]
#[doc(alias = "new_for_value")]
pub fn for_value(value: &glib::Value) -> ContentProvider {
assert_initialized_main_thread!();
unsafe {
from_glib_full(ffi::gdk_content_provider_new_for_value(
value.to_glib_none().0,
))
}
}
/// Creates a content provider that represents all the given @providers.
///
/// Whenever data needs to be written, the union provider will try the given
/// @providers in the given order and the first one supporting a format will
/// be chosen to provide it.
///
/// This allows an easy way to support providing data in different formats.
/// For example, an image may be provided by its file and by the image
/// contents with a call such as
/// **⚠️ The following code is in c ⚠️**
///
/// ```c
/// gdk_content_provider_new_union ((GdkContentProvider *[2]) {
/// gdk_content_provider_new_typed (G_TYPE_FILE, file),
/// gdk_content_provider_new_typed (G_TYPE_TEXTURE, texture)
/// }, 2);
/// ```
/// ## `providers`
///
/// The [`ContentProvider`][crate::ContentProvider]s to present the union of
///
/// # Returns
///
/// a new [`ContentProvider`][crate::ContentProvider]
#[doc(alias = "gdk_content_provider_new_union")]
pub fn new_union(providers: &[ContentProvider]) -> ContentProvider {
assert_initialized_main_thread!();
let n_providers = providers.len() as _;
unsafe {
from_glib_full(ffi::gdk_content_provider_new_union(
providers.to_glib_full(),
n_providers,
))
}
}
}
mod sealed {
pub trait Sealed {}
impl<T: super::IsA<super::ContentProvider>> Sealed for T {}
}
/// Trait containing all [`struct@ContentProvider`] methods.
///
/// # Implementors
///
/// [`ContentProvider`][struct@crate::ContentProvider]
pub trait ContentProviderExt: IsA<ContentProvider> + sealed::Sealed + 'static {
/// Emits the ::content-changed signal.
#[doc(alias = "gdk_content_provider_content_changed")]
fn content_changed(&self) {
unsafe {
ffi::gdk_content_provider_content_changed(self.as_ref().to_glib_none().0);
}
}
/// Gets the formats that the provider can provide its current contents in.
///
/// # Returns
///
/// The formats of the provider
#[doc(alias = "gdk_content_provider_ref_formats")]
#[doc(alias = "ref_formats")]
fn formats(&self) -> ContentFormats {
unsafe {
from_glib_full(ffi::gdk_content_provider_ref_formats(
self.as_ref().to_glib_none().0,
))
}
}
/// Gets the formats that the provider suggests other applications to store
/// the data in.
///
/// An example of such an application would be a clipboard manager.
///
/// This can be assumed to be a subset of [`formats()`][Self::formats()].
///
/// # Returns
///
/// The storable formats of the provider
#[doc(alias = "gdk_content_provider_ref_storable_formats")]
#[doc(alias = "ref_storable_formats")]
fn storable_formats(&self) -> ContentFormats {
unsafe {
from_glib_full(ffi::gdk_content_provider_ref_storable_formats(
self.as_ref().to_glib_none().0,
))
}
}
/// Asynchronously writes the contents of @self to @stream in the given
/// @mime_type.
///
/// When the operation is finished @callback will be called. You must then call
/// `Gdk::ContentProvider::write_mime_type_finish()` to get the result
/// of the operation.
///
/// The given mime type does not need to be listed in the formats returned by
/// [`formats()`][Self::formats()]. However, if the given `GType` is
/// not supported, `G_IO_ERROR_NOT_SUPPORTED` will be reported.
///
/// The given @stream will not be closed.
/// ## `mime_type`
/// the mime type to provide the data in
/// ## `stream`
/// the `GOutputStream` to write to
/// ## `io_priority`
/// I/O priority of the request.
/// ## `cancellable`
/// optional `GCancellable` object, [`None`] to ignore.
/// ## `callback`
/// callback to call when the request is satisfied
#[doc(alias = "gdk_content_provider_write_mime_type_async")]
fn write_mime_type_async<P: FnOnce(Result<(), glib::Error>) + 'static>(
&self,
mime_type: &str,
stream: &impl IsA<gio::OutputStream>,
io_priority: glib::Priority,
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 write_mime_type_async_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 = ptr::null_mut();
let _ = ffi::gdk_content_provider_write_mime_type_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 = write_mime_type_async_trampoline::<P>;
unsafe {
ffi::gdk_content_provider_write_mime_type_async(
self.as_ref().to_glib_none().0,
mime_type.to_glib_none().0,
stream.as_ref().to_glib_none().0,
io_priority.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
fn write_mime_type_future(
&self,
mime_type: &str,
stream: &(impl IsA<gio::OutputStream> + Clone + 'static),
io_priority: glib::Priority,
) -> Pin<Box_<dyn std::future::Future<Output = Result<(), glib::Error>> + 'static>> {
let mime_type = String::from(mime_type);
let stream = stream.clone();
Box_::pin(gio::GioFuture::new(self, move |obj, cancellable, send| {
obj.write_mime_type_async(
&mime_type,
&stream,
io_priority,
Some(cancellable),
move |res| {
send.resolve(res);
},
);
}))
}
/// Emitted whenever the content provided by this provider has changed.
#[doc(alias = "content-changed")]
fn connect_content_changed<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn content_changed_trampoline<
P: IsA<ContentProvider>,
F: Fn(&P) + 'static,
>(
this: *mut ffi::GdkContentProvider,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(ContentProvider::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"content-changed\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
content_changed_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "formats")]
fn connect_formats_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_formats_trampoline<
P: IsA<ContentProvider>,
F: Fn(&P) + 'static,
>(
this: *mut ffi::GdkContentProvider,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(ContentProvider::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::formats\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_formats_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "storable-formats")]
fn connect_storable_formats_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_storable_formats_trampoline<
P: IsA<ContentProvider>,
F: Fn(&P) + 'static,
>(
this: *mut ffi::GdkContentProvider,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(ContentProvider::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::storable-formats\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_storable_formats_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl<O: IsA<ContentProvider>> ContentProviderExt for O {}
impl fmt::Display for ContentProvider {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("ContentProvider")
}
}