FileChooser

---

Object Hierarchy:

Description:

Content:

Properties:

• public FileChooserAction action { get; set; }
  The type of operation that the file chooser is performing.
• public bool create_folders { get; set; }
  Whether a file chooser not in gtk_file_chooser_action_open mode will offer the user to create new folders.
• public bool do_overwrite_confirmation { get; set; }
  Whether a file chooser in gtk_file_chooser_action_save mode will present an overwrite confirmation dialog if the user selects a file name that already exists.
• public Widget extra_widget { get; set; }
• public string file_system_backend { construct; }
• public FileFilter filter { get; set; }
  The current filter for selecting files that are displayed.
• public bool local_only { get; set; }
• public Widget preview_widget { get; set; }
• public bool preview_widget_active { get; set; }
• public bool select_multiple { get; set; }
  Whether to allow multiple files to be selected.
• public bool show_hidden { get; set; }
• public bool use_preview_label { get; set; }

Static methods:

• public static Quark error_quark ()
  Registers an error quark for `GtkFileChooser` errors.

Methods:

• public void add_filter (owned FileFilter filter)
  Adds filter to the list of filters that the user can select between.
• public bool add_shortcut_folder (string folder) throws Error
  Adds a folder to be displayed with the shortcut folders in a file chooser.
• public bool add_shortcut_folder_uri (string uri) throws Error
  Adds a folder URI to be displayed with the shortcut folders in a file chooser.
• public FileChooserAction get_action ()
  Gets the type of operation that the file chooser is performing.
• public bool get_create_folders ()
  Gets whether file chooser will offer to create new folders.
• public string get_current_folder ()
  Gets the current folder of this as `GFile`.
• public File get_current_folder_file ()
  Gets the current folder of this as File.
• public string get_current_folder_uri ()
  Gets the current folder of this as an URI.
• public bool get_do_overwrite_confirmation ()
  Queries whether a file chooser is set to confirm for overwriting when the user types a file name that already exists.
• public unowned Widget get_extra_widget ()
  Gets the current extra widget; see set_extra_widget.
• public File get_file ()
  Gets the `GFile` for the currently selected file in the file selector.
• public string get_filename ()
  Gets the filename for the currently selected file in the file selector.
• public SList<string> get_filenames ()
  Lists all the selected files and subfolders in the current folder of this.
• public SList<File> get_files ()
  Lists all the selected files and subfolders in the current folder of this as `GFile`.
• public unowned FileFilter get_filter ()
  Gets the current filter.
• public bool get_local_only ()
  Gets whether only local files can be selected in the file selector.
• public File get_preview_file ()
  Gets the File that should be previewed in a custom preview Internal function, see get_preview_uri.
• public string get_preview_filename ()
  Gets the filename that should be previewed in a custom preview widget.
• public string get_preview_uri ()
  Gets the URI that should be previewed in a custom preview widget.
• public unowned Widget get_preview_widget ()
  Gets the current preview widget; see set_preview_widget.
• public bool get_preview_widget_active ()
  Gets whether the preview widget set by set_preview_widget should be shown for the current filename.
• public bool get_select_multiple ()
  Gets whether multiple files can be selected in the file chooser.
• public bool get_show_hidden ()
  Gets whether hidden files and folders are displayed in the file selector.
• public string get_uri ()
  Gets the URI for the currently selected file in the file selector.
• public SList<string> get_uris ()
  Lists all the selected files and subfolders in the current folder of this.
• public bool get_use_preview_label ()
  Gets whether a stock label should be drawn with the name of the previewed file.
• public SList<unowned FileFilter> list_filters ()
  Lists the current set of user-selectable filters; see add_filter, remove_filter.
• public SList<string>? list_shortcut_folder_uris ()
  Queries the list of shortcut folders in the file chooser, as set by add_shortcut_folder_uri.
• public SList<string>? list_shortcut_folders ()
  Queries the list of shortcut folders in the file chooser, as set by add_shortcut_folder.
• public void remove_filter (FileFilter filter)
  Removes filter from the list of filters that the user can select between.
• public bool remove_shortcut_folder (string folder) throws Error
  Removes a folder from the shortcut folders in a file chooser.
• public bool remove_shortcut_folder_uri (string uri) throws Error
  Removes a folder URI from a file chooser’s list of shortcut folders.
• public void select_all ()
  Selects all the files in the current folder of a file chooser.
• public bool select_file (File file) throws Error
  Selects the file referred to by file.
• public bool select_filename (string filename)
  Selects a filename.
• public bool select_uri (string uri)
  Selects the file to by uri.
• public void set_action (FileChooserAction action)
  Sets the type of operation that the chooser is performing.
• public void set_create_folders (bool create_folders)
  Sets whether file chooser will offer to create new folders.
• public bool set_current_folder (string filename)
  Sets the current folder for this from a `GFile`.
• public bool set_current_folder_file (File file) throws Error
  Sets the current folder for this from a File.
• public bool set_current_folder_uri (string uri)
  Sets the current folder for this from an URI.
• public void set_current_name (string name)
  Sets the current name in the file selector, as if entered by the user.
• public void set_do_overwrite_confirmation (bool do_overwrite_confirmation)
  Sets whether a file chooser in gtk_file_chooser_action_save mode will present a confirmation dialog if the user types a file name that already exists.
• public void set_extra_widget (Widget extra_widget)
  Sets an application-supplied widget to provide extra options to the user.
• public bool set_file (File file) throws Error
  Sets file as the current filename for the file chooser.
• public bool set_filename (string filename)
  Sets filename as the current filename for the file chooser, by changing to the file’s parent folder and actually selecting the file in list; all other files will be unselected.
• public void set_filter (FileFilter filter)
  Sets the current filter.
• public void set_local_only (bool local_only)
  Sets whether only local files can be selected in the file selector.
• public void set_preview_widget (Widget preview_widget)
  Sets an application-supplied widget to use to display a custom preview of the currently selected file.
• public void set_preview_widget_active (bool active)
  Sets whether the preview widget set by set_preview_widget should be shown for the current filename.
• public void set_select_multiple (bool select_multiple)
  Sets whether multiple files can be selected in the file chooser.
• public void set_show_hidden (bool show_hidden)
  Sets whether hidden files and folders are displayed in the file selector.
• public bool set_uri (string uri)
  Sets the file referred to by uri as the current file for the file chooser, by changing to the URI’s parent folder and actually selecting the URI in the list.
• public void set_use_preview_label (bool use_label)
  Sets whether the file chooser should display a stock label with the name of the file that is being previewed; the default is true.
• public void unselect_all ()
  Unselects all the files in the current folder of a file chooser.
• public void unselect_file (File file)
  Unselects the file referred to by file.
• public void unselect_filename (string filename)
  Unselects a currently selected filename.
• public void unselect_uri (string uri)
  Unselects the file referred to by uri.

Signals:

• public signal FileChooserConfirmation confirm_overwrite ()
  This signal gets emitted whenever it is appropriate to present a confirmation dialog when the user has selected a file name that already exists.
• public signal void current_folder_changed ()
  This signal is emitted when the current folder in a FileChooser changes.
• public signal void file_activated ()
  This signal is emitted when the user "activates" a file in the file chooser.
• public signal void selection_changed ()
  This signal is emitted when there is a change in the set of selected files in a FileChooser.
• public signal void update_preview ()
  This signal is emitted when the preview in a file chooser should be regenerated.

Inherited Members: