gtk4/auto/file_chooser.rs
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 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901
// 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::{ffi, FileChooserAction, FileFilter};
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::boxed::Box as Box_;
glib::wrapper! {
/// Use [`FileDialog`][crate::FileDialog] instead
/// [`FileChooser`][crate::FileChooser] is an interface that can be implemented by file
/// selection widgets.
///
/// In GTK, the main objects that implement this interface are
/// [`FileChooserWidget`][crate::FileChooserWidget] and [`FileChooserDialog`][crate::FileChooserDialog].
///
/// You do not need to write an object that implements the [`FileChooser`][crate::FileChooser]
/// interface unless you are trying to adapt an existing file selector to
/// expose a standard programming interface.
///
/// [`FileChooser`][crate::FileChooser] allows for shortcuts to various places in the filesystem.
/// In the default implementation these are displayed in the left pane. It
/// may be a bit confusing at first that these shortcuts come from various
/// sources and in various flavours, so lets explain the terminology here:
///
/// - Bookmarks: are created by the user, by dragging folders from the
/// right pane to the left pane, or by using the “Add”. Bookmarks
/// can be renamed and deleted by the user.
///
/// - Shortcuts: can be provided by the application. For example, a Paint
/// program may want to add a shortcut for a Clipart folder. Shortcuts
/// cannot be modified by the user.
///
/// - Volumes: are provided by the underlying filesystem abstraction. They are
/// the “roots” of the filesystem.
///
/// # File Names and Encodings
///
/// When the user is finished selecting files in a [`FileChooser`][crate::FileChooser], your
/// program can get the selected filenames as `GFile`s.
///
/// # Adding options
///
/// You can add extra widgets to a file chooser to provide options
/// that are not present in the default design, by using
/// [`FileChooserExtManual::add_choice()`][crate::prelude::FileChooserExtManual::add_choice()]. Each choice has an identifier and
/// a user visible label; additionally, each choice can have multiple
/// options. If a choice has no option, it will be rendered as a
/// check button with the given label; if a choice has options, it will
/// be rendered as a combo box.
///
/// ## Properties
///
///
/// #### `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
///
/// # Implements
///
/// [`FileChooserExt`][trait@crate::prelude::FileChooserExt], [`FileChooserExtManual`][trait@crate::prelude::FileChooserExtManual]
#[doc(alias = "GtkFileChooser")]
pub struct FileChooser(Interface<ffi::GtkFileChooser>);
match fn {
type_ => || ffi::gtk_file_chooser_get_type(),
}
}
impl FileChooser {
pub const NONE: Option<&'static FileChooser> = None;
}
/// Trait containing all [`struct@FileChooser`] methods.
///
/// # Implementors
///
/// [`FileChooserDialog`][struct@crate::FileChooserDialog], [`FileChooserNative`][struct@crate::FileChooserNative], [`FileChooserWidget`][struct@crate::FileChooserWidget], [`FileChooser`][struct@crate::FileChooser]
pub trait FileChooserExt: IsA<FileChooser> + 'static {
/// Adds @filter to the list of filters that the user can select between.
///
/// When a filter is selected, only files that are passed by that
/// filter are displayed.
///
/// Note that the @self takes ownership of the filter if it is floating,
/// so you have to ref and sink it if you want to keep a reference.
///
/// # Deprecated since 4.10
///
/// Use [`FileDialog`][crate::FileDialog] instead
/// ## `filter`
/// a [`FileFilter`][crate::FileFilter]
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_file_chooser_add_filter")]
fn add_filter(&self, filter: &FileFilter) {
unsafe {
ffi::gtk_file_chooser_add_filter(
self.as_ref().to_glib_none().0,
filter.to_glib_none().0,
);
}
}
/// Adds a folder to be displayed with the shortcut folders
/// in a file chooser.
///
/// # Deprecated since 4.10
///
/// Use [`FileDialog`][crate::FileDialog] instead
/// ## `folder`
/// a `GFile` for the folder to add
///
/// # Returns
///
/// [`true`] if the folder could be added successfully,
/// [`false`] otherwise.
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_file_chooser_add_shortcut_folder")]
fn add_shortcut_folder(&self, folder: &impl IsA<gio::File>) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::gtk_file_chooser_add_shortcut_folder(
self.as_ref().to_glib_none().0,
folder.as_ref().to_glib_none().0,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
/// Gets the type of operation that the file chooser is performing.
///
/// # Deprecated since 4.10
///
/// Use [`FileDialog`][crate::FileDialog] instead
///
/// # Returns
///
/// the action that the file selector is performing
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_file_chooser_get_action")]
#[doc(alias = "get_action")]
fn action(&self) -> FileChooserAction {
unsafe {
from_glib(ffi::gtk_file_chooser_get_action(
self.as_ref().to_glib_none().0,
))
}
}
/// Gets the currently selected option in the 'choice' with the given ID.
///
/// # Deprecated since 4.10
///
/// Use [`FileDialog`][crate::FileDialog] instead
/// ## `id`
/// the ID of the choice to get
///
/// # Returns
///
/// the ID of the currently selected option
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_file_chooser_get_choice")]
#[doc(alias = "get_choice")]
fn choice(&self, id: &str) -> Option<glib::GString> {
unsafe {
from_glib_none(ffi::gtk_file_chooser_get_choice(
self.as_ref().to_glib_none().0,
id.to_glib_none().0,
))
}
}
/// Gets whether file chooser will offer to create new folders.
///
/// # Deprecated since 4.10
///
/// Use [`FileDialog`][crate::FileDialog] instead
///
/// # Returns
///
/// [`true`] if the Create Folder button should be displayed.
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_file_chooser_get_create_folders")]
#[doc(alias = "get_create_folders")]
#[doc(alias = "create-folders")]
fn creates_folders(&self) -> bool {
unsafe {
from_glib(ffi::gtk_file_chooser_get_create_folders(
self.as_ref().to_glib_none().0,
))
}
}
/// Gets the current folder of @self as `GFile`.
///
/// # Deprecated since 4.10
///
/// Use [`FileDialog`][crate::FileDialog] instead
///
/// # Returns
///
/// the `GFile` for the current folder.
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_file_chooser_get_current_folder")]
#[doc(alias = "get_current_folder")]
fn current_folder(&self) -> Option<gio::File> {
unsafe {
from_glib_full(ffi::gtk_file_chooser_get_current_folder(
self.as_ref().to_glib_none().0,
))
}
}
/// Gets the current name in the file selector, as entered by the user.
///
/// This is meant to be used in save dialogs, to get the currently typed
/// filename when the file itself does not exist yet.
///
/// # Deprecated since 4.10
///
/// Use [`FileDialog`][crate::FileDialog] instead
///
/// # Returns
///
/// The raw text from the file chooser’s “Name” entry. Free with
/// g_free(). Note that this string is not a full pathname or URI; it is
/// whatever the contents of the entry are. Note also that this string is
/// in UTF-8 encoding, which is not necessarily the system’s encoding for
/// filenames.
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_file_chooser_get_current_name")]
#[doc(alias = "get_current_name")]
fn current_name(&self) -> Option<glib::GString> {
unsafe {
from_glib_full(ffi::gtk_file_chooser_get_current_name(
self.as_ref().to_glib_none().0,
))
}
}
/// Gets the `GFile` for the currently selected file in
/// the file selector.
///
/// If multiple files are selected, one of the files will be
/// returned at random.
///
/// If the file chooser is in folder mode, this function returns
/// the selected folder.
///
/// # Deprecated since 4.10
///
/// Use [`FileDialog`][crate::FileDialog] instead
///
/// # Returns
///
/// a selected `GFile`. You own the
/// returned file; use g_object_unref() to release it.
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_file_chooser_get_file")]
#[doc(alias = "get_file")]
fn file(&self) -> Option<gio::File> {
unsafe {
from_glib_full(ffi::gtk_file_chooser_get_file(
self.as_ref().to_glib_none().0,
))
}
}
/// Lists all the selected files and subfolders in the current folder
/// of @self as `GFile`.
///
/// # Deprecated since 4.10
///
/// Use [`FileDialog`][crate::FileDialog] instead
///
/// # Returns
///
/// a list model containing a `GFile` for each
/// selected file and subfolder in the current folder. Free the returned
/// list with g_object_unref().
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_file_chooser_get_files")]
#[doc(alias = "get_files")]
fn files(&self) -> gio::ListModel {
unsafe {
from_glib_full(ffi::gtk_file_chooser_get_files(
self.as_ref().to_glib_none().0,
))
}
}
/// Gets the current filter.
///
/// # Deprecated since 4.10
///
/// Use [`FileDialog`][crate::FileDialog] instead
///
/// # Returns
///
/// the current filter
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_file_chooser_get_filter")]
#[doc(alias = "get_filter")]
fn filter(&self) -> Option<FileFilter> {
unsafe {
from_glib_none(ffi::gtk_file_chooser_get_filter(
self.as_ref().to_glib_none().0,
))
}
}
/// Gets the current set of user-selectable filters, as a list model.
///
/// See [`add_filter()`][Self::add_filter()] and
/// [`remove_filter()`][Self::remove_filter()] for changing individual filters.
///
/// You should not modify the returned list model. Future changes to
/// @self may or may not affect the returned model.
///
/// # Deprecated since 4.10
///
/// Use [`FileDialog`][crate::FileDialog] instead
///
/// # Returns
///
/// a `GListModel` containing the current set
/// of user-selectable filters.
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_file_chooser_get_filters")]
#[doc(alias = "get_filters")]
fn filters(&self) -> gio::ListModel {
unsafe {
from_glib_full(ffi::gtk_file_chooser_get_filters(
self.as_ref().to_glib_none().0,
))
}
}
/// Gets whether multiple files can be selected in the file
/// chooser.
///
/// # Deprecated since 4.10
///
/// Use [`FileDialog`][crate::FileDialog] instead
///
/// # Returns
///
/// [`true`] if multiple files can be selected.
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_file_chooser_get_select_multiple")]
#[doc(alias = "get_select_multiple")]
#[doc(alias = "select-multiple")]
fn selects_multiple(&self) -> bool {
unsafe {
from_glib(ffi::gtk_file_chooser_get_select_multiple(
self.as_ref().to_glib_none().0,
))
}
}
/// Queries the list of shortcut folders in the file chooser.
///
/// You should not modify the returned list model. Future changes to
/// @self may or may not affect the returned model.
///
/// # Deprecated since 4.10
///
/// Use [`FileDialog`][crate::FileDialog] instead
///
/// # Returns
///
/// A list model of `GFile`s
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_file_chooser_get_shortcut_folders")]
#[doc(alias = "get_shortcut_folders")]
#[doc(alias = "shortcut-folders")]
fn shortcut_folders(&self) -> gio::ListModel {
unsafe {
from_glib_full(ffi::gtk_file_chooser_get_shortcut_folders(
self.as_ref().to_glib_none().0,
))
}
}
/// Removes a 'choice' that has been added with gtk_file_chooser_add_choice().
///
/// # Deprecated since 4.10
///
/// Use [`FileDialog`][crate::FileDialog] instead
/// ## `id`
/// the ID of the choice to remove
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_file_chooser_remove_choice")]
fn remove_choice(&self, id: &str) {
unsafe {
ffi::gtk_file_chooser_remove_choice(
self.as_ref().to_glib_none().0,
id.to_glib_none().0,
);
}
}
/// Removes @filter from the list of filters that the user can select between.
///
/// # Deprecated since 4.10
///
/// Use [`FileDialog`][crate::FileDialog] instead
/// ## `filter`
/// a [`FileFilter`][crate::FileFilter]
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_file_chooser_remove_filter")]
fn remove_filter(&self, filter: &FileFilter) {
unsafe {
ffi::gtk_file_chooser_remove_filter(
self.as_ref().to_glib_none().0,
filter.to_glib_none().0,
);
}
}
/// Removes a folder from the shortcut folders in a file chooser.
///
/// # Deprecated since 4.10
///
/// Use [`FileDialog`][crate::FileDialog] instead
/// ## `folder`
/// a `GFile` for the folder to remove
///
/// # Returns
///
/// [`true`] if the folder could be removed successfully,
/// [`false`] otherwise.
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_file_chooser_remove_shortcut_folder")]
fn remove_shortcut_folder(&self, folder: &impl IsA<gio::File>) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::gtk_file_chooser_remove_shortcut_folder(
self.as_ref().to_glib_none().0,
folder.as_ref().to_glib_none().0,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
/// Sets the type of operation that the chooser is performing.
///
/// The user interface is adapted to suit the selected action.
///
/// For example, an option to create a new folder might be shown
/// if the action is [`FileChooserAction::Save`][crate::FileChooserAction::Save] but not if the
/// action is [`FileChooserAction::Open`][crate::FileChooserAction::Open].
///
/// # Deprecated since 4.10
///
/// Use [`FileDialog`][crate::FileDialog] instead
/// ## `action`
/// the action that the file selector is performing
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_file_chooser_set_action")]
#[doc(alias = "action")]
fn set_action(&self, action: FileChooserAction) {
unsafe {
ffi::gtk_file_chooser_set_action(self.as_ref().to_glib_none().0, action.into_glib());
}
}
/// Selects an option in a 'choice' that has been added with
/// gtk_file_chooser_add_choice().
///
/// For a boolean choice, the possible options are "true" and "false".
///
/// # Deprecated since 4.10
///
/// Use [`FileDialog`][crate::FileDialog] instead
/// ## `id`
/// the ID of the choice to set
/// ## `option`
/// the ID of the option to select
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_file_chooser_set_choice")]
fn set_choice(&self, id: &str, option: &str) {
unsafe {
ffi::gtk_file_chooser_set_choice(
self.as_ref().to_glib_none().0,
id.to_glib_none().0,
option.to_glib_none().0,
);
}
}
/// Sets whether file chooser will offer to create new folders.
///
/// This is only relevant if the action is not set to be
/// [`FileChooserAction::Open`][crate::FileChooserAction::Open].
///
/// # Deprecated since 4.10
///
/// Use [`FileDialog`][crate::FileDialog] instead
/// ## `create_folders`
/// [`true`] if the Create Folder button should be displayed
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_file_chooser_set_create_folders")]
#[doc(alias = "create-folders")]
fn set_create_folders(&self, create_folders: bool) {
unsafe {
ffi::gtk_file_chooser_set_create_folders(
self.as_ref().to_glib_none().0,
create_folders.into_glib(),
);
}
}
/// Sets the current name in the file selector, as if entered
/// by the user.
///
/// Note that the name passed in here is a UTF-8 string rather
/// than a filename. This function is meant for such uses as a
/// suggested name in a “Save As...” dialog. You can pass
/// “Untitled.doc” or a similarly suitable suggestion for the @name.
///
/// If you want to preselect a particular existing file, you should
/// use [`set_file()`][Self::set_file()] instead.
///
/// Please see the documentation for those functions for an example
/// of using [`set_current_name()`][Self::set_current_name()] as well.
///
/// # Deprecated since 4.10
///
/// Use [`FileDialog`][crate::FileDialog] instead
/// ## `name`
/// the filename to use, as a UTF-8 string
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_file_chooser_set_current_name")]
fn set_current_name(&self, name: &str) {
unsafe {
ffi::gtk_file_chooser_set_current_name(
self.as_ref().to_glib_none().0,
name.to_glib_none().0,
);
}
}
/// Sets @file as the current filename for the file chooser.
///
/// This includes changing to the file’s parent folder and actually selecting
/// the file in list. If the @self is in [`FileChooserAction::Save`][crate::FileChooserAction::Save] mode,
/// the file’s base name will also appear in the dialog’s file name entry.
///
/// If the file name isn’t in the current folder of @self, then the current
/// folder of @self will be changed to the folder containing @file.
///
/// Note that the file must exist, or nothing will be done except
/// for the directory change.
///
/// If you are implementing a save dialog, you should use this function if
/// you already have a file name to which the user may save; for example,
/// when the user opens an existing file and then does “Save As…”. If you
/// don’t have a file name already — for example, if the user just created
/// a new file and is saving it for the first time, do not call this function.
///
/// Instead, use something similar to this:
///
/// **⚠️ The following code is in c ⚠️**
///
/// ```c
/// static void
/// prepare_file_chooser (GtkFileChooser *chooser,
/// GFile *existing_file)
/// {
/// gboolean document_is_new = (existing_file == NULL);
///
/// if (document_is_new)
/// {
/// GFile *default_file_for_saving = g_file_new_for_path ("./out.txt");
/// // the user just created a new document
/// gtk_file_chooser_set_current_folder (chooser, default_file_for_saving, NULL);
/// gtk_file_chooser_set_current_name (chooser, "Untitled document");
/// g_object_unref (default_file_for_saving);
/// }
/// else
/// {
/// // the user edited an existing document
/// gtk_file_chooser_set_file (chooser, existing_file, NULL);
/// }
/// }
/// ```
///
/// # Deprecated since 4.10
///
/// Use [`FileDialog`][crate::FileDialog] instead
/// ## `file`
/// the `GFile` to set as current
///
/// # Returns
///
/// Not useful
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_file_chooser_set_file")]
fn set_file(&self, file: &impl IsA<gio::File>) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::gtk_file_chooser_set_file(
self.as_ref().to_glib_none().0,
file.as_ref().to_glib_none().0,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
/// Sets the current filter.
///
/// Only the files that pass the filter will be displayed.
/// If the user-selectable list of filters is non-empty, then
/// the filter should be one of the filters in that list.
///
/// Setting the current filter when the list of filters is
/// empty is useful if you want to restrict the displayed
/// set of files without letting the user change it.
///
/// # Deprecated since 4.10
///
/// Use [`FileDialog`][crate::FileDialog] instead
/// ## `filter`
/// a [`FileFilter`][crate::FileFilter]
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_file_chooser_set_filter")]
#[doc(alias = "filter")]
fn set_filter(&self, filter: &FileFilter) {
unsafe {
ffi::gtk_file_chooser_set_filter(
self.as_ref().to_glib_none().0,
filter.to_glib_none().0,
);
}
}
/// Sets whether multiple files can be selected in the file chooser.
///
/// This is only relevant if the action is set to be
/// [`FileChooserAction::Open`][crate::FileChooserAction::Open] or
/// [`FileChooserAction::SelectFolder`][crate::FileChooserAction::SelectFolder].
///
/// # Deprecated since 4.10
///
/// Use [`FileDialog`][crate::FileDialog] instead
/// ## `select_multiple`
/// [`true`] if multiple files can be selected.
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[allow(deprecated)]
#[doc(alias = "gtk_file_chooser_set_select_multiple")]
#[doc(alias = "select-multiple")]
fn set_select_multiple(&self, select_multiple: bool) {
unsafe {
ffi::gtk_file_chooser_set_select_multiple(
self.as_ref().to_glib_none().0,
select_multiple.into_glib(),
);
}
}
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[doc(alias = "action")]
fn connect_action_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_action_trampoline<P: IsA<FileChooser>, F: Fn(&P) + 'static>(
this: *mut ffi::GtkFileChooser,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(FileChooser::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::action\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_action_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[doc(alias = "create-folders")]
fn connect_create_folders_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_create_folders_trampoline<
P: IsA<FileChooser>,
F: Fn(&P) + 'static,
>(
this: *mut ffi::GtkFileChooser,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(FileChooser::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::create-folders\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_create_folders_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[doc(alias = "filter")]
fn connect_filter_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_filter_trampoline<P: IsA<FileChooser>, F: Fn(&P) + 'static>(
this: *mut ffi::GtkFileChooser,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(FileChooser::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::filter\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_filter_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[doc(alias = "filters")]
fn connect_filters_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_filters_trampoline<P: IsA<FileChooser>, F: Fn(&P) + 'static>(
this: *mut ffi::GtkFileChooser,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(FileChooser::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::filters\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_filters_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[doc(alias = "select-multiple")]
fn connect_select_multiple_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_select_multiple_trampoline<
P: IsA<FileChooser>,
F: Fn(&P) + 'static,
>(
this: *mut ffi::GtkFileChooser,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(FileChooser::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::select-multiple\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_select_multiple_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
#[doc(alias = "shortcut-folders")]
fn connect_shortcut_folders_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_shortcut_folders_trampoline<
P: IsA<FileChooser>,
F: Fn(&P) + 'static,
>(
this: *mut ffi::GtkFileChooser,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(FileChooser::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::shortcut-folders\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_shortcut_folders_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl<O: IsA<FileChooser>> FileChooserExt for O {}