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 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692
// 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::SelectionData; use crate::TextBuffer; use glib::object::IsA; use glib::translate::*; use std::boxed::Box as Box_; use std::fmt; use std::mem; use std::ptr; glib::wrapper! { /// The [`Clipboard`][crate::Clipboard] object represents a clipboard of data shared /// between different processes or between different widgets in /// the same process. Each clipboard is identified by a name encoded as a /// [`gdk::Atom`][crate::gdk::Atom]. (Conversion to and from strings can be done with /// [`gdk::Atom::intern()`][crate::gdk::Atom::intern()] and [`gdk::Atom::name()`][crate::gdk::Atom::name()].) The default clipboard /// corresponds to the “CLIPBOARD” atom; another commonly used clipboard /// is the “PRIMARY” clipboard, which, in X, traditionally contains /// the currently selected text. /// /// To support having a number of different formats on the clipboard /// at the same time, the clipboard mechanism allows providing /// callbacks instead of the actual data. When you set the contents /// of the clipboard, you can either supply the data directly (via /// functions like [`set_text()`][Self::set_text()]), or you can supply a /// callback to be called at a later time when the data is needed (via /// `gtk_clipboard_set_with_data()` or `gtk_clipboard_set_with_owner()`.) /// Providing a callback also avoids having to make copies of the data /// when it is not needed. /// /// `gtk_clipboard_set_with_data()` and `gtk_clipboard_set_with_owner()` /// are quite similar; the choice between the two depends mostly on /// which is more convenient in a particular situation. /// The former is most useful when you want to have a blob of data /// with callbacks to convert it into the various data types that you /// advertise. When the `clear_func` you provided is called, you /// simply free the data blob. The latter is more useful when the /// contents of clipboard reflect the internal state of a [`glib::Object`][crate::glib::Object] /// (As an example, for the PRIMARY clipboard, when an entry widget /// provides the clipboard’s contents the contents are simply the /// text within the selected region.) If the contents change, the /// entry widget can call `gtk_clipboard_set_with_owner()` to update /// the timestamp for clipboard ownership, without having to worry /// about `clear_func` being called. /// /// Requesting the data from the clipboard is essentially /// asynchronous. If the contents of the clipboard are provided within /// the same process, then a direct function call will be made to /// retrieve the data, but if they are provided by another process, /// then the data needs to be retrieved from the other process, which /// may take some time. To avoid blocking the user interface, the call /// to request the selection, [`request_contents()`][Self::request_contents()] takes a /// callback that will be called when the contents are received (or /// when the request fails.) If you don’t want to deal with providing /// a separate callback, you can also use [`wait_for_contents()`][Self::wait_for_contents()]. /// What this does is run the GLib main loop recursively waiting for /// the contents. This can simplify the code flow, but you still have /// to be aware that other callbacks in your program can be called /// while this recursive mainloop is running. /// /// Along with the functions to get the clipboard contents as an /// arbitrary data chunk, there are also functions to retrieve /// it as text, [`request_text()`][Self::request_text()] and /// [`wait_for_text()`][Self::wait_for_text()]. These functions take care of /// determining which formats are advertised by the clipboard /// provider, asking for the clipboard in the best available format /// and converting the results into the UTF-8 encoding. (The standard /// form for representing strings in GTK+.) /// /// # Implements /// /// [`trait@glib::ObjectExt`] #[doc(alias = "GtkClipboard")] pub struct Clipboard(Object<ffi::GtkClipboard>); match fn { type_ => || ffi::gtk_clipboard_get_type(), } } impl Clipboard { /// Clears the contents of the clipboard. Generally this should only /// be called between the time you call `gtk_clipboard_set_with_owner()` /// or `gtk_clipboard_set_with_data()`, /// and when the `clear_func` you supplied is called. Otherwise, the /// clipboard may be owned by someone else. #[doc(alias = "gtk_clipboard_clear")] pub fn clear(&self) { unsafe { ffi::gtk_clipboard_clear(self.to_glib_none().0); } } /// Gets the [`gdk::Display`][crate::gdk::Display] associated with `self` /// /// # Returns /// /// the [`gdk::Display`][crate::gdk::Display] associated with `self` #[doc(alias = "gtk_clipboard_get_display")] #[doc(alias = "get_display")] pub fn display(&self) -> Option<gdk::Display> { unsafe { from_glib_none(ffi::gtk_clipboard_get_display(self.to_glib_none().0)) } } /// If the clipboard contents callbacks were set with /// `gtk_clipboard_set_with_owner()`, and the `gtk_clipboard_set_with_data()` or /// [`clear()`][Self::clear()] has not subsequently called, returns the owner set /// by `gtk_clipboard_set_with_owner()`. /// /// # Returns /// /// the owner of the clipboard, if any; /// otherwise [`None`]. #[doc(alias = "gtk_clipboard_get_owner")] #[doc(alias = "get_owner")] pub fn owner(&self) -> Option<glib::Object> { unsafe { from_glib_none(ffi::gtk_clipboard_get_owner(self.to_glib_none().0)) } } /// Gets the selection that this clipboard is for. /// /// # Returns /// /// the selection #[cfg(any(feature = "v3_22", feature = "dox"))] #[cfg_attr(feature = "dox", doc(cfg(feature = "v3_22")))] #[doc(alias = "gtk_clipboard_get_selection")] #[doc(alias = "get_selection")] pub fn selection(&self) -> Option<gdk::Atom> { unsafe { from_glib_none(ffi::gtk_clipboard_get_selection(self.to_glib_none().0)) } } /// Requests the contents of clipboard as the given target. /// When the results of the result are later received the supplied callback /// will be called. /// ## `target` /// an atom representing the form into which the clipboard /// owner should convert the selection. /// ## `callback` /// A function to call when the results are received /// (or the retrieval fails). If the retrieval fails the length field of /// `selection_data` will be negative. #[doc(alias = "gtk_clipboard_request_contents")] pub fn request_contents<P: FnOnce(&Clipboard, &SelectionData) + 'static>( &self, target: &gdk::Atom, callback: P, ) { let callback_data: Box_<P> = Box_::new(callback); unsafe extern "C" fn callback_func<P: FnOnce(&Clipboard, &SelectionData) + 'static>( clipboard: *mut ffi::GtkClipboard, selection_data: *mut ffi::GtkSelectionData, data: glib::ffi::gpointer, ) { let clipboard = from_glib_borrow(clipboard); let selection_data = from_glib_borrow(selection_data); let callback: Box_<P> = Box_::from_raw(data as *mut _); (*callback)(&clipboard, &selection_data); } let callback = Some(callback_func::<P> as _); let super_callback0: Box_<P> = callback_data; unsafe { ffi::gtk_clipboard_request_contents( self.to_glib_none().0, target.to_glib_none().0, callback, Box_::into_raw(super_callback0) as *mut _, ); } } /// Requests the contents of the clipboard as image. When the image is /// later received, it will be converted to a [`gdk_pixbuf::Pixbuf`][crate::gdk_pixbuf::Pixbuf], and /// `callback` will be called. /// /// The `pixbuf` parameter to `callback` will contain the resulting /// [`gdk_pixbuf::Pixbuf`][crate::gdk_pixbuf::Pixbuf] if the request succeeded, or [`None`] if it failed. This /// could happen for various reasons, in particular if the clipboard /// was empty or if the contents of the clipboard could not be /// converted into an image. /// ## `callback` /// a function to call when the image is received, /// or the retrieval fails. (It will always be called one way or the other.) #[doc(alias = "gtk_clipboard_request_image")] pub fn request_image<P: FnOnce(&Clipboard, &gdk_pixbuf::Pixbuf) + 'static>(&self, callback: P) { let callback_data: Box_<P> = Box_::new(callback); unsafe extern "C" fn callback_func<P: FnOnce(&Clipboard, &gdk_pixbuf::Pixbuf) + 'static>( clipboard: *mut ffi::GtkClipboard, pixbuf: *mut gdk_pixbuf::ffi::GdkPixbuf, data: glib::ffi::gpointer, ) { let clipboard = from_glib_borrow(clipboard); let pixbuf = from_glib_borrow(pixbuf); let callback: Box_<P> = Box_::from_raw(data as *mut _); (*callback)(&clipboard, &pixbuf); } let callback = Some(callback_func::<P> as _); let super_callback0: Box_<P> = callback_data; unsafe { ffi::gtk_clipboard_request_image( self.to_glib_none().0, callback, Box_::into_raw(super_callback0) as *mut _, ); } } /// Requests the contents of the clipboard as rich text. When the rich /// text is later received, `callback` will be called. /// /// The `text` parameter to `callback` will contain the resulting rich /// text if the request succeeded, or [`None`] if it failed. The `length` /// parameter will contain `text`’s length. This function can fail for /// various reasons, in particular if the clipboard was empty or if the /// contents of the clipboard could not be converted into rich text form. /// ## `buffer` /// a [`TextBuffer`][crate::TextBuffer] /// ## `callback` /// a function to call when the text is received, /// or the retrieval fails. (It will always be called one way or the other.) #[doc(alias = "gtk_clipboard_request_rich_text")] pub fn request_rich_text< P: IsA<TextBuffer>, Q: FnOnce(&Clipboard, &gdk::Atom, Option<&str>, usize) + 'static, >( &self, buffer: &P, callback: Q, ) { let callback_data: Box_<Q> = Box_::new(callback); unsafe extern "C" fn callback_func< P: IsA<TextBuffer>, Q: FnOnce(&Clipboard, &gdk::Atom, Option<&str>, usize) + 'static, >( clipboard: *mut ffi::GtkClipboard, format: gdk::ffi::GdkAtom, text: *const libc::c_char, length: libc::size_t, data: glib::ffi::gpointer, ) { let clipboard = from_glib_borrow(clipboard); let format = from_glib_borrow(format); let text: Borrowed<Option<glib::GString>> = from_glib_borrow(text); let callback: Box_<Q> = Box_::from_raw(data as *mut _); (*callback)(&clipboard, &format, text.as_ref().as_deref(), length); } let callback = Some(callback_func::<P, Q> as _); let super_callback0: Box_<Q> = callback_data; unsafe { ffi::gtk_clipboard_request_rich_text( self.to_glib_none().0, buffer.as_ref().to_glib_none().0, callback, Box_::into_raw(super_callback0) as *mut _, ); } } /// Requests the contents of the clipboard as text. When the text is /// later received, it will be converted to UTF-8 if necessary, and /// `callback` will be called. /// /// The `text` parameter to `callback` will contain the resulting text if /// the request succeeded, or [`None`] if it failed. This could happen for /// various reasons, in particular if the clipboard was empty or if the /// contents of the clipboard could not be converted into text form. /// ## `callback` /// a function to call when the text is received, /// or the retrieval fails. (It will always be called one way or the other.) #[doc(alias = "gtk_clipboard_request_text")] pub fn request_text<P: FnOnce(&Clipboard, Option<&str>) + 'static>(&self, callback: P) { let callback_data: Box_<P> = Box_::new(callback); unsafe extern "C" fn callback_func<P: FnOnce(&Clipboard, Option<&str>) + 'static>( clipboard: *mut ffi::GtkClipboard, text: *const libc::c_char, data: glib::ffi::gpointer, ) { let clipboard = from_glib_borrow(clipboard); let text: Borrowed<Option<glib::GString>> = from_glib_borrow(text); let callback: Box_<P> = Box_::from_raw(data as *mut _); (*callback)(&clipboard, text.as_ref().as_deref()); } let callback = Some(callback_func::<P> as _); let super_callback0: Box_<P> = callback_data; unsafe { ffi::gtk_clipboard_request_text( self.to_glib_none().0, callback, Box_::into_raw(super_callback0) as *mut _, ); } } /// Sets the contents of the clipboard to the given [`gdk_pixbuf::Pixbuf`][crate::gdk_pixbuf::Pixbuf]. /// GTK+ will take responsibility for responding for requests /// for the image, and for converting the image into the /// requested format. /// ## `pixbuf` /// a [`gdk_pixbuf::Pixbuf`][crate::gdk_pixbuf::Pixbuf] #[doc(alias = "gtk_clipboard_set_image")] pub fn set_image(&self, pixbuf: &gdk_pixbuf::Pixbuf) { unsafe { ffi::gtk_clipboard_set_image(self.to_glib_none().0, pixbuf.to_glib_none().0); } } /// Sets the contents of the clipboard to the given UTF-8 string. GTK+ will /// make a copy of the text and take responsibility for responding /// for requests for the text, and for converting the text into /// the requested format. /// ## `text` /// a UTF-8 string. /// ## `len` /// length of `text`, in bytes, or -1, in which case /// the length will be determined with `strlen()`. #[doc(alias = "gtk_clipboard_set_text")] pub fn set_text(&self, text: &str) { let len = text.len() as i32; unsafe { ffi::gtk_clipboard_set_text(self.to_glib_none().0, text.to_glib_none().0, len); } } /// Stores the current clipboard data somewhere so that it will stay /// around after the application has quit. #[doc(alias = "gtk_clipboard_store")] pub fn store(&self) { unsafe { ffi::gtk_clipboard_store(self.to_glib_none().0); } } /// Requests the contents of the clipboard using the given target. /// This function waits for the data to be received using the main /// loop, so events, timeouts, etc, may be dispatched during the wait. /// ## `target` /// an atom representing the form into which the clipboard /// owner should convert the selection. /// /// # Returns /// /// a newly-allocated [`SelectionData`][crate::SelectionData] object or [`None`] /// if retrieving the given target failed. If non-[`None`], /// this value must be freed with `gtk_selection_data_free()` /// when you are finished with it. #[doc(alias = "gtk_clipboard_wait_for_contents")] pub fn wait_for_contents(&self, target: &gdk::Atom) -> Option<SelectionData> { unsafe { from_glib_full(ffi::gtk_clipboard_wait_for_contents( self.to_glib_none().0, target.to_glib_none().0, )) } } /// Requests the contents of the clipboard as image and converts /// the result to a [`gdk_pixbuf::Pixbuf`][crate::gdk_pixbuf::Pixbuf]. This function waits for /// the data to be received using the main loop, so events, /// timeouts, etc, may be dispatched during the wait. /// /// # Returns /// /// a newly-allocated [`gdk_pixbuf::Pixbuf`][crate::gdk_pixbuf::Pixbuf] /// object which must be disposed with `g_object_unref()`, or /// [`None`] if retrieving the selection data failed. (This could /// happen for various reasons, in particular if the clipboard /// was empty or if the contents of the clipboard could not be /// converted into an image.) #[doc(alias = "gtk_clipboard_wait_for_image")] pub fn wait_for_image(&self) -> Option<gdk_pixbuf::Pixbuf> { unsafe { from_glib_full(ffi::gtk_clipboard_wait_for_image(self.to_glib_none().0)) } } /// Requests the contents of the clipboard as rich text. This function /// waits for the data to be received using the main loop, so events, /// timeouts, etc, may be dispatched during the wait. /// ## `buffer` /// a [`TextBuffer`][crate::TextBuffer] /// /// # Returns /// /// a /// newly-allocated binary block of data which must be /// freed with `g_free()`, or [`None`] if retrieving the /// selection data failed. (This could happen for various /// reasons, in particular if the clipboard was empty or /// if the contents of the clipboard could not be /// converted into text form.) /// /// ## `format` /// return location for the format of the returned data #[doc(alias = "gtk_clipboard_wait_for_rich_text")] pub fn wait_for_rich_text<P: IsA<TextBuffer>>(&self, buffer: &P) -> (Vec<u8>, gdk::Atom) { unsafe { let mut format = gdk::Atom::uninitialized(); let mut length = mem::MaybeUninit::uninit(); let ret = FromGlibContainer::from_glib_full_num( ffi::gtk_clipboard_wait_for_rich_text( self.to_glib_none().0, buffer.as_ref().to_glib_none().0, format.to_glib_none_mut().0, length.as_mut_ptr(), ), length.assume_init() as usize, ); (ret, format) } } /// Returns a list of targets that are present on the clipboard, or [`None`] /// if there aren’t any targets available. The returned list must be /// freed with `g_free()`. /// This function waits for the data to be received using the main /// loop, so events, timeouts, etc, may be dispatched during the wait. /// /// # Returns /// /// [`true`] if any targets are present on the clipboard, /// otherwise [`false`]. /// /// ## `targets` /// location /// to store an array of targets. The result stored here must /// be freed with `g_free()`. #[doc(alias = "gtk_clipboard_wait_for_targets")] pub fn wait_for_targets(&self) -> Option<Vec<gdk::Atom>> { unsafe { let mut targets = ptr::null_mut(); let mut n_targets = mem::MaybeUninit::uninit(); let ret = from_glib(ffi::gtk_clipboard_wait_for_targets( self.to_glib_none().0, &mut targets, n_targets.as_mut_ptr(), )); if ret { Some(FromGlibContainer::from_glib_container_num( targets, n_targets.assume_init() as usize, )) } else { None } } } /// Requests the contents of the clipboard as text and converts /// the result to UTF-8 if necessary. This function waits for /// the data to be received using the main loop, so events, /// timeouts, etc, may be dispatched during the wait. /// /// # Returns /// /// a newly-allocated UTF-8 string which must /// be freed with `g_free()`, or [`None`] if retrieving /// the selection data failed. (This could happen /// for various reasons, in particular if the /// clipboard was empty or if the contents of the /// clipboard could not be converted into text form.) #[doc(alias = "gtk_clipboard_wait_for_text")] pub fn wait_for_text(&self) -> Option<glib::GString> { unsafe { from_glib_full(ffi::gtk_clipboard_wait_for_text(self.to_glib_none().0)) } } /// Requests the contents of the clipboard as URIs. This function waits /// for the data to be received using the main loop, so events, /// timeouts, etc, may be dispatched during the wait. /// /// # Returns /// /// /// a newly-allocated [`None`]-terminated array of strings which must /// be freed with `g_strfreev()`, or [`None`] if retrieving the /// selection data failed. (This could happen for various reasons, /// in particular if the clipboard was empty or if the contents of /// the clipboard could not be converted into URI form.) #[doc(alias = "gtk_clipboard_wait_for_uris")] pub fn wait_for_uris(&self) -> Vec<glib::GString> { unsafe { FromGlibPtrContainer::from_glib_full(ffi::gtk_clipboard_wait_for_uris( self.to_glib_none().0, )) } } /// Test to see if there is an image available to be pasted /// This is done by requesting the TARGETS atom and checking /// if it contains any of the supported image targets. This function /// waits for the data to be received using the main loop, so events, /// timeouts, etc, may be dispatched during the wait. /// /// This function is a little faster than calling /// [`wait_for_image()`][Self::wait_for_image()] since it doesn’t need to retrieve /// the actual image data. /// /// # Returns /// /// [`true`] is there is an image available, [`false`] otherwise. #[doc(alias = "gtk_clipboard_wait_is_image_available")] pub fn wait_is_image_available(&self) -> bool { unsafe { from_glib(ffi::gtk_clipboard_wait_is_image_available( self.to_glib_none().0, )) } } /// Test to see if there is rich text available to be pasted /// This is done by requesting the TARGETS atom and checking /// if it contains any of the supported rich text targets. This function /// waits for the data to be received using the main loop, so events, /// timeouts, etc, may be dispatched during the wait. /// /// This function is a little faster than calling /// [`wait_for_rich_text()`][Self::wait_for_rich_text()] since it doesn’t need to retrieve /// the actual text. /// ## `buffer` /// a [`TextBuffer`][crate::TextBuffer] /// /// # Returns /// /// [`true`] is there is rich text available, [`false`] otherwise. #[doc(alias = "gtk_clipboard_wait_is_rich_text_available")] pub fn wait_is_rich_text_available<P: IsA<TextBuffer>>(&self, buffer: &P) -> bool { unsafe { from_glib(ffi::gtk_clipboard_wait_is_rich_text_available( self.to_glib_none().0, buffer.as_ref().to_glib_none().0, )) } } /// Checks if a clipboard supports pasting data of a given type. This /// function can be used to determine if a “Paste” menu item should be /// insensitive or not. /// /// If you want to see if there’s text available on the clipboard, use /// gtk_clipboard_wait_is_text_available () instead. /// ## `target` /// A [`gdk::Atom`][crate::gdk::Atom] indicating which target to look for. /// /// # Returns /// /// [`true`] if the target is available, [`false`] otherwise. #[doc(alias = "gtk_clipboard_wait_is_target_available")] pub fn wait_is_target_available(&self, target: &gdk::Atom) -> bool { unsafe { from_glib(ffi::gtk_clipboard_wait_is_target_available( self.to_glib_none().0, target.to_glib_none().0, )) } } /// Test to see if there is text available to be pasted /// This is done by requesting the TARGETS atom and checking /// if it contains any of the supported text targets. This function /// waits for the data to be received using the main loop, so events, /// timeouts, etc, may be dispatched during the wait. /// /// This function is a little faster than calling /// [`wait_for_text()`][Self::wait_for_text()] since it doesn’t need to retrieve /// the actual text. /// /// # Returns /// /// [`true`] is there is text available, [`false`] otherwise. #[doc(alias = "gtk_clipboard_wait_is_text_available")] pub fn wait_is_text_available(&self) -> bool { unsafe { from_glib(ffi::gtk_clipboard_wait_is_text_available( self.to_glib_none().0, )) } } /// Test to see if there is a list of URIs available to be pasted /// This is done by requesting the TARGETS atom and checking /// if it contains the URI targets. This function /// waits for the data to be received using the main loop, so events, /// timeouts, etc, may be dispatched during the wait. /// /// This function is a little faster than calling /// [`wait_for_uris()`][Self::wait_for_uris()] since it doesn’t need to retrieve /// the actual URI data. /// /// # Returns /// /// [`true`] is there is an URI list available, [`false`] otherwise. #[doc(alias = "gtk_clipboard_wait_is_uris_available")] pub fn wait_is_uris_available(&self) -> bool { unsafe { from_glib(ffi::gtk_clipboard_wait_is_uris_available( self.to_glib_none().0, )) } } /// Returns the clipboard object for the given selection. /// See [`for_display()`][Self::for_display()] for complete details. /// ## `selection` /// a [`gdk::Atom`][crate::gdk::Atom] which identifies the clipboard to use /// /// # Returns /// /// the appropriate clipboard object. If no clipboard /// already exists, a new one will be created. Once a clipboard /// object has been created, it is persistent and, since it is /// owned by GTK+, must not be freed or unreffed. #[doc(alias = "gtk_clipboard_get")] pub fn get(selection: &gdk::Atom) -> Clipboard { assert_initialized_main_thread!(); unsafe { from_glib_none(ffi::gtk_clipboard_get(selection.to_glib_none().0)) } } /// Returns the default clipboard object for use with cut/copy/paste menu items /// and keyboard shortcuts. /// ## `display` /// the [`gdk::Display`][crate::gdk::Display] for which the clipboard is to be retrieved. /// /// # Returns /// /// the default clipboard object. #[doc(alias = "gtk_clipboard_get_default")] #[doc(alias = "get_default")] pub fn default(display: &gdk::Display) -> Option<Clipboard> { assert_initialized_main_thread!(); unsafe { from_glib_none(ffi::gtk_clipboard_get_default(display.to_glib_none().0)) } } /// Returns the clipboard object for the given selection. /// Cut/copy/paste menu items and keyboard shortcuts should use /// the default clipboard, returned by passing `GDK_SELECTION_CLIPBOARD` for `selection`. /// (`GDK_NONE` is supported as a synonym for GDK_SELECTION_CLIPBOARD /// for backwards compatibility reasons.) /// The currently-selected object or text should be provided on the clipboard /// identified by `GDK_SELECTION_PRIMARY`. Cut/copy/paste menu items /// conceptually copy the contents of the `GDK_SELECTION_PRIMARY` clipboard /// to the default clipboard, i.e. they copy the selection to what the /// user sees as the clipboard. /// /// (Passing `GDK_NONE` is the same as using `gdk_atom_intern /// ("CLIPBOARD", FALSE)`. /// /// See the /// [FreeDesktop Clipboard Specification](http://www.freedesktop.org/Standards/clipboards-spec) /// for a detailed discussion of the “CLIPBOARD” vs. “PRIMARY” /// selections under the X window system. On Win32 the /// `GDK_SELECTION_PRIMARY` clipboard is essentially ignored.) /// /// It’s possible to have arbitrary named clipboards; if you do invent /// new clipboards, you should prefix the selection name with an /// underscore (because the ICCCM requires that nonstandard atoms are /// underscore-prefixed), and namespace it as well. For example, /// if your application called “Foo” has a special-purpose /// clipboard, you might call it “_FOO_SPECIAL_CLIPBOARD”. /// ## `display` /// the [`gdk::Display`][crate::gdk::Display] for which the clipboard is to be retrieved or created. /// ## `selection` /// a [`gdk::Atom`][crate::gdk::Atom] which identifies the clipboard to use. /// /// # Returns /// /// the appropriate clipboard object. If no /// clipboard already exists, a new one will be created. Once a clipboard /// object has been created, it is persistent and, since it is owned by /// GTK+, must not be freed or unrefd. #[doc(alias = "gtk_clipboard_get_for_display")] #[doc(alias = "get_for_display")] pub fn for_display(display: &gdk::Display, selection: &gdk::Atom) -> Clipboard { assert_initialized_main_thread!(); unsafe { from_glib_none(ffi::gtk_clipboard_get_for_display( display.to_glib_none().0, selection.to_glib_none().0, )) } } //#[doc(alias = "owner-change")] //pub fn connect_owner_change<Unsupported or ignored types>(&self, f: F) -> SignalHandlerId { // Ignored event: Gdk.EventOwnerChange //} } impl fmt::Display for Clipboard { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { f.write_str("Clipboard") } }