Package org.gnome.gtk

Interface FileChooser

All Superinterfaces:

Proxy

All Known Implementing Classes:

FileChooser.FileChooserImpl, FileChooserDialog, FileChooserNative, FileChooserWidget

@Generated("io.github.jwharm.JavaGI")
@Deprecated
public interface FileChooser
extends Proxy

Deprecated.

GtkFileChooser is an interface that can be implemented by file selection widgets.

In GTK, the main objects that implement this interface are FileChooserWidget and 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 addChoice(java.lang.String, java.lang.String, java.lang.String[], java.lang.String[]). 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.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	FileChooser.Builder<B extends Builder<B>>	Deprecated.
static class	FileChooser.FileChooserImpl	Deprecated. The FileChooserImpl type represents a native instance of the FileChooser interface.

Method Summary

Modifier and Type	Method	Description
default void	addChoice(String id, String label, @Nullable String[] options, @Nullable String[] optionLabels)	Deprecated. Use FileDialog instead
default void	addFilter(FileFilter filter)	Deprecated. Use FileDialog instead
default boolean	addShortcutFolder(File folder)	Deprecated. Use FileDialog instead
default FileChooserAction	getAction()	Deprecated. Use FileDialog instead
default String	getChoice(String id)	Deprecated. Use FileDialog instead
default boolean	getCreateFolders()	Deprecated. Use FileDialog instead
default File	getCurrentFolder()	Deprecated. Use FileDialog instead
default String	getCurrentName()	Deprecated. Use FileDialog instead
default File	getFile()	Deprecated. Use FileDialog instead
default ListModel	getFiles()	Deprecated. Use FileDialog instead
default FileFilter	getFilter()	Deprecated. Use FileDialog instead
default ListModel	getFilters()	Deprecated. Use FileDialog instead
default boolean	getSelectMultiple()	Deprecated. Use FileDialog instead
default ListModel	getShortcutFolders()	Deprecated. Use FileDialog instead
static Type	getType()	Deprecated. Get the GType of the FileChooser class
default void	removeChoice(String id)	Deprecated. Use FileDialog instead
default void	removeFilter(FileFilter filter)	Deprecated. Use FileDialog instead
default boolean	removeShortcutFolder(File folder)	Deprecated. Use FileDialog instead
default void	setAction(FileChooserAction action)	Deprecated. Use FileDialog instead
default void	setChoice(String id, String option)	Deprecated. Use FileDialog instead
default void	setCreateFolders(boolean createFolders)	Deprecated. Use FileDialog instead
default boolean	setCurrentFolder(@Nullable File file)	Deprecated. Use FileDialog instead
default void	setCurrentName(String name)	Deprecated. Use FileDialog instead
default boolean	setFile(File file)	Deprecated. Use FileDialog instead
default void	setFilter(FileFilter filter)	Deprecated. Use FileDialog instead
default void	setSelectMultiple(boolean selectMultiple)	Deprecated. Use FileDialog instead

Methods inherited from interface io.github.jwharm.javagi.base.Proxy

handle

Method Details

getType

static Type getType()

Deprecated.

Get the GType of the FileChooser class

Returns:

the GType

addChoice

@Deprecated
default void addChoice(String id,
 String label,
 @Nullable
 @Nullable String[] options,
 @Nullable
 @Nullable String[] optionLabels)

Deprecated.

Use FileDialog instead

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 setChoice(java.lang.String, java.lang.String) before the dialog is shown, and you can obtain the user-selected value in the Gtk.Dialog::response signal handler using getChoice(java.lang.String).

Parameters:

id - id for the added choice

label - user-visible label for the added choice

options - ids for the options of the choice, or null for a boolean choice

optionLabels - user-visible labels for the options, must be the same length as options

addFilter

@Deprecated
default void addFilter(FileFilter filter)

Deprecated.

Use FileDialog instead

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

Parameters:

filter - a GtkFileFilter

addShortcutFolder

@Deprecated
default boolean addShortcutFolder(File folder)
                           throws GErrorException

Deprecated.

Use FileDialog instead

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

Parameters:

folder - a GFile for the folder to add

Returns:

true if the folder could be added successfully, false otherwise.

Throws:

GErrorException - see GError

getAction

@Deprecated
default FileChooserAction getAction()

Deprecated.

Use FileDialog instead

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

Returns:

the action that the file selector is performing

getChoice

@Deprecated
default String getChoice(String id)

Deprecated.

Use FileDialog instead

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

Parameters:

id - the ID of the choice to get

Returns:

the ID of the currently selected option

getCreateFolders

@Deprecated
default boolean getCreateFolders()

Deprecated.

Use FileDialog instead

Gets whether file chooser will offer to create new folders.

