Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
Safe Haskell | None |
Language | Haskell2010 |
- Exported types
- Methods
- addChoice
- addFilter
- addShortcutFolder
- addShortcutFolderUri
- getAction
- getChoice
- getCreateFolders
- getCurrentFolder
- getCurrentFolderFile
- getCurrentFolderUri
- getCurrentName
- getDoOverwriteConfirmation
- getExtraWidget
- getFile
- getFilename
- getFilenames
- getFiles
- getFilter
- getLocalOnly
- getPreviewFile
- getPreviewFilename
- getPreviewUri
- getPreviewWidget
- getPreviewWidgetActive
- getSelectMultiple
- getShowHidden
- getUri
- getUris
- getUsePreviewLabel
- listFilters
- listShortcutFolderUris
- listShortcutFolders
- removeChoice
- removeFilter
- removeShortcutFolder
- removeShortcutFolderUri
- selectAll
- selectFile
- selectFilename
- selectUri
- setAction
- setChoice
- setCreateFolders
- setCurrentFolder
- setCurrentFolderFile
- setCurrentFolderUri
- setCurrentName
- setDoOverwriteConfirmation
- setExtraWidget
- setFile
- setFilename
- setFilter
- setLocalOnly
- setPreviewWidget
- setPreviewWidgetActive
- setSelectMultiple
- setShowHidden
- setUri
- setUsePreviewLabel
- unselectAll
- unselectFile
- unselectFilename
- unselectUri
- Properties
- Signals
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 names
either as filenames or as URIs. For URIs, the normal escaping
rules are applied if the URI contains non-ASCII characters.
However, filenames are always returned in
the character set specified by the
G_FILENAME_ENCODING
environment variable.
Please see the GLib documentation for more details about this
variable.
This means that while you can pass the result of
fileChooserGetFilename
to open()
or fopen()
,
you may not be able to directly set it as the text of a
Label
widget unless you convert it first to UTF-8,
which all GTK+ widgets expect. You should use filenameToUtf8
to convert filenames into strings that can be passed to GTK+
widgets.
Adding a Preview Widget
You can add a custom preview widget to a file chooser and then
get notification about when the preview needs to be updated.
To install a preview widget, use
fileChooserSetPreviewWidget
. Then, connect to the
FileChooser
::update-preview
signal to get notified when
you need to update the contents of the preview.
Your callback should use
fileChooserGetPreviewFilename
to see what needs
previewing. Once you have generated the preview for the
corresponding file, you must call
fileChooserSetPreviewWidgetActive
with a boolean
flag that indicates whether your callback could successfully
generate a preview.
C code
{ GtkImage *preview; ... preview = gtk_image_new (); gtk_file_chooser_set_preview_widget (my_file_chooser, preview); g_signal_connect (my_file_chooser, "update-preview", G_CALLBACK (update_preview_cb), preview); } static void update_preview_cb (GtkFileChooser *file_chooser, gpointer data) { GtkWidget *preview; char *filename; GdkPixbuf *pixbuf; gboolean have_preview; preview = GTK_WIDGET (data); filename = gtk_file_chooser_get_preview_filename (file_chooser); pixbuf = gdk_pixbuf_new_from_file_at_size (filename, 128, 128, NULL); have_preview = (pixbuf != NULL); g_free (filename); gtk_image_set_from_pixbuf (GTK_IMAGE (preview), pixbuf); if (pixbuf) g_object_unref (pixbuf); gtk_file_chooser_set_preview_widget_active (file_chooser, have_preview); }
Adding Extra Widgets
You can add extra widgets to a file chooser to provide options
that are not present in the default design. For example, you
can add a toggle button to give the user the option to open a
file in read-only mode. You can use
fileChooserSetExtraWidget
to insert additional
widgets in a file chooser.
An example for adding extra widgets:
C code
GtkWidget *toggle; ... toggle = gtk_check_button_new_with_label ("Open file read-only"); gtk_widget_show (toggle); gtk_file_chooser_set_extra_widget (my_file_chooser, toggle); }
If you want to set more than one extra widget in the file
chooser, you can a container such as a Box
or a Grid
and include your widgets in it. Then, set the container as
the whole extra widget.
- newtype FileChooser = FileChooser (ManagedPtr FileChooser)
- noFileChooser :: Maybe FileChooser
- class GObject o => IsFileChooser o
- toFileChooser :: (MonadIO m, IsFileChooser o) => o -> m FileChooser
- fileChooserAddChoice :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> Text -> Text -> Text -> Text -> m ()
- fileChooserAddFilter :: (HasCallStack, MonadIO m, IsFileChooser a, IsFileFilter b) => a -> b -> m ()
- fileChooserAddShortcutFolder :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> [Char] -> m ()
- fileChooserAddShortcutFolderUri :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> Text -> m ()
- fileChooserGetAction :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> m FileChooserAction
- fileChooserGetChoice :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> Text -> m Text
- fileChooserGetCreateFolders :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> m Bool
- fileChooserGetCurrentFolder :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> m (Maybe [Char])
- fileChooserGetCurrentFolderFile :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> m File
- fileChooserGetCurrentFolderUri :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> m (Maybe Text)
- fileChooserGetCurrentName :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> m Text
- fileChooserGetDoOverwriteConfirmation :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> m Bool
- fileChooserGetExtraWidget :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> m (Maybe Widget)
- fileChooserGetFile :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> m File
- fileChooserGetFilename :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> m (Maybe [Char])
- fileChooserGetFilenames :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> m [[Char]]
- fileChooserGetFiles :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> m [File]
- fileChooserGetFilter :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> m (Maybe FileFilter)
- fileChooserGetLocalOnly :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> m Bool
- fileChooserGetPreviewFile :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> m (Maybe File)
- fileChooserGetPreviewFilename :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> m (Maybe [Char])
- fileChooserGetPreviewUri :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> m (Maybe Text)
- fileChooserGetPreviewWidget :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> m (Maybe Widget)
- fileChooserGetPreviewWidgetActive :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> m Bool
- fileChooserGetSelectMultiple :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> m Bool
- fileChooserGetShowHidden :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> m Bool
- fileChooserGetUri :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> m (Maybe Text)
- fileChooserGetUris :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> m [Text]
- fileChooserGetUsePreviewLabel :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> m Bool
- fileChooserListFilters :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> m [FileFilter]
- fileChooserListShortcutFolderUris :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> m [Text]
- fileChooserListShortcutFolders :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> m [[Char]]
- fileChooserRemoveChoice :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> Text -> m ()
- fileChooserRemoveFilter :: (HasCallStack, MonadIO m, IsFileChooser a, IsFileFilter b) => a -> b -> m ()
- fileChooserRemoveShortcutFolder :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> [Char] -> m ()
- fileChooserRemoveShortcutFolderUri :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> Text -> m ()
- fileChooserSelectAll :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> m ()
- fileChooserSelectFile :: (HasCallStack, MonadIO m, IsFileChooser a, IsFile b) => a -> b -> m ()
- fileChooserSelectFilename :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> [Char] -> m Bool
- fileChooserSelectUri :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> Text -> m Bool
- fileChooserSetAction :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> FileChooserAction -> m ()
- fileChooserSetChoice :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> Text -> Text -> m ()
- fileChooserSetCreateFolders :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> Bool -> m ()
- fileChooserSetCurrentFolder :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> [Char] -> m Bool
- fileChooserSetCurrentFolderFile :: (HasCallStack, MonadIO m, IsFileChooser a, IsFile b) => a -> b -> m ()
- fileChooserSetCurrentFolderUri :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> Text -> m Bool
- fileChooserSetCurrentName :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> [Char] -> m ()
- fileChooserSetDoOverwriteConfirmation :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> Bool -> m ()
- fileChooserSetExtraWidget :: (HasCallStack, MonadIO m, IsFileChooser a, IsWidget b) => a -> b -> m ()
- fileChooserSetFile :: (HasCallStack, MonadIO m, IsFileChooser a, IsFile b) => a -> b -> m ()
- fileChooserSetFilename :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> [Char] -> m Bool
- fileChooserSetFilter :: (HasCallStack, MonadIO m, IsFileChooser a, IsFileFilter b) => a -> b -> m ()
- fileChooserSetLocalOnly :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> Bool -> m ()
- fileChooserSetPreviewWidget :: (HasCallStack, MonadIO m, IsFileChooser a, IsWidget b) => a -> b -> m ()
- fileChooserSetPreviewWidgetActive :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> Bool -> m ()
- fileChooserSetSelectMultiple :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> Bool -> m ()
- fileChooserSetShowHidden :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> Bool -> m ()
- fileChooserSetUri :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> Text -> m Bool
- fileChooserSetUsePreviewLabel :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> Bool -> m ()
- fileChooserUnselectAll :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> m ()
- fileChooserUnselectFile :: (HasCallStack, MonadIO m, IsFileChooser a, IsFile b) => a -> b -> m ()
- fileChooserUnselectFilename :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> [Char] -> m ()
- fileChooserUnselectUri :: (HasCallStack, MonadIO m, IsFileChooser a) => a -> Text -> m ()
- constructFileChooserAction :: IsFileChooser o => FileChooserAction -> IO (GValueConstruct o)
- getFileChooserAction :: (MonadIO m, IsFileChooser o) => o -> m FileChooserAction
- setFileChooserAction :: (MonadIO m, IsFileChooser o) => o -> FileChooserAction -> m ()
- constructFileChooserCreateFolders :: IsFileChooser o => Bool -> IO (GValueConstruct o)
- getFileChooserCreateFolders :: (MonadIO m, IsFileChooser o) => o -> m Bool
- setFileChooserCreateFolders :: (MonadIO m, IsFileChooser o) => o -> Bool -> m ()
- constructFileChooserDoOverwriteConfirmation :: IsFileChooser o => Bool -> IO (GValueConstruct o)
- getFileChooserDoOverwriteConfirmation :: (MonadIO m, IsFileChooser o) => o -> m Bool
- setFileChooserDoOverwriteConfirmation :: (MonadIO m, IsFileChooser o) => o -> Bool -> m ()
- constructFileChooserExtraWidget :: (IsFileChooser o, IsWidget a) => a -> IO (GValueConstruct o)
- getFileChooserExtraWidget :: (MonadIO m, IsFileChooser o) => o -> m (Maybe Widget)
- setFileChooserExtraWidget :: (MonadIO m, IsFileChooser o, IsWidget a) => o -> a -> m ()
- constructFileChooserFilter :: (IsFileChooser o, IsFileFilter a) => a -> IO (GValueConstruct o)
- getFileChooserFilter :: (MonadIO m, IsFileChooser o) => o -> m (Maybe FileFilter)
- setFileChooserFilter :: (MonadIO m, IsFileChooser o, IsFileFilter a) => o -> a -> m ()
- constructFileChooserLocalOnly :: IsFileChooser o => Bool -> IO (GValueConstruct o)
- getFileChooserLocalOnly :: (MonadIO m, IsFileChooser o) => o -> m Bool
- setFileChooserLocalOnly :: (MonadIO m, IsFileChooser o) => o -> Bool -> m ()
- constructFileChooserPreviewWidget :: (IsFileChooser o, IsWidget a) => a -> IO (GValueConstruct o)
- getFileChooserPreviewWidget :: (MonadIO m, IsFileChooser o) => o -> m (Maybe Widget)
- setFileChooserPreviewWidget :: (MonadIO m, IsFileChooser o, IsWidget a) => o -> a -> m ()
- constructFileChooserPreviewWidgetActive :: IsFileChooser o => Bool -> IO (GValueConstruct o)
- getFileChooserPreviewWidgetActive :: (MonadIO m, IsFileChooser o) => o -> m Bool
- setFileChooserPreviewWidgetActive :: (MonadIO m, IsFileChooser o) => o -> Bool -> m ()
- constructFileChooserSelectMultiple :: IsFileChooser o => Bool -> IO (GValueConstruct o)
- getFileChooserSelectMultiple :: (MonadIO m, IsFileChooser o) => o -> m Bool
- setFileChooserSelectMultiple :: (MonadIO m, IsFileChooser o) => o -> Bool -> m ()
- constructFileChooserShowHidden :: IsFileChooser o => Bool -> IO (GValueConstruct o)
- getFileChooserShowHidden :: (MonadIO m, IsFileChooser o) => o -> m Bool
- setFileChooserShowHidden :: (MonadIO m, IsFileChooser o) => o -> Bool -> m ()
- constructFileChooserUsePreviewLabel :: IsFileChooser o => Bool -> IO (GValueConstruct o)
- getFileChooserUsePreviewLabel :: (MonadIO m, IsFileChooser o) => o -> m Bool
- setFileChooserUsePreviewLabel :: (MonadIO m, IsFileChooser o) => o -> Bool -> m ()
- type C_FileChooserConfirmOverwriteCallback = Ptr () -> Ptr () -> IO CUInt
- type FileChooserConfirmOverwriteCallback = IO FileChooserConfirmation
- afterFileChooserConfirmOverwrite :: (IsFileChooser a, MonadIO m) => a -> FileChooserConfirmOverwriteCallback -> m SignalHandlerId
- genClosure_FileChooserConfirmOverwrite :: FileChooserConfirmOverwriteCallback -> IO Closure
- mk_FileChooserConfirmOverwriteCallback :: C_FileChooserConfirmOverwriteCallback -> IO (FunPtr C_FileChooserConfirmOverwriteCallback)
- noFileChooserConfirmOverwriteCallback :: Maybe FileChooserConfirmOverwriteCallback
- onFileChooserConfirmOverwrite :: (IsFileChooser a, MonadIO m) => a -> FileChooserConfirmOverwriteCallback -> m SignalHandlerId
- wrap_FileChooserConfirmOverwriteCallback :: FileChooserConfirmOverwriteCallback -> Ptr () -> Ptr () -> IO CUInt
- type C_FileChooserCurrentFolderChangedCallback = Ptr () -> Ptr () -> IO ()
- type FileChooserCurrentFolderChangedCallback = IO ()
- afterFileChooserCurrentFolderChanged :: (IsFileChooser a, MonadIO m) => a -> FileChooserCurrentFolderChangedCallback -> m SignalHandlerId
- genClosure_FileChooserCurrentFolderChanged :: FileChooserCurrentFolderChangedCallback -> IO Closure
- mk_FileChooserCurrentFolderChangedCallback :: C_FileChooserCurrentFolderChangedCallback -> IO (FunPtr C_FileChooserCurrentFolderChangedCallback)
- noFileChooserCurrentFolderChangedCallback :: Maybe FileChooserCurrentFolderChangedCallback
- onFileChooserCurrentFolderChanged :: (IsFileChooser a, MonadIO m) => a -> FileChooserCurrentFolderChangedCallback -> m SignalHandlerId
- wrap_FileChooserCurrentFolderChangedCallback :: FileChooserCurrentFolderChangedCallback -> Ptr () -> Ptr () -> IO ()
- type C_FileChooserFileActivatedCallback = Ptr () -> Ptr () -> IO ()
- type FileChooserFileActivatedCallback = IO ()
- afterFileChooserFileActivated :: (IsFileChooser a, MonadIO m) => a -> FileChooserFileActivatedCallback -> m SignalHandlerId
- genClosure_FileChooserFileActivated :: FileChooserFileActivatedCallback -> IO Closure
- mk_FileChooserFileActivatedCallback :: C_FileChooserFileActivatedCallback -> IO (FunPtr C_FileChooserFileActivatedCallback)
- noFileChooserFileActivatedCallback :: Maybe FileChooserFileActivatedCallback
- onFileChooserFileActivated :: (IsFileChooser a, MonadIO m) => a -> FileChooserFileActivatedCallback -> m SignalHandlerId
- wrap_FileChooserFileActivatedCallback :: FileChooserFileActivatedCallback -> Ptr () -> Ptr () -> IO ()
- type C_FileChooserSelectionChangedCallback = Ptr () -> Ptr () -> IO ()
- type FileChooserSelectionChangedCallback = IO ()
- afterFileChooserSelectionChanged :: (IsFileChooser a, MonadIO m) => a -> FileChooserSelectionChangedCallback -> m SignalHandlerId
- genClosure_FileChooserSelectionChanged :: FileChooserSelectionChangedCallback -> IO Closure
- mk_FileChooserSelectionChangedCallback :: C_FileChooserSelectionChangedCallback -> IO (FunPtr C_FileChooserSelectionChangedCallback)
- noFileChooserSelectionChangedCallback :: Maybe FileChooserSelectionChangedCallback
- onFileChooserSelectionChanged :: (IsFileChooser a, MonadIO m) => a -> FileChooserSelectionChangedCallback -> m SignalHandlerId
- wrap_FileChooserSelectionChangedCallback :: FileChooserSelectionChangedCallback -> Ptr () -> Ptr () -> IO ()
- type C_FileChooserUpdatePreviewCallback = Ptr () -> Ptr () -> IO ()
- type FileChooserUpdatePreviewCallback = IO ()
- afterFileChooserUpdatePreview :: (IsFileChooser a, MonadIO m) => a -> FileChooserUpdatePreviewCallback -> m SignalHandlerId
- genClosure_FileChooserUpdatePreview :: FileChooserUpdatePreviewCallback -> IO Closure
- mk_FileChooserUpdatePreviewCallback :: C_FileChooserUpdatePreviewCallback -> IO (FunPtr C_FileChooserUpdatePreviewCallback)
- noFileChooserUpdatePreviewCallback :: Maybe FileChooserUpdatePreviewCallback
- onFileChooserUpdatePreview :: (IsFileChooser a, MonadIO m) => a -> FileChooserUpdatePreviewCallback -> m SignalHandlerId
- wrap_FileChooserUpdatePreviewCallback :: FileChooserUpdatePreviewCallback -> Ptr () -> Ptr () -> IO ()
Exported types
newtype FileChooser Source #
class GObject o => IsFileChooser o Source #
toFileChooser :: (MonadIO m, IsFileChooser o) => o -> m FileChooser Source #
Methods
addChoice
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> Text |
|
-> Text |
|
-> Text |
|
-> Text |
|
-> 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
.
Compare fileChooserSetExtraWidget
.
Since: 3.22
addFilter
:: (HasCallStack, MonadIO m, IsFileChooser a, IsFileFilter b) | |
=> a |
|
-> b |
|
-> 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, so you have to
ref and sink it if you want to keep a reference.
Since: 2.4
addShortcutFolder
fileChooserAddShortcutFolder Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> [Char] |
|
-> m () | (Can throw |
Adds a folder to be displayed with the shortcut folders in a file chooser. Note that shortcut folders do not get saved, as they are provided by the application. For example, you can use this to add a “/usr/share/mydrawprogram/Clipart” folder to the volume list.
Since: 2.4
addShortcutFolderUri
fileChooserAddShortcutFolderUri Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> Text |
|
-> m () | (Can throw |
Adds a folder URI to be displayed with the shortcut folders in a file chooser. Note that shortcut folders do not get saved, as they are provided by the application. For example, you can use this to add a “file:///usr/share/mydrawprogram/Clipart” folder to the volume list.
Since: 2.4
getAction
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> m FileChooserAction | Returns: the action that the file selector is performing |
Gets the type of operation that the file chooser is performing; see
fileChooserSetAction
.
Since: 2.4
getChoice
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> Text |
|
-> m Text | Returns: the ID of the currenly selected option |
Gets the currently selected option in the 'choice' with the given ID.
Since: 3.22
getCreateFolders
fileChooserGetCreateFolders Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> m Bool | Returns: |
Gets whether file choser will offer to create new folders.
See fileChooserSetCreateFolders
.
Since: 2.18
getCurrentFolder
fileChooserGetCurrentFolder Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> m (Maybe [Char]) | Returns: the full path of the current
folder, or |
Gets the current folder of chooser
as a local filename.
See fileChooserSetCurrentFolder
.
Note that this is the folder that the file chooser is currently displaying
(e.g. "/home/username/Documents"), which is not the same
as the currently-selected folder if the chooser is in
FileChooserActionSelectFolder
mode
(e.g. "/home/username/Documents/selected-folder/". To get the
currently-selected folder in that mode, use fileChooserGetUri
as the
usual way to get the selection.
Since: 2.4
getCurrentFolderFile
fileChooserGetCurrentFolderFile Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> m File | Returns: the |
Gets the current folder of chooser
as File
.
See fileChooserGetCurrentFolderUri
.
Since: 2.14
getCurrentFolderUri
fileChooserGetCurrentFolderUri Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> m (Maybe Text) | Returns: the URI for the current folder.
Free with |
Gets the current folder of chooser
as an URI.
See fileChooserSetCurrentFolderUri
.
Note that this is the folder that the file chooser is currently displaying
(e.g. "file:///home/username/Documents"), which is not the same
as the currently-selected folder if the chooser is in
FileChooserActionSelectFolder
mode
(e.g. "file:///home/username/Documents/selected-folder/". To get the
currently-selected folder in that mode, use fileChooserGetUri
as the
usual way to get the selection.
Since: 2.4
getCurrentName
fileChooserGetCurrentName Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> m Text | Returns: The raw text from the file chooser’s “Name” entry. Free this with
|
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. For example, an application that adds a custom extra widget to the file chooser for “file format” may want to change the extension of the typed filename based on the chosen format, say, from “.jpg” to “.png”.
Since: 3.10
getDoOverwriteConfirmation
fileChooserGetDoOverwriteConfirmation Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> m Bool | Returns: |
Queries whether a file chooser is set to confirm for overwriting when the user types a file name that already exists.
Since: 2.8
getExtraWidget
fileChooserGetExtraWidget Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> m (Maybe Widget) | Returns: the current extra widget, or |
Gets the current extra widget; see
fileChooserSetExtraWidget
.
Since: 2.4
getFile
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> m File | Returns: a selected |
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.
Since: 2.14
getFilename
fileChooserGetFilename Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> m (Maybe [Char]) | Returns: The currently selected filename,
or |
Gets the filename for the currently selected file in the file selector. The filename is returned as an absolute path. If multiple files are selected, one of the filenames will be returned at random.
If the file chooser is in folder mode, this function returns the selected folder.
Since: 2.4
getFilenames
fileChooserGetFilenames Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> m [[Char]] | Returns: a |
Lists all the selected files and subfolders in the current folder of
chooser
. The returned names are full absolute paths. If files in the current
folder cannot be represented as local filenames they will be ignored. (See
fileChooserGetUris
)
Since: 2.4
getFiles
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> m [File] | Returns: a |
Lists all the selected files and subfolders in the current folder of chooser
as File
. An internal function, see fileChooserGetUris
.
Since: 2.14
getFilter
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> m (Maybe FileFilter) | Returns: the current filter, or |
Gets the current filter; see fileChooserSetFilter
.
Since: 2.4
getLocalOnly
fileChooserGetLocalOnly Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> m Bool | Returns: |
Gets whether only local files can be selected in the
file selector. See fileChooserSetLocalOnly
Since: 2.4
getPreviewFile
fileChooserGetPreviewFile Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> m (Maybe File) | Returns: the |
Gets the File
that should be previewed in a custom preview
Internal function, see fileChooserGetPreviewUri
.
Since: 2.14
getPreviewFilename
fileChooserGetPreviewFilename Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> m (Maybe [Char]) | Returns: the filename to preview, or |
Gets the filename that should be previewed in a custom preview
widget. See fileChooserSetPreviewWidget
.
Since: 2.4
getPreviewUri
fileChooserGetPreviewUri Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> m (Maybe Text) | Returns: the URI for the file to preview,
or |
Gets the URI that should be previewed in a custom preview
widget. See fileChooserSetPreviewWidget
.
Since: 2.4
getPreviewWidget
fileChooserGetPreviewWidget Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> m (Maybe Widget) | Returns: the current preview widget, or |
Gets the current preview widget; see
fileChooserSetPreviewWidget
.
Since: 2.4
getPreviewWidgetActive
fileChooserGetPreviewWidgetActive Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> m Bool | Returns: |
Gets whether the preview widget set by fileChooserSetPreviewWidget
should be shown for the current filename. See
fileChooserSetPreviewWidgetActive
.
Since: 2.4
getSelectMultiple
fileChooserGetSelectMultiple Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> m Bool | Returns: |
Gets whether multiple files can be selected in the file
selector. See fileChooserSetSelectMultiple
.
Since: 2.4
getShowHidden
fileChooserGetShowHidden Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> m Bool | Returns: |
Gets whether hidden files and folders are displayed in the file selector.
See fileChooserSetShowHidden
.
Since: 2.6
getUri
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> m (Maybe Text) | Returns: The currently selected URI, or |
Gets the URI for the currently selected file in the file selector. If multiple files are selected, one of the filenames will be returned at random.
If the file chooser is in folder mode, this function returns the selected folder.
Since: 2.4
getUris
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> m [Text] | Returns: a |
Lists all the selected files and subfolders in the current folder of
chooser
. The returned names are full absolute URIs.
Since: 2.4
getUsePreviewLabel
fileChooserGetUsePreviewLabel Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> m Bool | Returns: |
Gets whether a stock label should be drawn with the name of the previewed
file. See fileChooserSetUsePreviewLabel
.
listFilters
fileChooserListFilters Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> m [FileFilter] | Returns: a
|
Lists the current set of user-selectable filters; see
fileChooserAddFilter
, fileChooserRemoveFilter
.
Since: 2.4
listShortcutFolderUris
fileChooserListShortcutFolderUris Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> m [Text] | Returns: A list of
folder URIs, or |
Queries the list of shortcut folders in the file chooser, as set by
fileChooserAddShortcutFolderUri
.
Since: 2.4
listShortcutFolders
fileChooserListShortcutFolders Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> m [[Char]] | Returns: A list
of folder filenames, or |
Queries the list of shortcut folders in the file chooser, as set by
fileChooserAddShortcutFolder
.
Since: 2.4
removeChoice
fileChooserRemoveChoice Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> Text |
|
-> m () |
Removes a 'choice' that has been added with fileChooserAddChoice
.
Since: 3.22
removeFilter
fileChooserRemoveFilter Source #
:: (HasCallStack, MonadIO m, IsFileChooser a, IsFileFilter b) | |
=> a |
|
-> b |
|
-> m () |
Removes filter
from the list of filters that the user can select between.
Since: 2.4
removeShortcutFolder
fileChooserRemoveShortcutFolder Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> [Char] |
|
-> m () | (Can throw |
Removes a folder from a file chooser’s list of shortcut folders.
Since: 2.4
removeShortcutFolderUri
fileChooserRemoveShortcutFolderUri Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> Text |
|
-> m () | (Can throw |
Removes a folder URI from a file chooser’s list of shortcut folders.
Since: 2.4
selectAll
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> m () |
Selects all the files in the current folder of a file chooser.
Since: 2.4
selectFile
fileChooserSelectFile Source #
:: (HasCallStack, MonadIO m, IsFileChooser a, IsFile b) | |
=> a |
|
-> b |
|
-> m () | (Can throw |
Selects the file referred to by file
. An internal function. See
_gtk_file_chooser_select_uri()
.
Since: 2.14
selectFilename
fileChooserSelectFilename Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> [Char] |
|
-> m Bool | Returns: Not useful. See also: |
Selects a filename. 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
.
Since: 2.4
selectUri
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> Text |
|
-> m Bool | Returns: Not useful. |
Selects the file to by uri
. If the URI doesn’t refer to a
file in the current folder of chooser
, then the current folder of
chooser
will be changed to the folder containing filename
.
Since: 2.4
setAction
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> FileChooserAction |
|
-> 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
.
Since: 2.4
setChoice
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> Text |
|
-> Text |
|
-> m () |
Selects an option in a 'choice' that has been added with
fileChooserAddChoice
. For a boolean choice, the
possible options are "true" and "false".
Since: 3.22
setCreateFolders
fileChooserSetCreateFolders Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether file choser will offer to create new folders.
This is only relevant if the action is not set to be
FileChooserActionOpen
.
Since: 2.18
setCurrentFolder
fileChooserSetCurrentFolder Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> [Char] |
|
-> m Bool | Returns: Not useful. |
Sets the current folder for chooser
from a local filename.
The user will be shown the full contents of the current folder,
plus user interface elements for navigating to other folders.
In general, you should not use this function. See the [section on setting up a file chooser dialog][gtkfilechooserdialog-setting-up] for the rationale behind this.
Since: 2.4
setCurrentFolderFile
fileChooserSetCurrentFolderFile Source #
:: (HasCallStack, MonadIO m, IsFileChooser a, IsFile b) | |
=> a |
|
-> b |
|
-> m () | (Can throw |
Sets the current folder for chooser
from a File
.
Internal function, see fileChooserSetCurrentFolderUri
.
Since: 2.14
setCurrentFolderUri
fileChooserSetCurrentFolderUri Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> Text |
|
-> m Bool | Returns: |
Sets the current folder for chooser
from an URI.
The user will be shown the full contents of the current folder,
plus user interface elements for navigating to other folders.
In general, you should not use this function. See the [section on setting up a file chooser dialog][gtkfilechooserdialog-setting-up] for the rationale behind this.
Since: 2.4
setCurrentName
fileChooserSetCurrentName Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> [Char] |
|
-> 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
fileChooserSetFilename
or fileChooserSetUri
instead.
Please see the documentation for those functions for an example of using
fileChooserSetCurrentName
as well.
Since: 2.4
setDoOverwriteConfirmation
fileChooserSetDoOverwriteConfirmation Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether a file chooser in FileChooserActionSave
mode will present
a confirmation dialog if the user types a file name that already exists. This
is False
by default.
If set to True
, the chooser
will emit the
FileChooser
::confirm-overwrite
signal when appropriate.
If all you need is the stock confirmation dialog, set this property to True
.
You can override the way confirmation is done by actually handling the
FileChooser
::confirm-overwrite
signal; please refer to its documentation
for the details.
Since: 2.8
setExtraWidget
fileChooserSetExtraWidget Source #
:: (HasCallStack, MonadIO m, IsFileChooser a, IsWidget b) | |
=> a |
|
-> b |
|
-> m () |
Sets an application-supplied widget to provide extra options to the user.
Since: 2.4
setFile
:: (HasCallStack, MonadIO m, IsFileChooser a, IsFile b) | |
=> a |
|
-> b |
|
-> m () | (Can throw |
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
fileChooserSelectFilename
.
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_file (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); }
Since: 2.14
setFilename
fileChooserSetFilename Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> [Char] |
|
-> m Bool | Returns: Not useful. |
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. If the chooser
is in
FileChooserActionSave
mode, the file’s base name will also appear in
the dialog’s file name entry.
Note that the file must exist, or nothing will be done except for the directory change.
You should use this function only when implementing a save dialog for which 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... to save a copy or a modified version. 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_name (chooser, "Untitled document"); } else { // the user edited an existing document gtk_file_chooser_set_filename (chooser, existing_filename); }
In the first case, the file chooser will present the user with useful suggestions as to where to save his new file. In the second case, the file’s existing location is already known, so the file chooser will use it.
Since: 2.4
setFilter
:: (HasCallStack, MonadIO m, IsFileChooser a, IsFileFilter b) | |
=> a |
|
-> b |
|
-> 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.
Since: 2.4
setLocalOnly
fileChooserSetLocalOnly Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether only local files can be selected in the
file selector. If localOnly
is True
(the default),
then the selected file or files are guaranteed to be
accessible through the operating systems native file
system and therefore the application only
needs to worry about the filename functions in
FileChooser
, like fileChooserGetFilename
,
rather than the URI functions like
fileChooserGetUri
,
On some systems non-native files may still be available using the native filesystem via a userspace filesystem (FUSE).
Since: 2.4
setPreviewWidget
fileChooserSetPreviewWidget Source #
:: (HasCallStack, MonadIO m, IsFileChooser a, IsWidget b) | |
=> a |
|
-> b |
|
-> m () |
Sets an application-supplied widget to use to display a custom preview
of the currently selected file. To implement a preview, after setting the
preview widget, you connect to the FileChooser
::update-preview
signal, and call fileChooserGetPreviewFilename
or
fileChooserGetPreviewUri
on each change. If you can
display a preview of the new file, update your widget and
set the preview active using fileChooserSetPreviewWidgetActive
.
Otherwise, set the preview inactive.
When there is no application-supplied preview widget, or the application-supplied preview widget is not active, the file chooser will display no preview at all.
Since: 2.4
setPreviewWidgetActive
fileChooserSetPreviewWidgetActive Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether the preview widget set by
fileChooserSetPreviewWidget
should be shown for the
current filename. When active
is set to false, the file chooser
may display an internally generated preview of the current file
or it may display no preview at all. See
fileChooserSetPreviewWidget
for more details.
Since: 2.4
setSelectMultiple
fileChooserSetSelectMultiple Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> Bool |
|
-> 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
.
Since: 2.4
setShowHidden
fileChooserSetShowHidden Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether hidden files and folders are displayed in the file selector.
Since: 2.6
setUri
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> Text |
|
-> m Bool | Returns: Not useful. |
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. If the chooser
is FileChooserActionSave
mode, the URI’s base
name will also appear in the dialog’s file name entry.
Note that the URI must exist, or nothing will be done except for the directory change.
You should use this function only when implementing a save dialog for which 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... to save a copy or a modified version. 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_name (chooser, "Untitled document"); } else { // the user edited an existing document gtk_file_chooser_set_uri (chooser, existing_uri); }
In the first case, the file chooser will present the user with useful suggestions as to where to save his new file. In the second case, the file’s existing location is already known, so the file chooser will use it.
Since: 2.4
setUsePreviewLabel
fileChooserSetUsePreviewLabel Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether the file chooser should display a stock label with the name of
the file that is being previewed; the default is True
. Applications that
want to draw the whole preview area themselves should set this to False
and
display the name themselves in their preview widget.
See also: fileChooserSetPreviewWidget
Since: 2.4
unselectAll
fileChooserUnselectAll Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> m () |
Unselects all the files in the current folder of a file chooser.
Since: 2.4
unselectFile
fileChooserUnselectFile Source #
:: (HasCallStack, MonadIO m, IsFileChooser a, IsFile b) | |
=> a |
|
-> b |
|
-> 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.
Since: 2.14
unselectFilename
fileChooserUnselectFilename Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> [Char] |
|
-> m () |
Unselects a currently selected filename. If the filename is not in the current directory, does not exist, or is otherwise not currently selected, does nothing.
Since: 2.4
unselectUri
fileChooserUnselectUri Source #
:: (HasCallStack, MonadIO m, IsFileChooser a) | |
=> a |
|
-> Text |
|
-> m () |
Unselects the file referred to by uri
. If the file
is not in the current directory, does not exist, or
is otherwise not currently selected, does nothing.
Since: 2.4
Properties
action
constructFileChooserAction :: IsFileChooser o => FileChooserAction -> IO (GValueConstruct o) Source #
getFileChooserAction :: (MonadIO m, IsFileChooser o) => o -> m FileChooserAction Source #
setFileChooserAction :: (MonadIO m, IsFileChooser o) => o -> FileChooserAction -> m () Source #
createFolders
constructFileChooserCreateFolders :: IsFileChooser o => Bool -> IO (GValueConstruct o) Source #
getFileChooserCreateFolders :: (MonadIO m, IsFileChooser o) => o -> m Bool Source #
setFileChooserCreateFolders :: (MonadIO m, IsFileChooser o) => o -> Bool -> m () Source #
doOverwriteConfirmation
constructFileChooserDoOverwriteConfirmation :: IsFileChooser o => Bool -> IO (GValueConstruct o) Source #
getFileChooserDoOverwriteConfirmation :: (MonadIO m, IsFileChooser o) => o -> m Bool Source #
setFileChooserDoOverwriteConfirmation :: (MonadIO m, IsFileChooser o) => o -> Bool -> m () Source #
extraWidget
constructFileChooserExtraWidget :: (IsFileChooser o, IsWidget a) => a -> IO (GValueConstruct o) Source #
getFileChooserExtraWidget :: (MonadIO m, IsFileChooser o) => o -> m (Maybe Widget) Source #
setFileChooserExtraWidget :: (MonadIO m, IsFileChooser o, IsWidget a) => o -> a -> m () Source #
filter
constructFileChooserFilter :: (IsFileChooser o, IsFileFilter a) => a -> IO (GValueConstruct o) Source #
getFileChooserFilter :: (MonadIO m, IsFileChooser o) => o -> m (Maybe FileFilter) Source #
setFileChooserFilter :: (MonadIO m, IsFileChooser o, IsFileFilter a) => o -> a -> m () Source #
localOnly
constructFileChooserLocalOnly :: IsFileChooser o => Bool -> IO (GValueConstruct o) Source #
getFileChooserLocalOnly :: (MonadIO m, IsFileChooser o) => o -> m Bool Source #
setFileChooserLocalOnly :: (MonadIO m, IsFileChooser o) => o -> Bool -> m () Source #
previewWidget
constructFileChooserPreviewWidget :: (IsFileChooser o, IsWidget a) => a -> IO (GValueConstruct o) Source #
getFileChooserPreviewWidget :: (MonadIO m, IsFileChooser o) => o -> m (Maybe Widget) Source #
setFileChooserPreviewWidget :: (MonadIO m, IsFileChooser o, IsWidget a) => o -> a -> m () Source #
previewWidgetActive
constructFileChooserPreviewWidgetActive :: IsFileChooser o => Bool -> IO (GValueConstruct o) Source #
getFileChooserPreviewWidgetActive :: (MonadIO m, IsFileChooser o) => o -> m Bool Source #
setFileChooserPreviewWidgetActive :: (MonadIO m, IsFileChooser o) => o -> Bool -> m () Source #
selectMultiple
constructFileChooserSelectMultiple :: IsFileChooser o => Bool -> IO (GValueConstruct o) Source #
getFileChooserSelectMultiple :: (MonadIO m, IsFileChooser o) => o -> m Bool Source #
setFileChooserSelectMultiple :: (MonadIO m, IsFileChooser o) => o -> Bool -> m () Source #
showHidden
constructFileChooserShowHidden :: IsFileChooser o => Bool -> IO (GValueConstruct o) Source #
getFileChooserShowHidden :: (MonadIO m, IsFileChooser o) => o -> m Bool Source #
setFileChooserShowHidden :: (MonadIO m, IsFileChooser o) => o -> Bool -> m () Source #
usePreviewLabel
constructFileChooserUsePreviewLabel :: IsFileChooser o => Bool -> IO (GValueConstruct o) Source #
getFileChooserUsePreviewLabel :: (MonadIO m, IsFileChooser o) => o -> m Bool Source #
setFileChooserUsePreviewLabel :: (MonadIO m, IsFileChooser o) => o -> Bool -> m () Source #
Signals
confirmOverwrite
afterFileChooserConfirmOverwrite :: (IsFileChooser a, MonadIO m) => a -> FileChooserConfirmOverwriteCallback -> m SignalHandlerId Source #
genClosure_FileChooserConfirmOverwrite :: FileChooserConfirmOverwriteCallback -> IO Closure Source #
mk_FileChooserConfirmOverwriteCallback :: C_FileChooserConfirmOverwriteCallback -> IO (FunPtr C_FileChooserConfirmOverwriteCallback) Source #
onFileChooserConfirmOverwrite :: (IsFileChooser a, MonadIO m) => a -> FileChooserConfirmOverwriteCallback -> m SignalHandlerId Source #
wrap_FileChooserConfirmOverwriteCallback :: FileChooserConfirmOverwriteCallback -> Ptr () -> Ptr () -> IO CUInt Source #
currentFolderChanged
type FileChooserCurrentFolderChangedCallback = IO () Source #
afterFileChooserCurrentFolderChanged :: (IsFileChooser a, MonadIO m) => a -> FileChooserCurrentFolderChangedCallback -> m SignalHandlerId Source #
genClosure_FileChooserCurrentFolderChanged :: FileChooserCurrentFolderChangedCallback -> IO Closure Source #
mk_FileChooserCurrentFolderChangedCallback :: C_FileChooserCurrentFolderChangedCallback -> IO (FunPtr C_FileChooserCurrentFolderChangedCallback) Source #
onFileChooserCurrentFolderChanged :: (IsFileChooser a, MonadIO m) => a -> FileChooserCurrentFolderChangedCallback -> m SignalHandlerId Source #
wrap_FileChooserCurrentFolderChangedCallback :: FileChooserCurrentFolderChangedCallback -> Ptr () -> Ptr () -> IO () Source #
fileActivated
type FileChooserFileActivatedCallback = IO () Source #
afterFileChooserFileActivated :: (IsFileChooser a, MonadIO m) => a -> FileChooserFileActivatedCallback -> m SignalHandlerId Source #
mk_FileChooserFileActivatedCallback :: C_FileChooserFileActivatedCallback -> IO (FunPtr C_FileChooserFileActivatedCallback) Source #
onFileChooserFileActivated :: (IsFileChooser a, MonadIO m) => a -> FileChooserFileActivatedCallback -> m SignalHandlerId Source #
wrap_FileChooserFileActivatedCallback :: FileChooserFileActivatedCallback -> Ptr () -> Ptr () -> IO () Source #
selectionChanged
type FileChooserSelectionChangedCallback = IO () Source #
afterFileChooserSelectionChanged :: (IsFileChooser a, MonadIO m) => a -> FileChooserSelectionChangedCallback -> m SignalHandlerId Source #
genClosure_FileChooserSelectionChanged :: FileChooserSelectionChangedCallback -> IO Closure Source #
mk_FileChooserSelectionChangedCallback :: C_FileChooserSelectionChangedCallback -> IO (FunPtr C_FileChooserSelectionChangedCallback) Source #
onFileChooserSelectionChanged :: (IsFileChooser a, MonadIO m) => a -> FileChooserSelectionChangedCallback -> m SignalHandlerId Source #
wrap_FileChooserSelectionChangedCallback :: FileChooserSelectionChangedCallback -> Ptr () -> Ptr () -> IO () Source #
updatePreview
type FileChooserUpdatePreviewCallback = IO () Source #
afterFileChooserUpdatePreview :: (IsFileChooser a, MonadIO m) => a -> FileChooserUpdatePreviewCallback -> m SignalHandlerId Source #
mk_FileChooserUpdatePreviewCallback :: C_FileChooserUpdatePreviewCallback -> IO (FunPtr C_FileChooserUpdatePreviewCallback) Source #
onFileChooserUpdatePreview :: (IsFileChooser a, MonadIO m) => a -> FileChooserUpdatePreviewCallback -> m SignalHandlerId Source #
wrap_FileChooserUpdatePreviewCallback :: FileChooserUpdatePreviewCallback -> Ptr () -> Ptr () -> IO () Source #