GI.Gtk.Interfaces.FileChooser

FileChooser is an interface that can be implemented by file selection widgets. In GTK+, the main objects that implement this interface are FileChooserWidget, FileChooserDialog, and FileChooserButton. You do not need to write an object that implements the FileChooser interface unless you are trying to adapt an existing file selector to expose a standard programming interface.

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, 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 fileChooserAddChoice. 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.

Exported types

newtype FileChooser

Memory-managed wrapper type.

Constructors

FileChooser (ManagedPtr FileChooser)

Instances

Eq FileChooser

Defined in GI.Gtk.Interfaces.FileChooser

Methods

(==) :: FileChooser -> FileChooser -> Bool

(/=) :: FileChooser -> FileChooser -> Bool

IsGValue FileChooser

Convert FileChooser to and from GValue with toGValue and fromGValue.

Defined in GI.Gtk.Interfaces.FileChooser

Methods

toGValue :: FileChooser -> IO GValue

fromGValue :: GValue -> IO FileChooser

ManagedPtrNewtype FileChooser

Defined in GI.Gtk.Interfaces.FileChooser

Methods

toManagedPtr :: FileChooser -> ManagedPtr FileChooser

TypedObject FileChooser

Defined in GI.Gtk.Interfaces.FileChooser

Methods

glibType :: IO GType

GObject FileChooser

Defined in GI.Gtk.Interfaces.FileChooser

HasParentTypes FileChooser

Defined in GI.Gtk.Interfaces.FileChooser

type ParentTypes FileChooser

Defined in GI.Gtk.Interfaces.FileChooser

type ParentTypes FileChooser = '[Object]

class (GObject o, IsDescendantOf FileChooser o) => IsFileChooser o

Type class for types which can be safely cast to FileChooser, for instance with toFileChooser.

Instances

(GObject o, IsDescendantOf FileChooser o) => IsFileChooser o

Defined in GI.Gtk.Interfaces.FileChooser

toFileChooser :: (MonadIO m, IsFileChooser o) => o -> m FileChooser

Cast to FileChooser, for types for which this is known to be safe. For general casts, use castTo.

Methods

Overloaded methods

addChoice

fileChooserAddChoice

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> Text

id: id for the added choice

-> Text

label: user-visible label for the added choice

-> Maybe [Text]

options: ids for the options of the choice, or Nothing for a boolean choice

-> Maybe [Text]

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

-> m ()

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 fileChooserSetChoice before the dialog is shown, and you can obtain the user-selected value in the response signal handler using fileChooserGetChoice.

addFilter

fileChooserAddFilter

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a, IsFileFilter b)

=> a

chooser: a FileChooser

-> b

filter: a FileFilter

-> m ()

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.

addShortcutFolder

fileChooserAddShortcutFolder

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a, IsFile b)

=> a

chooser: a FileChooser

-> b

folder: a File for the folder to add

-> m ()

(Can throw GError)

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

getAction

fileChooserGetAction

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m FileChooserAction

Returns: the action that the file selector is performing

Gets the type of operation that the file chooser is performing; see fileChooserSetAction.

getChoice

fileChooserGetChoice

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> Text

id: the ID of the choice to get

-> m Text

Returns: the ID of the currenly selected option

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

getCreateFolders

fileChooserGetCreateFolders

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m Bool

Returns: True if the Create Folder button should be displayed.

Gets whether file choser will offer to create new folders. See fileChooserSetCreateFolders.

getCurrentFolder

fileChooserGetCurrentFolder

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m File

Returns: the File for the current folder.

Gets the current folder of chooser as File.

getCurrentName

fileChooserGetCurrentName

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m Text

Returns: The raw text from the file chooser’s “Name” entry. Free this with 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.

Gets the current name in the file selector, as entered by the user in the text entry for “Name”.

This is meant to be used in save dialogs, to get the currently typed filename when the file itself does not exist yet.

getFile

fileChooserGetFile

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m File

Returns: a selected File. You own the returned file; use objectUnref to release it.

Gets the File 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.

getFiles

fileChooserGetFiles

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m [File]

Returns: a list containing a File for each selected file and subfolder in the current folder. Free the returned list with g_slist_free(), and the files with objectUnref.