Returns:

true if the Create Folder button should be displayed.

getCurrentFolder

@Deprecated
default File getCurrentFolder()

Deprecated.

Use FileDialog instead

Gets the current folder of this FileChooser as GFile.

Returns:

the GFile for the current folder.

getCurrentName

@Deprecated
default String getCurrentName()

Deprecated.

Use FileDialog instead

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.

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.

getFile

@Deprecated
default File getFile()

Deprecated.

Use FileDialog instead

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.

Returns:

a selected GFile. You own the returned file; use g_object_unref() to release it.

getFiles

@Deprecated
default ListModel getFiles()

Deprecated.

Use FileDialog instead

Lists all the selected files and subfolders in the current folder of this FileChooser as GFile.

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().

getFilter

@Deprecated
default FileFilter getFilter()

Deprecated.

Use FileDialog instead

Gets the current filter.

Returns:

the current filter

getFilters

@Deprecated
default ListModel getFilters()

Deprecated.

Use FileDialog instead

Gets the current set of user-selectable filters, as a list model.

See addFilter(org.gnome.gtk.FileFilter) and removeFilter(org.gnome.gtk.FileFilter) for changing individual filters.

You should not modify the returned list model. Future changes to this FileChooser may or may not affect the returned model.

Returns:

a GListModel containing the current set of user-selectable filters.

getSelectMultiple

@Deprecated
default boolean getSelectMultiple()

Deprecated.

Use FileDialog instead

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

Returns:

true if multiple files can be selected.

getShortcutFolders

@Deprecated
default ListModel getShortcutFolders()

Deprecated.

Use FileDialog instead

Queries the list of shortcut folders in the file chooser.

You should not modify the returned list model. Future changes to this FileChooser may or may not affect the returned model.

Returns:

A list model of GFiles

removeChoice

@Deprecated
default void removeChoice(String id)

Deprecated.

Use FileDialog instead

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

Parameters:

id - the ID of the choice to remove

removeFilter

@Deprecated
default void removeFilter(FileFilter filter)

Deprecated.

Use FileDialog instead

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

Parameters:

filter - a GtkFileFilter

removeShortcutFolder

@Deprecated
default boolean removeShortcutFolder(File folder)
                              throws GErrorException

Deprecated.

Use FileDialog instead

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

Parameters:

folder - a GFile for the folder to remove

Returns:

true if the folder could be removed successfully, false otherwise.

Throws:

GErrorException - see GError

setAction

@Deprecated
default void setAction(FileChooserAction action)

Deprecated.

Use FileDialog instead

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 but not if the action is FileChooserAction.OPEN.

Parameters:

action - the action that the file selector is performing

setChoice

@Deprecated
default void setChoice(String id,
 String option)

Deprecated.

Use FileDialog instead

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

Parameters:

id - the ID of the choice to set

option - the ID of the option to select

setCreateFolders

@Deprecated
default void setCreateFolders(boolean createFolders)

Deprecated.

Use FileDialog instead

Sets whether file chooser will offer to create new folders.

This is only relevant if the action is not set to be FileChooserAction.OPEN.

Parameters:

createFolders - true if the Create Folder button should be displayed

setCurrentFolder

@Deprecated
default boolean setCurrentFolder(@Nullable
 @Nullable File file)
                          throws GErrorException

Deprecated.

Use FileDialog instead

Sets the current folder for this FileChooser from a GFile.

Parameters:

file - the GFile for the new folder

Returns:

true if the folder could be changed successfully, false otherwise.

Throws:

GErrorException - see GError

setCurrentName

@Deprecated
default void setCurrentName(String name)

Deprecated.

Use FileDialog instead

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 setFile(org.gnome.gio.File) instead.

Please see the documentation for those functions for an example of using setCurrentName(java.lang.String) as well.

Parameters:

name - the filename to use, as a UTF-8 string

setFile

@Deprecated
default boolean setFile(File file)
                 throws GErrorException

Deprecated.

Use FileDialog instead

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 this FileChooser is in 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 this FileChooser, then the current folder of this FileChooser 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:

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);
     }
 }
 

Parameters:

file - the GFile to set as current

Returns:

Not useful

Throws:

GErrorException - see GError

setFilter

@Deprecated
default void setFilter(FileFilter filter)

Deprecated.

Use FileDialog instead

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.

Parameters:

filter - a GtkFileFilter

setSelectMultiple

@Deprecated
default void setSelectMultiple(boolean selectMultiple)

Deprecated.

Use FileDialog instead

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

This is only relevant if the action is set to be FileChooserAction.OPEN or FileChooserAction.SELECT_FOLDER.

Parameters:

selectMultiple - true if multiple files can be selected.