class: FileChooserMeta

[597:14] static extends: object

Generated metadata helpers for FileChooser interface surfaces.

Methods

• properties ()

  Returns property metadata for FileChooser.

  • @r A list.

class: FileChooser

[35:7] extends: object

GtkFileChooser is an interface that can be implemented by file selection widgets. In GTK, the main objects that implement this interface are [class@Gtk.FileChooserWidget] and [class@Gtk.FileChooserDialog]. You do not need to write an object that implements the GtkFileChooser interface unless you are trying to adapt an existing file selector to expose a standard programming interface. GtkFileChooser 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 GtkFileChooser, your program can get the selected filenames as GFiles. # Adding options You can add extra widgets to a file chooser to provide options that are not present in the default design, by using [method@Gtk.FileChooser.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.

Members

• handleObj
• lib
• retainedCallbacks
• signalHandlerNames
• signalSetterHandlers

Methods

• FileChooser (Handle = null)

  Creates a new FileChooser by wrapping a native handle or another wrapper.

  • @p Handle is the native handle or another wrapper whose handle to adopt.

• toNativeHandle (Source)

  Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

  • @p Source is the raw handle, raw buffer, wrapper, or null.
  • @r A raw pointer carrier or null when no pointer is present.

• getLib ()

  Returns the opened native library for this generated wrapper.

  • @r The opened native library.

• handle ()

  Returns the wrapped NativeHandle.

  • @r The wrapped NativeHandle.

• isNull ()

  Returns true when the wrapped handle is null.

  • @r A bool.

• describe ()

  Returns a small string for debugging generated wrappers.

  • @r A string.

• getProperty (string Name)

  Reads one generated property by name.

• setProperty (string Name, Value)

  Writes one generated property by name.

• setAction (string Value)

  The type of operation that the file chooser is performing.

  • @p Value is the new property value.
  • @r None.

• setCreatefolders (bool Value)

  Whether a file chooser not in %GTK_FILE_CHOOSER_ACTION_OPEN mode will offer the user to create new folders.

  • @p Value is the new property value.
  • @r None.

• setFilter (object Value)

  The current filter for selecting files that are displayed.

  • @p Value is the new property value.
  • @r None.

• setSelectmultiple (bool Value)

  Whether to allow multiple files to be selected.

  • @p Value is the new property value.
  • @r None.

• add_choice (string id, string label, list options, list option_labels)

  Adds a 'choice' to the file chooser. This is typically implemented as a combobox or, for boolean choices, as a checkbutton. You can select a value using [method@Gtk.FileChooser.set_choice] before the dialog is shown, and you can obtain the user-selected value in the [signal@Gtk.Dialog::response] signal handler using [method@Gtk.FileChooser.get_choice].

  • @p id is id for the added choice.
  • @p label is user-visible label for the added choice.
  • @p options is ids for the options of the choice, or %NULL for a boolean choice.
  • @p option_labels is user-visible labels for the options, must be the same length as @options.
  • @r None.

• add_filter (object filter)

  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 @chooser takes ownership of the filter if it is floating, so you have to ref and sink it if you want to keep a reference.

  • @p filter is a GtkFileFilter.
  • @r None.

• add_shortcut_folder (object folder)

  Adds a folder to be displayed with the shortcut folders in a file chooser.

  • @p folder is a GFile for the folder to add.

• get_action ()

  Gets the type of operation that the file chooser is performing.

• get_choice (string id)

  Gets the currently selected option in the 'choice' with the given ID.

  • @p id is the ID of the choice to get.

• get_create_folders ()

  Gets whether file chooser will offer to create new folders.

• get_current_folder ()

  Gets the current folder of @chooser as GFile.

• get_current_name ()

  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.

• get_file ()

  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.

• get_files ()

  Lists all the selected files and subfolders in the current folder of

  • @chooser as GFile.

• get_filter ()

  Gets the current filter.

• get_filters ()

  Gets the current set of user-selectable filters, as a list model. See [method@Gtk.FileChooser.add_filter] and [method@Gtk.FileChooser.remove_filter] for changing individual filters. You should not modify the returned list model. Future changes to @chooser may or may not affect the returned model.

• get_select_multiple ()

  Gets whether multiple files can be selected in the file chooser.

• get_shortcut_folders ()

  Queries the list of shortcut folders in the file chooser. You should not modify the returned list model. Future changes to @chooser may or may not affect the returned model.

• remove_choice (string id)

  Removes a 'choice' that has been added with gtk_file_chooser_add_choice().

  • @p id is the ID of the choice to remove.
  • @r None.

• remove_filter (object filter)

  Removes @filter from the list of filters that the user can select between.

  • @p filter is a GtkFileFilter.
  • @r None.

• remove_shortcut_folder (object folder)

  Removes a folder from the shortcut folders in a file chooser.

  • @p folder is a GFile for the folder to remove.

• set_action (string action)

  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 %GTK_FILE_CHOOSER_ACTION_SAVE but not if the action is %GTK_FILE_CHOOSER_ACTION_OPEN.

  • @p action is the action that the file selector is performing.
  • @r None.

• set_choice (string id, string option)

  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".

  • @p id is the ID of the choice to set.
  • @p option is the ID of the option to select.
  • @r None.

• set_create_folders (bool create_folders)

  Sets whether file chooser will offer to create new folders. This is only relevant if the action is not set to be %GTK_FILE_CHOOSER_ACTION_OPEN.

  • @p create_folders is %TRUE if the Create Folder button should be displayed.
  • @r None.

• set_current_folder (object file)

  Sets the current folder for @chooser from a GFile.

  • @p file is the GFile for the new folder.

• set_current_name (string name)

  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 [method@Gtk.FileChooser.set_file] instead. Please see the documentation for those functions for an example of using [method@Gtk.FileChooser.set_current_name] as well.

  • @p name is the filename to use, as a UTF-8 string.
  • @r None.

• set_file (object file)

  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 @chooser is in %GTK_FILE_CHOOSER_ACTION_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 @chooser, then the current folder of @chooser 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: 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); } }

  • @p file is the GFile to set as current.

• set_filter (object filter)

  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.

  • @p filter is a GtkFileFilter.
  • @r None.

• set_select_multiple (bool select_multiple)

  Sets whether multiple files can be selected in the file chooser. This is only relevant if the action is set to be %GTK_FILE_CHOOSER_ACTION_OPEN or %GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER.

  • @p select_multiple is %TRUE if multiple files can be selected..
  • @r None.

• files ()

  Returns get_files as an Aussom list of wrapper objects. This companion method materializes the full collection up front; use get_files() when lazy or change-notify access is required.

  • @r An Aussom list of elements.

• filters ()

  Returns get_filters as an Aussom list of wrapper objects. This companion method materializes the full collection up front; use get_filters() when lazy or change-notify access is required.

  • @r An Aussom list of elements.

• shortcut_folders ()

  Returns get_shortcut_folders as an Aussom list of wrapper objects. This companion method materializes the full collection up front; use get_shortcut_folders() when lazy or change-notify access is required.

  • @r An Aussom list of elements.