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
// 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 glib::object::Cast; use glib::object::IsA; use glib::signal::connect_raw; use glib::signal::SignalHandlerId; use glib::translate::*; use glib::GString; use glib::StaticType; use glib::ToValue; use glib::Value; use glib_sys; use gobject_sys; use gtk_sys; use std::boxed::Box as Box_; use std::fmt; use std::mem::transmute; use FileChooser; use FileChooserAction; use FileFilter; use NativeDialog; use Widget; #[cfg(any(feature = "v3_20", feature = "dox"))] use Window; glib_wrapper! { /// `FileChooserNative` is an abstraction of a dialog box suitable /// for use with “File/Open” or “File/Save as” commands. By default, this /// just uses a `FileChooserDialog` to implement the actual dialog. /// However, on certain platforms, such as Windows and macOS, the native platform /// file chooser is used instead. When the application is running in a /// sandboxed environment without direct filesystem access (such as Flatpak), /// `FileChooserNative` may call the proper APIs (portals) to let the user /// choose a file and make it available to the application. /// /// While the API of `FileChooserNative` closely mirrors `FileChooserDialog`, the main /// difference is that there is no access to any `Window` or `Widget` for the dialog. /// This is required, as there may not be one in the case of a platform native dialog. /// Showing, hiding and running the dialog is handled by the `NativeDialog` functions. /// /// ## Typical usage ## {`gtkfilechoosernative`-typical-usage} /// /// In the simplest of cases, you can the following code to use /// `FileChooserDialog` to select a file for opening: /// /// /// ```text /// GtkFileChooserNative *native; /// GtkFileChooserAction action = GTK_FILE_CHOOSER_ACTION_OPEN; /// gint res; /// /// native = gtk_file_chooser_native_new ("Open File", /// parent_window, /// action, /// "_Open", /// "_Cancel"); /// /// res = gtk_native_dialog_run (GTK_NATIVE_DIALOG (native)); /// if (res == GTK_RESPONSE_ACCEPT) /// { /// char *filename; /// GtkFileChooser *chooser = GTK_FILE_CHOOSER (native); /// filename = gtk_file_chooser_get_filename (chooser); /// open_file (filename); /// g_free (filename); /// } /// /// g_object_unref (native); /// ``` /// /// To use a dialog for saving, you can use this: /// /// /// ```text /// GtkFileChooserNative *native; /// GtkFileChooser *chooser; /// GtkFileChooserAction action = GTK_FILE_CHOOSER_ACTION_SAVE; /// gint res; /// /// native = gtk_file_chooser_native_new ("Save File", /// parent_window, /// action, /// "_Save", /// "_Cancel"); /// chooser = GTK_FILE_CHOOSER (native); /// /// gtk_file_chooser_set_do_overwrite_confirmation (chooser, TRUE); /// /// if (user_edited_a_new_document) /// gtk_file_chooser_set_current_name (chooser, /// _("Untitled document")); /// else /// gtk_file_chooser_set_filename (chooser, /// existing_filename); /// /// res = gtk_native_dialog_run (GTK_NATIVE_DIALOG (native)); /// if (res == GTK_RESPONSE_ACCEPT) /// { /// char *filename; /// /// filename = gtk_file_chooser_get_filename (chooser); /// save_to_file (filename); /// g_free (filename); /// } /// /// g_object_unref (native); /// ``` /// /// For more information on how to best set up a file dialog, see `FileChooserDialog`. /// /// ## Response Codes ## {`gtkfilechooserdialognative`-responses} /// /// `FileChooserNative` inherits from `NativeDialog`, which means it /// will return `ResponseType::Accept` if the user accepted, and /// `ResponseType::Cancel` if he pressed cancel. It can also return /// `ResponseType::DeleteEvent` if the window was unexpectedly closed. /// /// ## Differences from `FileChooserDialog` ## {`gtkfilechooserdialognative`-differences} /// /// There are a few things in the `FileChooser` API that are not /// possible to use with `FileChooserNative`, as such use would /// prohibit the use of a native dialog. /// /// There is no support for the signals that are emitted when the user /// navigates in the dialog, including: /// * `FileChooser::current-folder-changed` /// * `FileChooser::selection-changed` /// * `FileChooser::file-activated` /// * `FileChooser::confirm-overwrite` /// /// You can also not use the methods that directly control user navigation: /// * `FileChooser::unselect_filename` /// * `FileChooser::select_all` /// * `FileChooser::unselect_all` /// /// If you need any of the above you will have to use `FileChooserDialog` directly. /// /// No operations that change the the dialog work while the dialog is /// visible. Set all the properties that are required before showing the dialog. /// /// ## Win32 details ## {`gtkfilechooserdialognative`-win32} /// /// On windows the IFileDialog implementation (added in Windows Vista) is /// used. It supports many of the features that `FileChooserDialog` /// does, but there are some things it does not handle: /// /// * Extra widgets added with `FileChooser::set_extra_widget`. /// /// * Use of custom previews by connecting to `FileChooser::update-preview`. /// /// * Any `FileFilter` added using a mimetype or custom filter. /// /// If any of these features are used the regular `FileChooserDialog` /// will be used in place of the native one. /// /// ## Portal details ## {`gtkfilechooserdialognative`-portal} /// /// When the org.freedesktop.portal.FileChooser portal is available on the /// session bus, it is used to bring up an out-of-process file chooser. Depending /// on the kind of session the application is running in, this may or may not /// be a GTK+ file chooser. In this situation, the following things are not /// supported and will be silently ignored: /// /// * Extra widgets added with `FileChooser::set_extra_widget`. /// /// * Use of custom previews by connecting to `FileChooser::update-preview`. /// /// * Any `FileFilter` added with a custom filter. /// /// ## macOS details ## {`gtkfilechooserdialognative`-macos} /// /// On macOS the NSSavePanel and NSOpenPanel classes are used to provide native /// file chooser dialogs. Some features provided by `FileChooserDialog` are /// not supported: /// /// * Extra widgets added with `FileChooser::set_extra_widget`, unless the /// widget is an instance of `Label`, in which case the label text will be used /// to set the NSSavePanel message instance property. /// /// * Use of custom previews by connecting to `FileChooser::update-preview`. /// /// * Any `FileFilter` added with a custom filter. /// /// * Shortcut folders. /// /// Feature: `v3_20` /// /// # Implements /// /// [`FileChooserNativeExt`](trait.FileChooserNativeExt.html), [`NativeDialogExt`](trait.NativeDialogExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`FileChooserExt`](trait.FileChooserExt.html) pub struct FileChooserNative(Object<gtk_sys::GtkFileChooserNative, gtk_sys::GtkFileChooserNativeClass, FileChooserNativeClass>) @extends NativeDialog, @implements FileChooser; match fn { get_type => || gtk_sys::gtk_file_chooser_native_get_type(), } } impl FileChooserNative { /// Creates a new `FileChooserNative`. /// /// Feature: `v3_20` /// /// ## `title` /// Title of the native, or `None` /// ## `parent` /// Transient parent of the native, or `None` /// ## `action` /// Open or save mode for the dialog /// ## `accept_label` /// text to go in the accept button, or `None` for the default /// ## `cancel_label` /// text to go in the cancel button, or `None` for the default /// /// # Returns /// /// a new `FileChooserNative` #[cfg(any(feature = "v3_20", feature = "dox"))] pub fn new<P: IsA<Window>>( title: Option<&str>, parent: Option<&P>, action: FileChooserAction, accept_label: Option<&str>, cancel_label: Option<&str>, ) -> FileChooserNative { assert_initialized_main_thread!(); unsafe { from_glib_full(gtk_sys::gtk_file_chooser_native_new( title.to_glib_none().0, parent.map(|p| p.as_ref()).to_glib_none().0, action.to_glib(), accept_label.to_glib_none().0, cancel_label.to_glib_none().0, )) } } } #[derive(Clone, Default)] pub struct FileChooserNativeBuilder { accept_label: Option<String>, cancel_label: Option<String>, #[cfg(any(feature = "v3_20", feature = "dox"))] modal: Option<bool>, #[cfg(any(feature = "v3_20", feature = "dox"))] title: Option<String>, #[cfg(any(feature = "v3_20", feature = "dox"))] transient_for: Option<Window>, #[cfg(any(feature = "v3_20", feature = "dox"))] visible: Option<bool>, action: Option<FileChooserAction>, create_folders: Option<bool>, do_overwrite_confirmation: Option<bool>, extra_widget: Option<Widget>, filter: Option<FileFilter>, local_only: Option<bool>, preview_widget: Option<Widget>, preview_widget_active: Option<bool>, select_multiple: Option<bool>, show_hidden: Option<bool>, use_preview_label: Option<bool>, } impl FileChooserNativeBuilder { pub fn new() -> Self { Self::default() } pub fn build(self) -> FileChooserNative { let mut properties: Vec<(&str, &dyn ToValue)> = vec![]; if let Some(ref accept_label) = self.accept_label { properties.push(("accept-label", accept_label)); } if let Some(ref cancel_label) = self.cancel_label { properties.push(("cancel-label", cancel_label)); } #[cfg(any(feature = "v3_20", feature = "dox"))] { if let Some(ref modal) = self.modal { properties.push(("modal", modal)); } } #[cfg(any(feature = "v3_20", feature = "dox"))] { if let Some(ref title) = self.title { properties.push(("title", title)); } } #[cfg(any(feature = "v3_20", feature = "dox"))] { if let Some(ref transient_for) = self.transient_for { properties.push(("transient-for", transient_for)); } } #[cfg(any(feature = "v3_20", feature = "dox"))] { if let Some(ref visible) = self.visible { properties.push(("visible", visible)); } } if let Some(ref action) = self.action { properties.push(("action", action)); } if let Some(ref create_folders) = self.create_folders { properties.push(("create-folders", create_folders)); } if let Some(ref do_overwrite_confirmation) = self.do_overwrite_confirmation { properties.push(("do-overwrite-confirmation", do_overwrite_confirmation)); } if let Some(ref extra_widget) = self.extra_widget { properties.push(("extra-widget", extra_widget)); } if let Some(ref filter) = self.filter { properties.push(("filter", filter)); } if let Some(ref local_only) = self.local_only { properties.push(("local-only", local_only)); } if let Some(ref preview_widget) = self.preview_widget { properties.push(("preview-widget", preview_widget)); } if let Some(ref preview_widget_active) = self.preview_widget_active { properties.push(("preview-widget-active", preview_widget_active)); } if let Some(ref select_multiple) = self.select_multiple { properties.push(("select-multiple", select_multiple)); } if let Some(ref show_hidden) = self.show_hidden { properties.push(("show-hidden", show_hidden)); } if let Some(ref use_preview_label) = self.use_preview_label { properties.push(("use-preview-label", use_preview_label)); } let ret = glib::Object::new(FileChooserNative::static_type(), &properties) .expect("object new") .downcast::<FileChooserNative>() .expect("downcast"); ret } pub fn accept_label(mut self, accept_label: &str) -> Self { self.accept_label = Some(accept_label.to_string()); self } pub fn cancel_label(mut self, cancel_label: &str) -> Self { self.cancel_label = Some(cancel_label.to_string()); self } #[cfg(any(feature = "v3_20", feature = "dox"))] pub fn modal(mut self, modal: bool) -> Self { self.modal = Some(modal); self } #[cfg(any(feature = "v3_20", feature = "dox"))] pub fn title(mut self, title: &str) -> Self { self.title = Some(title.to_string()); self } #[cfg(any(feature = "v3_20", feature = "dox"))] pub fn transient_for<P: IsA<Window>>(mut self, transient_for: &P) -> Self { self.transient_for = Some(transient_for.clone().upcast()); self } #[cfg(any(feature = "v3_20", feature = "dox"))] pub fn visible(mut self, visible: bool) -> Self { self.visible = Some(visible); self } pub fn action(mut self, action: FileChooserAction) -> Self { self.action = Some(action); self } pub fn create_folders(mut self, create_folders: bool) -> Self { self.create_folders = Some(create_folders); self } pub fn do_overwrite_confirmation(mut self, do_overwrite_confirmation: bool) -> Self { self.do_overwrite_confirmation = Some(do_overwrite_confirmation); self } pub fn extra_widget<P: IsA<Widget>>(mut self, extra_widget: &P) -> Self { self.extra_widget = Some(extra_widget.clone().upcast()); self } pub fn filter(mut self, filter: &FileFilter) -> Self { self.filter = Some(filter.clone()); self } pub fn local_only(mut self, local_only: bool) -> Self { self.local_only = Some(local_only); self } pub fn preview_widget<P: IsA<Widget>>(mut self, preview_widget: &P) -> Self { self.preview_widget = Some(preview_widget.clone().upcast()); self } pub fn preview_widget_active(mut self, preview_widget_active: bool) -> Self { self.preview_widget_active = Some(preview_widget_active); self } pub fn select_multiple(mut self, select_multiple: bool) -> Self { self.select_multiple = Some(select_multiple); self } pub fn show_hidden(mut self, show_hidden: bool) -> Self { self.show_hidden = Some(show_hidden); self } pub fn use_preview_label(mut self, use_preview_label: bool) -> Self { self.use_preview_label = Some(use_preview_label); self } } pub const NONE_FILE_CHOOSER_NATIVE: Option<&FileChooserNative> = None; /// Trait containing all `FileChooserNative` methods. /// /// Feature: `v3_20` /// /// # Implementors /// /// [`FileChooserNative`](struct.FileChooserNative.html) pub trait FileChooserNativeExt: 'static { /// Retrieves the custom label text for the accept button. /// /// Feature: `v3_20` /// /// /// # Returns /// /// The custom label, or `None` for the default. This string /// is owned by GTK+ and should not be modified or freed #[cfg(any(feature = "v3_20", feature = "dox"))] fn get_accept_label(&self) -> Option<GString>; /// Retrieves the custom label text for the cancel button. /// /// Feature: `v3_20` /// /// /// # Returns /// /// The custom label, or `None` for the default. This string /// is owned by GTK+ and should not be modified or freed #[cfg(any(feature = "v3_20", feature = "dox"))] fn get_cancel_label(&self) -> Option<GString>; /// Sets the custom label text for the accept button. /// /// If characters in `label` are preceded by an underscore, they are underlined. /// If you need a literal underscore character in a label, use “__” (two /// underscores). The first underlined character represents a keyboard /// accelerator called a mnemonic. /// Pressing Alt and that key activates the button. /// /// Feature: `v3_20` /// /// ## `accept_label` /// custom label or `None` for the default #[cfg(any(feature = "v3_20", feature = "dox"))] fn set_accept_label(&self, accept_label: Option<&str>); /// Sets the custom label text for the cancel button. /// /// If characters in `label` are preceded by an underscore, they are underlined. /// If you need a literal underscore character in a label, use “__” (two /// underscores). The first underlined character represents a keyboard /// accelerator called a mnemonic. /// Pressing Alt and that key activates the button. /// /// Feature: `v3_20` /// /// ## `cancel_label` /// custom label or `None` for the default #[cfg(any(feature = "v3_20", feature = "dox"))] fn set_cancel_label(&self, cancel_label: Option<&str>); /// The text used for the label on the accept button in the dialog, or /// `None` to use the default text. fn get_property_accept_label(&self) -> Option<GString>; /// The text used for the label on the accept button in the dialog, or /// `None` to use the default text. fn set_property_accept_label(&self, accept_label: Option<&str>); /// The text used for the label on the cancel button in the dialog, or /// `None` to use the default text. fn get_property_cancel_label(&self) -> Option<GString>; /// The text used for the label on the cancel button in the dialog, or /// `None` to use the default text. fn set_property_cancel_label(&self, cancel_label: Option<&str>); fn connect_property_accept_label_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId; fn connect_property_cancel_label_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId; } impl<O: IsA<FileChooserNative>> FileChooserNativeExt for O { #[cfg(any(feature = "v3_20", feature = "dox"))] fn get_accept_label(&self) -> Option<GString> { unsafe { from_glib_none(gtk_sys::gtk_file_chooser_native_get_accept_label( self.as_ref().to_glib_none().0, )) } } #[cfg(any(feature = "v3_20", feature = "dox"))] fn get_cancel_label(&self) -> Option<GString> { unsafe { from_glib_none(gtk_sys::gtk_file_chooser_native_get_cancel_label( self.as_ref().to_glib_none().0, )) } } #[cfg(any(feature = "v3_20", feature = "dox"))] fn set_accept_label(&self, accept_label: Option<&str>) { unsafe { gtk_sys::gtk_file_chooser_native_set_accept_label( self.as_ref().to_glib_none().0, accept_label.to_glib_none().0, ); } } #[cfg(any(feature = "v3_20", feature = "dox"))] fn set_cancel_label(&self, cancel_label: Option<&str>) { unsafe { gtk_sys::gtk_file_chooser_native_set_cancel_label( self.as_ref().to_glib_none().0, cancel_label.to_glib_none().0, ); } } fn get_property_accept_label(&self) -> Option<GString> { unsafe { let mut value = Value::from_type(<GString as StaticType>::static_type()); gobject_sys::g_object_get_property( self.to_glib_none().0 as *mut gobject_sys::GObject, b"accept-label\0".as_ptr() as *const _, value.to_glib_none_mut().0, ); value .get() .expect("Return Value for property `accept-label` getter") } } fn set_property_accept_label(&self, accept_label: Option<&str>) { unsafe { gobject_sys::g_object_set_property( self.to_glib_none().0 as *mut gobject_sys::GObject, b"accept-label\0".as_ptr() as *const _, Value::from(accept_label).to_glib_none().0, ); } } fn get_property_cancel_label(&self) -> Option<GString> { unsafe { let mut value = Value::from_type(<GString as StaticType>::static_type()); gobject_sys::g_object_get_property( self.to_glib_none().0 as *mut gobject_sys::GObject, b"cancel-label\0".as_ptr() as *const _, value.to_glib_none_mut().0, ); value .get() .expect("Return Value for property `cancel-label` getter") } } fn set_property_cancel_label(&self, cancel_label: Option<&str>) { unsafe { gobject_sys::g_object_set_property( self.to_glib_none().0 as *mut gobject_sys::GObject, b"cancel-label\0".as_ptr() as *const _, Value::from(cancel_label).to_glib_none().0, ); } } fn connect_property_accept_label_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId { unsafe extern "C" fn notify_accept_label_trampoline<P, F: Fn(&P) + 'static>( this: *mut gtk_sys::GtkFileChooserNative, _param_spec: glib_sys::gpointer, f: glib_sys::gpointer, ) where P: IsA<FileChooserNative>, { let f: &F = &*(f as *const F); f(&FileChooserNative::from_glib_borrow(this).unsafe_cast_ref()) } unsafe { let f: Box_<F> = Box_::new(f); connect_raw( self.as_ptr() as *mut _, b"notify::accept-label\0".as_ptr() as *const _, Some(transmute::<_, unsafe extern "C" fn()>( notify_accept_label_trampoline::<Self, F> as *const (), )), Box_::into_raw(f), ) } } fn connect_property_cancel_label_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId { unsafe extern "C" fn notify_cancel_label_trampoline<P, F: Fn(&P) + 'static>( this: *mut gtk_sys::GtkFileChooserNative, _param_spec: glib_sys::gpointer, f: glib_sys::gpointer, ) where P: IsA<FileChooserNative>, { let f: &F = &*(f as *const F); f(&FileChooserNative::from_glib_borrow(this).unsafe_cast_ref()) } unsafe { let f: Box_<F> = Box_::new(f); connect_raw( self.as_ptr() as *mut _, b"notify::cancel-label\0".as_ptr() as *const _, Some(transmute::<_, unsafe extern "C" fn()>( notify_cancel_label_trampoline::<Self, F> as *const (), )), Box_::into_raw(f), ) } } } impl fmt::Display for FileChooserNative { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "FileChooserNative") } }