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
// 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
#![allow(deprecated)]
use crate::{FileChooser, FileChooserAction, FileFilter, NativeDialog, Window};
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::{boxed::Box as Box_, fmt, mem::transmute};
glib::wrapper! {
/// Use [`FileDialog`][crate::FileDialog] instead
/// [`FileChooserNative`][crate::FileChooserNative] is an abstraction of a dialog suitable
/// for use with “File Open” or “File Save as” commands.
///
/// By default, this just uses a [`FileChooserDialog`][crate::FileChooserDialog] to implement
/// the actual dialog. However, on some 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`][crate::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`][crate::FileChooserNative] closely mirrors [`FileChooserDialog`][crate::FileChooserDialog],
/// the main difference is that there is no access to any [`Window`][crate::Window] or [`Widget`][crate::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`][crate::NativeDialog] functions.
///
/// Note that unlike [`FileChooserDialog`][crate::FileChooserDialog], [`FileChooserNative`][crate::FileChooserNative] objects
/// are not toplevel widgets, and GTK does not keep them alive. It is your
/// responsibility to keep a reference until you are done with the
/// object.
///
/// ## Typical usage
///
/// In the simplest of cases, you can the following code to use
/// [`FileChooserNative`][crate::FileChooserNative] to select a file for opening:
///
/// **⚠️ The following code is in c ⚠️**
///
/// ```c
/// static void
/// on_response (GtkNativeDialog *native,
/// int response)
/// {
/// if (response == GTK_RESPONSE_ACCEPT)
/// {
/// GtkFileChooser *chooser = GTK_FILE_CHOOSER (native);
/// GFile *file = gtk_file_chooser_get_file (chooser);
///
/// open_file (file);
///
/// g_object_unref (file);
/// }
///
/// g_object_unref (native);
/// }
///
/// // ...
/// GtkFileChooserNative *native;
/// GtkFileChooserAction action = GTK_FILE_CHOOSER_ACTION_OPEN;
///
/// native = gtk_file_chooser_native_new ("Open File",
/// parent_window,
/// action,
/// "_Open",
/// "_Cancel");
///
/// g_signal_connect (native, "response", G_CALLBACK (on_response), NULL);
/// gtk_native_dialog_show (GTK_NATIVE_DIALOG (native));
/// ```
///
/// To use a [`FileChooserNative`][crate::FileChooserNative] for saving, you can use this:
///
/// **⚠️ The following code is in c ⚠️**
///
/// ```c
/// static void
/// on_response (GtkNativeDialog *native,
/// int response)
/// {
/// if (response == GTK_RESPONSE_ACCEPT)
/// {
/// GtkFileChooser *chooser = GTK_FILE_CHOOSER (native);
/// GFile *file = gtk_file_chooser_get_file (chooser);
///
/// save_to_file (file);
///
/// g_object_unref (file);
/// }
///
/// g_object_unref (native);
/// }
///
/// // ...
/// GtkFileChooserNative *native;
/// GtkFileChooser *chooser;
/// GtkFileChooserAction action = GTK_FILE_CHOOSER_ACTION_SAVE;
///
/// native = gtk_file_chooser_native_new ("Save File",
/// parent_window,
/// action,
/// "_Save",
/// "_Cancel");
/// chooser = GTK_FILE_CHOOSER (native);
///
/// if (user_edited_a_new_document)
/// gtk_file_chooser_set_current_name (chooser, _("Untitled document"));
/// else
/// gtk_file_chooser_set_file (chooser, existing_file, NULL);
///
/// g_signal_connect (native, "response", G_CALLBACK (on_response), NULL);
/// gtk_native_dialog_show (GTK_NATIVE_DIALOG (native));
/// ```
///
/// For more information on how to best set up a file dialog,
/// see the [`FileChooserDialog`][crate::FileChooserDialog] documentation.
///
/// ## Response Codes
///
/// [`FileChooserNative`][crate::FileChooserNative] inherits from [`NativeDialog`][crate::NativeDialog],
/// which means it will return [`ResponseType::Accept`][crate::ResponseType::Accept] if the user accepted,
/// and [`ResponseType::Cancel`][crate::ResponseType::Cancel] if he pressed cancel. It can also return
/// [`ResponseType::DeleteEvent`][crate::ResponseType::DeleteEvent] if the window was unexpectedly closed.
///
/// ## Differences from [`FileChooserDialog`][crate::FileChooserDialog]
///
/// There are a few things in the [`FileChooser`][crate::FileChooser] interface that
/// are not possible to use with [`FileChooserNative`][crate::FileChooserNative], as such use would
/// prohibit the use of a native dialog.
///
/// No operations that change the dialog work while the dialog is visible.
/// Set all the properties that are required before showing the dialog.
///
/// ## Win32 details
///
/// On windows the `IFileDialog` implementation (added in Windows Vista) is
/// used. It supports many of the features that [`FileChooser`][crate::FileChooser] has, but
/// there are some things it does not handle:
///
/// * Any [`FileFilter`][crate::FileFilter] added using a mimetype
///
/// If any of these features are used the regular [`FileChooserDialog`][crate::FileChooserDialog]
/// will be used in place of the native one.
///
/// ## Portal details
///
/// 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.
///
/// ## macOS details
///
/// On macOS the `NSSavePanel` and `NSOpenPanel` classes are used to provide
/// native file chooser dialogs. Some features provided by [`FileChooser`][crate::FileChooser]
/// are not supported:
///
/// * Shortcut folders.
///
/// ## Properties
///
///
/// #### `accept-label`
/// The text used for the label on the accept button in the dialog, or
/// [`None`] to use the default text.
///
/// Readable | Writeable
///
///
/// #### `cancel-label`
/// The text used for the label on the cancel button in the dialog, or
/// [`None`] to use the default text.
///
/// Readable | Writeable
/// <details><summary><h4>NativeDialog</h4></summary>
///
///
/// #### `modal`
/// Whether the window should be modal with respect to its transient parent.
///
/// Readable | Writeable
///
///
/// #### `title`
/// The title of the dialog window
///
/// Readable | Writeable
///
///
/// #### `transient-for`
/// The transient parent of the dialog, or [`None`] for none.
///
/// Readable | Writeable | Construct
///
///
/// #### `visible`
/// Whether the window is currently visible.
///
/// Readable | Writeable
/// </details>
/// <details><summary><h4>FileChooser</h4></summary>
///
///
/// #### `action`
/// The type of operation that the file chooser is performing.
///
/// Readable | Writeable
///
///
/// #### `create-folders`
/// Whether a file chooser not in [`FileChooserAction::Open`][crate::FileChooserAction::Open] mode
/// will offer the user to create new folders.
///
/// Readable | Writeable
///
///
/// #### `filter`
/// The current filter for selecting files that are displayed.
///
/// Readable | Writeable
///
///
/// #### `filters`
/// A `GListModel` containing the filters that have been
/// added with gtk_file_chooser_add_filter().
///
/// The returned object should not be modified. It may
/// or may not be updated for later changes.
///
/// Readable
///
///
/// #### `select-multiple`
/// Whether to allow multiple files to be selected.
///
/// Readable | Writeable
///
///
/// #### `shortcut-folders`
/// A `GListModel` containing the shortcut folders that have been
/// added with gtk_file_chooser_add_shortcut_folder().
///
/// The returned object should not be modified. It may
/// or may not be updated for later changes.
///
/// Readable
/// </details>
///
/// # Implements
///
/// [`NativeDialogExt`][trait@crate::prelude::NativeDialogExt], [`trait@glib::ObjectExt`], [`FileChooserExt`][trait@crate::prelude::FileChooserExt], [`NativeDialogExtManual`][trait@crate::prelude::NativeDialogExtManual], [`FileChooserExtManual`][trait@crate::prelude::FileChooserExtManual]
#[doc(alias = "GtkFileChooserNative")]
pub struct FileChooserNative(Object<ffi::GtkFileChooserNative, ffi::GtkFileChooserNativeClass>) @extends NativeDialog, @implements FileChooser;
match fn {
type_ => || ffi::gtk_file_chooser_native_get_type(),
}
}
impl FileChooserNative {
/// Creates a new [`FileChooserNative`][crate::FileChooserNative].
///
/// # Deprecated since 4.10
///
/// Use [`FileDialog`][crate::FileDialog] instead
/// ## `title`
/// Title of the native
/// ## `parent`
/// Transient parent of the native
/// ## `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`][crate::FileChooserNative]
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_file_chooser_native_new")]
pub fn new(
title: Option<&str>,
parent: Option<&impl IsA<Window>>,
action: FileChooserAction,
accept_label: Option<&str>,
cancel_label: Option<&str>,
) -> FileChooserNative {
assert_initialized_main_thread!();
unsafe {
from_glib_full(ffi::gtk_file_chooser_native_new(
title.to_glib_none().0,
parent.map(|p| p.as_ref()).to_glib_none().0,
action.into_glib(),
accept_label.to_glib_none().0,
cancel_label.to_glib_none().0,
))
}
}
// rustdoc-stripper-ignore-next
/// Creates a new builder-pattern struct instance to construct [`FileChooserNative`] objects.
///
/// This method returns an instance of [`FileChooserNativeBuilder`](crate::builders::FileChooserNativeBuilder) which can be used to create [`FileChooserNative`] objects.
pub fn builder() -> FileChooserNativeBuilder {
FileChooserNativeBuilder::new()
}
/// Retrieves the custom label text for the accept button.
///
/// # Deprecated since 4.10
///
/// Use [`FileDialog`][crate::FileDialog] instead
///
/// # Returns
///
/// The custom label
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_file_chooser_native_get_accept_label")]
#[doc(alias = "get_accept_label")]
pub fn accept_label(&self) -> Option<glib::GString> {
unsafe {
from_glib_none(ffi::gtk_file_chooser_native_get_accept_label(
self.to_glib_none().0,
))
}
}
/// Retrieves the custom label text for the cancel button.
///
/// # Deprecated since 4.10
///
/// Use [`FileDialog`][crate::FileDialog] instead
///
/// # Returns
///
/// The custom label
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_file_chooser_native_get_cancel_label")]
#[doc(alias = "get_cancel_label")]
pub fn cancel_label(&self) -> Option<glib::GString> {
unsafe {
from_glib_none(ffi::gtk_file_chooser_native_get_cancel_label(
self.to_glib_none().0,
))
}
}
/// 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 should activate the button.
///
/// # Deprecated since 4.10
///
/// Use [`FileDialog`][crate::FileDialog] instead
/// ## `accept_label`
/// custom label
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_file_chooser_native_set_accept_label")]
pub fn set_accept_label(&self, accept_label: Option<&str>) {
unsafe {
ffi::gtk_file_chooser_native_set_accept_label(
self.to_glib_none().0,
accept_label.to_glib_none().0,
);
}
}
/// 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 should activate the button.
///
/// # Deprecated since 4.10
///
/// Use [`FileDialog`][crate::FileDialog] instead
/// ## `cancel_label`
/// custom label
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_file_chooser_native_set_cancel_label")]
pub fn set_cancel_label(&self, cancel_label: Option<&str>) {
unsafe {
ffi::gtk_file_chooser_native_set_cancel_label(
self.to_glib_none().0,
cancel_label.to_glib_none().0,
);
}
}
#[doc(alias = "accept-label")]
pub fn connect_accept_label_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_accept_label_trampoline<F: Fn(&FileChooserNative) + 'static>(
this: *mut ffi::GtkFileChooserNative,
_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::accept-label\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_accept_label_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "cancel-label")]
pub fn connect_cancel_label_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_cancel_label_trampoline<F: Fn(&FileChooserNative) + 'static>(
this: *mut ffi::GtkFileChooserNative,
_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::cancel-label\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_cancel_label_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl Default for FileChooserNative {
fn default() -> Self {
glib::object::Object::new::<Self>()
}
}
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`FileChooserNative`] 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 FileChooserNativeBuilder {
builder: glib::object::ObjectBuilder<'static, FileChooserNative>,
}
impl FileChooserNativeBuilder {
fn new() -> Self {
Self {
builder: glib::object::Object::builder(),
}
}
/// The text used for the label on the accept button in the dialog, or
/// [`None`] to use the default text.
pub fn accept_label(self, accept_label: impl Into<glib::GString>) -> Self {
Self {
builder: self.builder.property("accept-label", accept_label.into()),
}
}
/// The text used for the label on the cancel button in the dialog, or
/// [`None`] to use the default text.
pub fn cancel_label(self, cancel_label: impl Into<glib::GString>) -> Self {
Self {
builder: self.builder.property("cancel-label", cancel_label.into()),
}
}
/// Whether the window should be modal with respect to its transient parent.
pub fn modal(self, modal: bool) -> Self {
Self {
builder: self.builder.property("modal", modal),
}
}
/// The title of the dialog window
pub fn title(self, title: impl Into<glib::GString>) -> Self {
Self {
builder: self.builder.property("title", title.into()),
}
}
/// The transient parent of the dialog, or [`None`] for none.
pub fn transient_for(self, transient_for: &impl IsA<Window>) -> Self {
Self {
builder: self
.builder
.property("transient-for", transient_for.clone().upcast()),
}
}
/// Whether the window is currently visible.
pub fn visible(self, visible: bool) -> Self {
Self {
builder: self.builder.property("visible", visible),
}
}
/// The type of operation that the file chooser is performing.
/// Use [`FileDialog`][crate::FileDialog] instead
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
pub fn action(self, action: FileChooserAction) -> Self {
Self {
builder: self.builder.property("action", action),
}
}
/// Whether a file chooser not in [`FileChooserAction::Open`][crate::FileChooserAction::Open] mode
/// will offer the user to create new folders.
/// Use [`FileDialog`][crate::FileDialog] instead
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
pub fn create_folders(self, create_folders: bool) -> Self {
Self {
builder: self.builder.property("create-folders", create_folders),
}
}
/// The current filter for selecting files that are displayed.
/// Use [`FileDialog`][crate::FileDialog] instead
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
pub fn filter(self, filter: &FileFilter) -> Self {
Self {
builder: self.builder.property("filter", filter.clone()),
}
}
/// Whether to allow multiple files to be selected.
/// Use [`FileDialog`][crate::FileDialog] instead
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
pub fn select_multiple(self, select_multiple: bool) -> Self {
Self {
builder: self.builder.property("select-multiple", select_multiple),
}
}
// rustdoc-stripper-ignore-next
/// Build the [`FileChooserNative`].
#[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
pub fn build(self) -> FileChooserNative {
self.builder.build()
}
}
impl fmt::Display for FileChooserNative {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("FileChooserNative")
}
}