Lists all the selected files and subfolders in the current folder of chooser as File.

getFilter

fileChooserGetFilter

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m (Maybe FileFilter)

Returns: the current filter, or Nothing

Gets the current filter; see fileChooserSetFilter.

getSelectMultiple

fileChooserGetSelectMultiple

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m Bool

Returns: True if multiple files can be selected.

Gets whether multiple files can be selected in the file selector. See fileChooserSetSelectMultiple.

listFilters

fileChooserListFilters

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m [FileFilter]

Returns: a SList containing the current set of user selectable filters. The contents of the list are owned by GTK+, but you must free the list itself with g_slist_free() when you are done with it.

Lists the current set of user-selectable filters; see fileChooserAddFilter, fileChooserRemoveFilter.

listShortcutFolders

fileChooserListShortcutFolders

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m [File]

Returns: A list of folder filenames, or Nothing if there are no shortcut folders.

Queries the list of shortcut folders in the file chooser, as set by fileChooserAddShortcutFolder.

removeChoice

fileChooserRemoveChoice

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> Text

id: the ID of the choice to remove

-> m ()

Removes a 'choice' that has been added with fileChooserAddChoice.

removeFilter

fileChooserRemoveFilter

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a, IsFileFilter b)

=> a

chooser: a FileChooser

-> b

filter: a FileFilter

-> m ()

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

removeShortcutFolder

fileChooserRemoveShortcutFolder

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a, IsFile b)

=> a

chooser: a FileChooser

-> b

folder: a File for the folder to remove

-> m ()

(Can throw GError)

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

selectAll

fileChooserSelectAll

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m ()

Selects all the files in the current folder of a file chooser.

selectFile

fileChooserSelectFile

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a, IsFile b)

=> a

chooser: a FileChooser

-> b

file: the file to select

-> m ()

(Can throw GError)

Selects the file referred to by file.

setAction

fileChooserSetAction

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> FileChooserAction

action: the action that the file selector is performing

-> m ()

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 FileChooserActionSave but not if the action is FileChooserActionOpen.

setChoice

fileChooserSetChoice

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> Text

id: the ID of the choice to set

-> Text

option: the ID of the option to select

-> m ()

Selects an option in a 'choice' that has been added with fileChooserAddChoice. For a boolean choice, the possible options are "true" and "false".

setCreateFolders

fileChooserSetCreateFolders

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> Bool

createFolders: True if the Create Folder button should be displayed

-> m ()

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

setCurrentFolder

fileChooserSetCurrentFolder

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a, IsFile b)

=> a

chooser: a FileChooser

-> b

file: the File for the new folder

-> m ()

(Can throw GError)

Sets the current folder for chooser from a File.

setCurrentName

fileChooserSetCurrentName

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> [Char]

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

-> m ()

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 fileChooserSetFile instead.

Please see the documentation for those functions for an example of using fileChooserSetCurrentName as well.

setFile

fileChooserSetFile

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a, IsFile b)

=> a

chooser: a FileChooser

-> b

file: the File to set as current

-> m ()

(Can throw GError)

Sets file as the current filename for the file chooser, by changing to the file’s parent folder and actually selecting the file in list. If the chooser is in FileChooserActionSave 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 filename. This is equivalent to a sequence of fileChooserUnselectAll followed by gtk_file_chooser_select_filename().

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 code

if (document_is_new)
  {
    // the user just created a new document
    gtk_file_chooser_set_current_folder (chooser, default_file_for_saving);
    gtk_file_chooser_set_current_name (chooser, "Untitled document");
  }
else
  {
    // the user edited an existing document
    gtk_file_chooser_set_file (chooser, existing_file);
  }

setFilter

fileChooserSetFilter

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a, IsFileFilter b)

=> a

chooser: a FileChooser

-> b

filter: a FileFilter

-> m ()

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.

setSelectMultiple

fileChooserSetSelectMultiple

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> Bool

selectMultiple: True if multiple files can be selected.

-> m ()

Sets whether multiple files can be selected in the file selector. This is only relevant if the action is set to be FileChooserActionOpen or FileChooserActionSelectFolder.

unselectAll

fileChooserUnselectAll

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m ()

Unselects all the files in the current folder of a file chooser.

unselectFile

fileChooserUnselectFile

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a, IsFile b)

=> a

chooser: a FileChooser

-> b

file: a File

-> m ()

Unselects the file referred to by file. If the file is not in the current directory, does not exist, or is otherwise not currently selected, does nothing.

Properties

action

No description available in the introspection data.

constructFileChooserAction :: (IsFileChooser o, MonadIO m) => FileChooserAction -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “action” property. This is rarely needed directly, but it is used by new.

getFileChooserAction :: (MonadIO m, IsFileChooser o) => o -> m FileChooserAction

Get the value of the “action” property. When overloading is enabled, this is equivalent to

get fileChooser #action

setFileChooserAction :: (MonadIO m, IsFileChooser o) => o -> FileChooserAction -> m ()

Set the value of the “action” property. When overloading is enabled, this is equivalent to

set fileChooser [ #action := value ]

createFolders

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

constructFileChooserCreateFolders :: (IsFileChooser o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “create-folders” property. This is rarely needed directly, but it is used by new.

getFileChooserCreateFolders :: (MonadIO m, IsFileChooser o) => o -> m Bool

Get the value of the “create-folders” property. When overloading is enabled, this is equivalent to

get fileChooser #createFolders

setFileChooserCreateFolders :: (MonadIO m, IsFileChooser o) => o -> Bool -> m ()

Set the value of the “create-folders” property. When overloading is enabled, this is equivalent to

set fileChooser [ #createFolders := value ]

filter

No description available in the introspection data.

constructFileChooserFilter :: (IsFileChooser o, MonadIO m, IsFileFilter a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “filter” property. This is rarely needed directly, but it is used by new.

getFileChooserFilter :: (MonadIO m, IsFileChooser o) => o -> m (Maybe FileFilter)

Get the value of the “filter” property. When overloading is enabled, this is equivalent to

get fileChooser #filter

setFileChooserFilter :: (MonadIO m, IsFileChooser o, IsFileFilter a) => o -> a -> m ()

Set the value of the “filter” property. When overloading is enabled, this is equivalent to

set fileChooser [ #filter := value ]

selectMultiple

No description available in the introspection data.

constructFileChooserSelectMultiple :: (IsFileChooser o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “select-multiple” property. This is rarely needed directly, but it is used by new.

getFileChooserSelectMultiple :: (MonadIO m, IsFileChooser o) => o -> m Bool

Get the value of the “select-multiple” property. When overloading is enabled, this is equivalent to

get fileChooser #selectMultiple

setFileChooserSelectMultiple :: (MonadIO m, IsFileChooser o) => o -> Bool -> m ()

Set the value of the “select-multiple” property. When overloading is enabled, this is equivalent to

set fileChooser [ #selectMultiple := value ]

Signals

currentFolderChanged

type C_FileChooserCurrentFolderChangedCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type FileChooserCurrentFolderChangedCallback = IO ()

This signal is emitted when the current folder in a FileChooser changes. This can happen due to the user performing some action that changes folders, such as selecting a bookmark or visiting a folder on the file list. It can also happen as a result of calling a function to explicitly change the current folder in a file chooser.

Normally you do not need to connect to this signal, unless you need to keep track of which folder a file chooser is showing.

See also: fileChooserSetCurrentFolder, fileChooserGetCurrentFolder,

afterFileChooserCurrentFolderChanged :: (IsFileChooser a, MonadIO m) => a -> FileChooserCurrentFolderChangedCallback -> m SignalHandlerId

Connect a signal handler for the currentFolderChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after fileChooser #currentFolderChanged callback

genClosure_FileChooserCurrentFolderChanged :: MonadIO m => FileChooserCurrentFolderChangedCallback -> m (GClosure C_FileChooserCurrentFolderChangedCallback)

Wrap the callback into a GClosure.

mk_FileChooserCurrentFolderChangedCallback :: C_FileChooserCurrentFolderChangedCallback -> IO (FunPtr C_FileChooserCurrentFolderChangedCallback)

Generate a function pointer callable from C code, from a C_FileChooserCurrentFolderChangedCallback.

noFileChooserCurrentFolderChangedCallback :: Maybe FileChooserCurrentFolderChangedCallback

A convenience synonym for Nothing :: Maybe FileChooserCurrentFolderChangedCallback.

onFileChooserCurrentFolderChanged :: (IsFileChooser a, MonadIO m) => a -> FileChooserCurrentFolderChangedCallback -> m SignalHandlerId

Connect a signal handler for the currentFolderChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on fileChooser #currentFolderChanged callback

wrap_FileChooserCurrentFolderChangedCallback :: FileChooserCurrentFolderChangedCallback -> C_FileChooserCurrentFolderChangedCallback

Wrap a FileChooserCurrentFolderChangedCallback into a C_FileChooserCurrentFolderChangedCallback.

fileActivated

type C_FileChooserFileActivatedCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type FileChooserFileActivatedCallback = IO ()

This signal is emitted when the user "activates" a file in the file chooser. This can happen by double-clicking on a file in the file list, or by pressing Enter.

Normally you do not need to connect to this signal. It is used internally by FileChooserDialog to know when to activate the default button in the dialog.

See also: fileChooserGetFile, fileChooserGetFiles

afterFileChooserFileActivated :: (IsFileChooser a, MonadIO m) => a -> FileChooserFileActivatedCallback -> m SignalHandlerId

Connect a signal handler for the fileActivated signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after fileChooser #fileActivated callback

genClosure_FileChooserFileActivated :: MonadIO m => FileChooserFileActivatedCallback -> m (GClosure C_FileChooserFileActivatedCallback)

Wrap the callback into a GClosure.

mk_FileChooserFileActivatedCallback :: C_FileChooserFileActivatedCallback -> IO (FunPtr C_FileChooserFileActivatedCallback)

Generate a function pointer callable from C code, from a C_FileChooserFileActivatedCallback.

noFileChooserFileActivatedCallback :: Maybe FileChooserFileActivatedCallback

A convenience synonym for Nothing :: Maybe FileChooserFileActivatedCallback.

onFileChooserFileActivated :: (IsFileChooser a, MonadIO m) => a -> FileChooserFileActivatedCallback -> m SignalHandlerId

Connect a signal handler for the fileActivated signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on fileChooser #fileActivated callback

wrap_FileChooserFileActivatedCallback :: FileChooserFileActivatedCallback -> C_FileChooserFileActivatedCallback

Wrap a FileChooserFileActivatedCallback into a C_FileChooserFileActivatedCallback.

selectionChanged

type C_FileChooserSelectionChangedCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type FileChooserSelectionChangedCallback = IO ()

This signal is emitted when there is a change in the set of selected files in a FileChooser. This can happen when the user modifies the selection with the mouse or the keyboard, or when explicitly calling functions to change the selection.

Normally you do not need to connect to this signal, as it is easier to wait for the file chooser to finish running, and then to get the list of selected files using the functions mentioned below.

afterFileChooserSelectionChanged :: (IsFileChooser a, MonadIO m) => a -> FileChooserSelectionChangedCallback -> m SignalHandlerId

Connect a signal handler for the selectionChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after fileChooser #selectionChanged callback

genClosure_FileChooserSelectionChanged :: MonadIO m => FileChooserSelectionChangedCallback -> m (GClosure C_FileChooserSelectionChangedCallback)

Wrap the callback into a GClosure.

mk_FileChooserSelectionChangedCallback :: C_FileChooserSelectionChangedCallback -> IO (FunPtr C_FileChooserSelectionChangedCallback)

Generate a function pointer callable from C code, from a C_FileChooserSelectionChangedCallback.

noFileChooserSelectionChangedCallback :: Maybe FileChooserSelectionChangedCallback

A convenience synonym for Nothing :: Maybe FileChooserSelectionChangedCallback.

onFileChooserSelectionChanged :: (IsFileChooser a, MonadIO m) => a -> FileChooserSelectionChangedCallback -> m SignalHandlerId

Connect a signal handler for the selectionChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on fileChooser #selectionChanged callback

wrap_FileChooserSelectionChangedCallback :: FileChooserSelectionChangedCallback -> C_FileChooserSelectionChangedCallback

Wrap a FileChooserSelectionChangedCallback into a C_FileChooserSelectionChangedCallback.