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

## {gtkfilechooser-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.

Exported types

newtype FileChooser

Constructors

FileChooser (ManagedPtr FileChooser)

Instances

GObject FileChooser

Methods

gobjectType :: FileChooser -> IO GType

IsObject FileChooser

IsFileChooser FileChooser

((~) * info (ResolveFileChooserMethod t FileChooser), MethodInfo * info FileChooser p) => IsLabel t (FileChooser -> p)

Methods

fromLabel :: Proxy# Symbol t -> FileChooser -> p

((~) * info (ResolveFileChooserMethod t FileChooser), MethodInfo * info FileChooser p) => IsLabelProxy t (FileChooser -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> FileChooser -> p

HasAttributeList * FileChooser

type AttributeList FileChooser

type AttributeList FileChooser

type SignalList FileChooser

type SignalList FileChooser

noFileChooser :: Maybe FileChooser

class GObject o => IsFileChooser o

Instances

(GObject a, UnknownAncestorError Constraint FileChooser a) => IsFileChooser a

IsFileChooser FileChooser

IsFileChooser FileChooserDialog

IsFileChooser FileChooserButton

IsFileChooser FileChooserNative

IsFileChooser FileChooserWidget

toFileChooser :: IsFileChooser o => o -> IO FileChooser

Methods

addChoice

data FileChooserAddChoiceMethodInfo

Instances

((~) * signature (Text -> Text -> Text -> Text -> m ()), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserAddChoiceMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserAddChoiceMethodInfo a -> signature -> s

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

-> Text

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

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

Compare fileChooserSetExtraWidget.

Since: 3.22

addFilter

data FileChooserAddFilterMethodInfo

Instances

((~) * signature (b -> m ()), MonadIO m, IsFileChooser a, IsFileFilter b) => MethodInfo * FileChooserAddFilterMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserAddFilterMethodInfo a -> signature -> s

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, so you have to ref and sink it if you want to keep a reference.

Since: 2.4

addShortcutFolder

data FileChooserAddShortcutFolderMethodInfo

Instances

((~) * signature ([Char] -> m ()), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserAddShortcutFolderMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserAddShortcutFolderMethodInfo a -> signature -> s

fileChooserAddShortcutFolder

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> [Char]

folder: filename of the folder to add

-> m ()

(Can throw GError)

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

data FileChooserAddShortcutFolderUriMethodInfo

Instances

((~) * signature (Text -> m ()), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserAddShortcutFolderUriMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserAddShortcutFolderUriMethodInfo a -> signature -> s

fileChooserAddShortcutFolderUri

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> Text

uri: URI of the folder to add

-> m ()

(Can throw GError)

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

data FileChooserGetActionMethodInfo

Instances

((~) * signature (m FileChooserAction), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserGetActionMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserGetActionMethodInfo a -> signature -> s

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.

Since: 2.4

getChoice

data FileChooserGetChoiceMethodInfo

Instances

((~) * signature (Text -> m Text), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserGetChoiceMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserGetChoiceMethodInfo a -> signature -> s

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.

Since: 3.22

getCreateFolders

data FileChooserGetCreateFoldersMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserGetCreateFoldersMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserGetCreateFoldersMethodInfo a -> signature -> s

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.

Since: 2.18

getCurrentFolder

data FileChooserGetCurrentFolderMethodInfo

Instances

((~) * signature (m (Maybe [Char])), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserGetCurrentFolderMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserGetCurrentFolderMethodInfo a -> signature -> s

fileChooserGetCurrentFolder

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m (Maybe [Char])

Returns: the full path of the current folder, or Nothing if the current path cannot be represented as a local filename. Free with free. This function will also return Nothing if the file chooser was unable to load the last folder that was requested from it; for example, as would be for calling fileChooserSetCurrentFolder on a nonexistent folder.

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

data FileChooserGetCurrentFolderFileMethodInfo

Instances

((~) * signature (m File), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserGetCurrentFolderFileMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserGetCurrentFolderFileMethodInfo a -> signature -> s

fileChooserGetCurrentFolderFile

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. See fileChooserGetCurrentFolderUri.

Since: 2.14

getCurrentFolderUri

data FileChooserGetCurrentFolderUriMethodInfo

Instances

((~) * signature (m (Maybe Text)), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserGetCurrentFolderUriMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserGetCurrentFolderUriMethodInfo a -> signature -> s

fileChooserGetCurrentFolderUri

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m (Maybe Text)

Returns: the URI for the current folder. Free with free. This function will also return Nothing if the file chooser was unable to load the last folder that was requested from it; for example, as would be for calling fileChooserSetCurrentFolderUri on a nonexistent folder.

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

data FileChooserGetCurrentNameMethodInfo

Instances

((~) * signature (m Text), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserGetCurrentNameMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserGetCurrentNameMethodInfo a -> signature -> s

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

data FileChooserGetDoOverwriteConfirmationMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserGetDoOverwriteConfirmationMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserGetDoOverwriteConfirmationMethodInfo a -> signature -> s

fileChooserGetDoOverwriteConfirmation

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m Bool

Returns: True if the file chooser will present a confirmation dialog; False otherwise.

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

data FileChooserGetExtraWidgetMethodInfo

Instances

((~) * signature (m (Maybe Widget)), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserGetExtraWidgetMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserGetExtraWidgetMethodInfo a -> signature -> s

fileChooserGetExtraWidget

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m (Maybe Widget)

Returns: the current extra widget, or Nothing

Gets the current preview widget; see fileChooserSetExtraWidget.

Since: 2.4

getFile

data FileChooserGetFileMethodInfo

Instances

((~) * signature (m File), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserGetFileMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserGetFileMethodInfo a -> signature -> s

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.

Since: 2.14

getFilename

data FileChooserGetFilenameMethodInfo

Instances

((~) * signature (m (Maybe [Char])), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserGetFilenameMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserGetFilenameMethodInfo a -> signature -> s

fileChooserGetFilename

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m (Maybe [Char])

Returns: The currently selected filename, or Nothing if no file is selected, or the selected file can't be represented with a local filename. Free with free.

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

data FileChooserGetFilenamesMethodInfo

Instances

((~) * signature (m [[Char]]), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserGetFilenamesMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserGetFilenamesMethodInfo a -> signature -> s

fileChooserGetFilenames

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m [[Char]]

Returns: a SList containing the filenames of all selected files and subfolders in the current folder. Free the returned list with g_slist_free(), and the filenames with free.

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

data FileChooserGetFilesMethodInfo

Instances

((~) * signature (m [File]), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserGetFilesMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserGetFilesMethodInfo a -> signature -> s

fileChooserGetFiles

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m [File]

Returns: a SList 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. An internal function, see fileChooserGetUris.

Since: 2.14

getFilter

data FileChooserGetFilterMethodInfo

Instances

((~) * signature (m (Maybe FileFilter)), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserGetFilterMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserGetFilterMethodInfo a -> signature -> s

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.

Since: 2.4

getLocalOnly

data FileChooserGetLocalOnlyMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserGetLocalOnlyMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserGetLocalOnlyMethodInfo a -> signature -> s

fileChooserGetLocalOnly

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m Bool

Returns: True if only local files can be selected.

Gets whether only local files can be selected in the file selector. See fileChooserSetLocalOnly

Since: 2.4

getPreviewFile

data FileChooserGetPreviewFileMethodInfo

Instances

((~) * signature (m (Maybe File)), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserGetPreviewFileMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserGetPreviewFileMethodInfo a -> signature -> s

fileChooserGetPreviewFile

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m (Maybe File)

Returns: the File for the file to preview, or Nothing if no file is selected. Free with objectUnref.

Gets the File that should be previewed in a custom preview Internal function, see fileChooserGetPreviewUri.

Since: 2.14

getPreviewFilename

data FileChooserGetPreviewFilenameMethodInfo

Instances

((~) * signature (m (Maybe [Char])), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserGetPreviewFilenameMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserGetPreviewFilenameMethodInfo a -> signature -> s

fileChooserGetPreviewFilename

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m (Maybe [Char])

Returns: the filename to preview, or Nothing if no file is selected, or if the selected file cannot be represented as a local filename. Free with free

Gets the filename that should be previewed in a custom preview widget. See fileChooserSetPreviewWidget.

Since: 2.4

getPreviewUri

data FileChooserGetPreviewUriMethodInfo

Instances

((~) * signature (m (Maybe Text)), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserGetPreviewUriMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserGetPreviewUriMethodInfo a -> signature -> s

fileChooserGetPreviewUri

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m (Maybe Text)

Returns: the URI for the file to preview, or Nothing if no file is selected. Free with free.

Gets the URI that should be previewed in a custom preview widget. See fileChooserSetPreviewWidget.

Since: 2.4

getPreviewWidget

data FileChooserGetPreviewWidgetMethodInfo

Instances

((~) * signature (m (Maybe Widget)), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserGetPreviewWidgetMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserGetPreviewWidgetMethodInfo a -> signature -> s

fileChooserGetPreviewWidget

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m (Maybe Widget)

Returns: the current preview widget, or Nothing

Gets the current preview widget; see fileChooserSetPreviewWidget.

Since: 2.4

getPreviewWidgetActive

data FileChooserGetPreviewWidgetActiveMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserGetPreviewWidgetActiveMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserGetPreviewWidgetActiveMethodInfo a -> signature -> s

fileChooserGetPreviewWidgetActive

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m Bool

Returns: True if the preview widget is active for the current filename.

Gets whether the preview widget set by fileChooserSetPreviewWidget should be shown for the current filename. See fileChooserSetPreviewWidgetActive.

Since: 2.4

getSelectMultiple

data FileChooserGetSelectMultipleMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserGetSelectMultipleMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserGetSelectMultipleMethodInfo a -> signature -> s

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.

Since: 2.4

getShowHidden

data FileChooserGetShowHiddenMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserGetShowHiddenMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserGetShowHiddenMethodInfo a -> signature -> s

fileChooserGetShowHidden

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m Bool

Returns: True if hidden files and folders are displayed.

Gets whether hidden files and folders are displayed in the file selector. See fileChooserSetShowHidden.

Since: 2.6

getUri

data FileChooserGetUriMethodInfo

Instances

((~) * signature (m (Maybe Text)), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserGetUriMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserGetUriMethodInfo a -> signature -> s

fileChooserGetUri

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m (Maybe Text)

Returns: The currently selected URI, or Nothing if no file is selected. If fileChooserSetLocalOnly is set to True (the default) a local URI will be returned for any FUSE locations. Free with free

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

data FileChooserGetUrisMethodInfo

Instances

((~) * signature (m [Text]), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserGetUrisMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserGetUrisMethodInfo a -> signature -> s

fileChooserGetUris

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m [Text]

Returns: a SList containing the URIs of all selected files and subfolders in the current folder. Free the returned list with g_slist_free(), and the filenames with free.

Lists all the selected files and subfolders in the current folder of chooser. The returned names are full absolute URIs.

Since: 2.4

getUsePreviewLabel

data FileChooserGetUsePreviewLabelMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserGetUsePreviewLabelMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserGetUsePreviewLabelMethodInfo a -> signature -> s

fileChooserGetUsePreviewLabel

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m Bool

Returns: True if the file chooser is set to display a label with the name of the previewed file, False otherwise.

Gets whether a stock label should be drawn with the name of the previewed file. See fileChooserSetUsePreviewLabel.

listFilters

data FileChooserListFiltersMethodInfo

Instances

((~) * signature (m [FileFilter]), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserListFiltersMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserListFiltersMethodInfo a -> signature -> s

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.

Since: 2.4

listShortcutFolderUris

data FileChooserListShortcutFolderUrisMethodInfo

Instances

((~) * signature (m [Text]), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserListShortcutFolderUrisMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserListShortcutFolderUrisMethodInfo a -> signature -> s

fileChooserListShortcutFolderUris

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m [Text]

Returns: A list of folder URIs, or Nothing if there are no shortcut folders. Free the returned list with g_slist_free(), and the URIs with free.

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

Since: 2.4

listShortcutFolders

data FileChooserListShortcutFoldersMethodInfo

Instances

((~) * signature (m [[Char]]), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserListShortcutFoldersMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserListShortcutFoldersMethodInfo a -> signature -> s

fileChooserListShortcutFolders

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m [[Char]]

Returns: A list of folder filenames, or Nothing if there are no shortcut folders. Free the returned list with g_slist_free(), and the filenames with free.

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

Since: 2.4

removeChoice

data FileChooserRemoveChoiceMethodInfo

Instances

((~) * signature (Text -> m ()), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserRemoveChoiceMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserRemoveChoiceMethodInfo a -> signature -> s

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.

Since: 3.22

removeFilter

data FileChooserRemoveFilterMethodInfo

Instances

((~) * signature (b -> m ()), MonadIO m, IsFileChooser a, IsFileFilter b) => MethodInfo * FileChooserRemoveFilterMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserRemoveFilterMethodInfo a -> signature -> s

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.

Since: 2.4

removeShortcutFolder

data FileChooserRemoveShortcutFolderMethodInfo

Instances

((~) * signature ([Char] -> m ()), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserRemoveShortcutFolderMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserRemoveShortcutFolderMethodInfo a -> signature -> s

fileChooserRemoveShortcutFolder

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> [Char]

folder: filename of the folder to remove

-> m ()

(Can throw GError)

Removes a folder from a file chooser’s list of shortcut folders.

Since: 2.4

removeShortcutFolderUri

data FileChooserRemoveShortcutFolderUriMethodInfo

Instances

((~) * signature (Text -> m ()), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserRemoveShortcutFolderUriMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserRemoveShortcutFolderUriMethodInfo a -> signature -> s

fileChooserRemoveShortcutFolderUri

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> Text

uri: URI of the folder to remove

-> m ()

(Can throw GError)

Removes a folder URI from a file chooser’s list of shortcut folders.

Since: 2.4

selectAll

data FileChooserSelectAllMethodInfo

Instances

((~) * signature (m ()), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserSelectAllMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserSelectAllMethodInfo a -> signature -> s

fileChooserSelectAll

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m ()

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

Since: 2.4

selectFile

data FileChooserSelectFileMethodInfo

Instances

((~) * signature (b -> m ()), MonadIO m, IsFileChooser a, IsFile b) => MethodInfo * FileChooserSelectFileMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserSelectFileMethodInfo a -> signature -> s

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. An internal function. See _gtk_file_chooser_select_uri().

Since: 2.14

selectFilename

data FileChooserSelectFilenameMethodInfo

Instances

((~) * signature ([Char] -> m Bool), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserSelectFilenameMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserSelectFilenameMethodInfo a -> signature -> s

fileChooserSelectFilename

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> [Char]

filename: the filename to select

-> m Bool

Returns: Not useful.

See also: fileChooserSetFilename

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

data FileChooserSelectUriMethodInfo

Instances

((~) * signature (Text -> m Bool), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserSelectUriMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserSelectUriMethodInfo a -> signature -> s

fileChooserSelectUri

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> Text

uri: the URI to select

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

data FileChooserSetActionMethodInfo

Instances

((~) * signature (FileChooserAction -> m ()), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserSetActionMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserSetActionMethodInfo a -> signature -> s

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.

Since: 2.4

setChoice

data FileChooserSetChoiceMethodInfo

Instances

((~) * signature (Text -> Text -> m ()), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserSetChoiceMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserSetChoiceMethodInfo a -> signature -> s

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

Since: 3.22

setCreateFolders

data FileChooserSetCreateFoldersMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserSetCreateFoldersMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserSetCreateFoldersMethodInfo a -> signature -> s

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.

Since: 2.18

setCurrentFolder

data FileChooserSetCurrentFolderMethodInfo

Instances

((~) * signature ([Char] -> m Bool), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserSetCurrentFolderMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserSetCurrentFolderMethodInfo a -> signature -> s

fileChooserSetCurrentFolder

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> [Char]

filename: the full path of the new current folder

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

data FileChooserSetCurrentFolderFileMethodInfo

Instances

((~) * signature (b -> m ()), MonadIO m, IsFileChooser a, IsFile b) => MethodInfo * FileChooserSetCurrentFolderFileMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserSetCurrentFolderFileMethodInfo a -> signature -> s

fileChooserSetCurrentFolderFile

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. Internal function, see fileChooserSetCurrentFolderUri.

Since: 2.14

setCurrentFolderUri

data FileChooserSetCurrentFolderUriMethodInfo

Instances

((~) * signature (Text -> m Bool), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserSetCurrentFolderUriMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserSetCurrentFolderUriMethodInfo a -> signature -> s

fileChooserSetCurrentFolderUri

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> Text

uri: the URI for the new current folder

-> m Bool

Returns: True if the folder could be changed successfully, False otherwise.

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

data FileChooserSetCurrentNameMethodInfo

Instances

((~) * signature ([Char] -> m ()), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserSetCurrentNameMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserSetCurrentNameMethodInfo a -> signature -> s

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 fileChooserSetFilename or fileChooserSetUri instead. Please see the documentation for those functions for an example of using fileChooserSetCurrentName as well.

Since: 2.4

setDoOverwriteConfirmation

data FileChooserSetDoOverwriteConfirmationMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserSetDoOverwriteConfirmationMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserSetDoOverwriteConfirmationMethodInfo a -> signature -> s

fileChooserSetDoOverwriteConfirmation

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> Bool

doOverwriteConfirmation: whether to confirm overwriting in save mode

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

data FileChooserSetExtraWidgetMethodInfo

Instances

((~) * signature (b -> m ()), MonadIO m, IsFileChooser a, IsWidget b) => MethodInfo * FileChooserSetExtraWidgetMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserSetExtraWidgetMethodInfo a -> signature -> s

fileChooserSetExtraWidget

Arguments

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

=> a

chooser: a FileChooser

-> b

extraWidget: widget for extra options

-> m ()

Sets an application-supplied widget to provide extra options to the user.

Since: 2.4

setFile

data FileChooserSetFileMethodInfo

Instances

((~) * signature (b -> m ()), MonadIO m, IsFileChooser a, IsFile b) => MethodInfo * FileChooserSetFileMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserSetFileMethodInfo a -> signature -> s

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

data FileChooserSetFilenameMethodInfo

Instances

((~) * signature ([Char] -> m Bool), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserSetFilenameMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserSetFilenameMethodInfo a -> signature -> s

fileChooserSetFilename

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> [Char]

filename: the filename to set as current

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

data FileChooserSetFilterMethodInfo

Instances

((~) * signature (b -> m ()), MonadIO m, IsFileChooser a, IsFileFilter b) => MethodInfo * FileChooserSetFilterMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserSetFilterMethodInfo a -> signature -> s

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.

Since: 2.4

setLocalOnly

data FileChooserSetLocalOnlyMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserSetLocalOnlyMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserSetLocalOnlyMethodInfo a -> signature -> s

fileChooserSetLocalOnly

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> Bool

localOnly: True if only local files can be selected

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

data FileChooserSetPreviewWidgetMethodInfo

Instances

((~) * signature (b -> m ()), MonadIO m, IsFileChooser a, IsWidget b) => MethodInfo * FileChooserSetPreviewWidgetMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserSetPreviewWidgetMethodInfo a -> signature -> s

fileChooserSetPreviewWidget

Arguments

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

=> a

chooser: a FileChooser

-> b

previewWidget: widget for displaying preview.

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

data FileChooserSetPreviewWidgetActiveMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserSetPreviewWidgetActiveMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserSetPreviewWidgetActiveMethodInfo a -> signature -> s

fileChooserSetPreviewWidgetActive

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> Bool

active: whether to display the user-specified preview widget

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

data FileChooserSetSelectMultipleMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserSetSelectMultipleMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserSetSelectMultipleMethodInfo a -> signature -> s

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.

Since: 2.4

setShowHidden

data FileChooserSetShowHiddenMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserSetShowHiddenMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserSetShowHiddenMethodInfo a -> signature -> s

fileChooserSetShowHidden

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> Bool

showHidden: True if hidden files and folders should be displayed.

-> m ()

Sets whether hidden files and folders are displayed in the file selector.

Since: 2.6

setUri

data FileChooserSetUriMethodInfo

Instances

((~) * signature (Text -> m Bool), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserSetUriMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserSetUriMethodInfo a -> signature -> s

fileChooserSetUri

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> Text

uri: the URI to set as current

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

data FileChooserSetUsePreviewLabelMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserSetUsePreviewLabelMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserSetUsePreviewLabelMethodInfo a -> signature -> s

fileChooserSetUsePreviewLabel

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> Bool

useLabel: whether to display a stock label with the name of the previewed file

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

data FileChooserUnselectAllMethodInfo

Instances

((~) * signature (m ()), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserUnselectAllMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserUnselectAllMethodInfo a -> signature -> s

fileChooserUnselectAll

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> m ()

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

Since: 2.4

unselectFile

data FileChooserUnselectFileMethodInfo

Instances

((~) * signature (b -> m ()), MonadIO m, IsFileChooser a, IsFile b) => MethodInfo * FileChooserUnselectFileMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserUnselectFileMethodInfo a -> signature -> s

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.

Since: 2.14

unselectFilename

data FileChooserUnselectFilenameMethodInfo

Instances

((~) * signature ([Char] -> m ()), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserUnselectFilenameMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserUnselectFilenameMethodInfo a -> signature -> s

fileChooserUnselectFilename

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> [Char]

filename: the filename to unselect

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

data FileChooserUnselectUriMethodInfo

Instances

((~) * signature (Text -> m ()), MonadIO m, IsFileChooser a) => MethodInfo * FileChooserUnselectUriMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserUnselectUriMethodInfo a -> signature -> s

fileChooserUnselectUri

Arguments

:: (HasCallStack, MonadIO m, IsFileChooser a)

=> a

chooser: a FileChooser

-> Text

uri: the URI to unselect

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

data FileChooserActionPropertyInfo

Instances

AttrInfo FileChooserActionPropertyInfo

Associated Types

type AttrAllowedOps FileChooserActionPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint FileChooserActionPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint FileChooserActionPropertyInfo :: * -> Constraint

type AttrGetType FileChooserActionPropertyInfo :: *

type AttrLabel FileChooserActionPropertyInfo :: Symbol

type AttrOrigin FileChooserActionPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint FileChooserActionPropertyInfo o => Proxy * FileChooserActionPropertyInfo -> o -> IO (AttrGetType FileChooserActionPropertyInfo)

attrSet :: (AttrBaseTypeConstraint FileChooserActionPropertyInfo o, AttrSetTypeConstraint FileChooserActionPropertyInfo b) => Proxy * FileChooserActionPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint FileChooserActionPropertyInfo o => Proxy * FileChooserActionPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint FileChooserActionPropertyInfo o, AttrSetTypeConstraint FileChooserActionPropertyInfo b) => Proxy * FileChooserActionPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin FileChooserActionPropertyInfo

type AttrOrigin FileChooserActionPropertyInfo = FileChooser

type AttrLabel FileChooserActionPropertyInfo

type AttrLabel FileChooserActionPropertyInfo = "action"

type AttrGetType FileChooserActionPropertyInfo

type AttrGetType FileChooserActionPropertyInfo = FileChooserAction

type AttrBaseTypeConstraint FileChooserActionPropertyInfo

type AttrBaseTypeConstraint FileChooserActionPropertyInfo = IsFileChooser

type AttrSetTypeConstraint FileChooserActionPropertyInfo

type AttrSetTypeConstraint FileChooserActionPropertyInfo = * ~ FileChooserAction

type AttrAllowedOps FileChooserActionPropertyInfo

type AttrAllowedOps FileChooserActionPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructFileChooserAction :: IsFileChooser o => FileChooserAction -> IO (GValueConstruct o)

fileChooserAction :: AttrLabelProxy "action"

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

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

createFolders

data FileChooserCreateFoldersPropertyInfo

Instances

AttrInfo FileChooserCreateFoldersPropertyInfo

Associated Types

type AttrAllowedOps FileChooserCreateFoldersPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint FileChooserCreateFoldersPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint FileChooserCreateFoldersPropertyInfo :: * -> Constraint

type AttrGetType FileChooserCreateFoldersPropertyInfo :: *

type AttrLabel FileChooserCreateFoldersPropertyInfo :: Symbol

type AttrOrigin FileChooserCreateFoldersPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint FileChooserCreateFoldersPropertyInfo o => Proxy * FileChooserCreateFoldersPropertyInfo -> o -> IO (AttrGetType FileChooserCreateFoldersPropertyInfo)

attrSet :: (AttrBaseTypeConstraint FileChooserCreateFoldersPropertyInfo o, AttrSetTypeConstraint FileChooserCreateFoldersPropertyInfo b) => Proxy * FileChooserCreateFoldersPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint FileChooserCreateFoldersPropertyInfo o => Proxy * FileChooserCreateFoldersPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint FileChooserCreateFoldersPropertyInfo o, AttrSetTypeConstraint FileChooserCreateFoldersPropertyInfo b) => Proxy * FileChooserCreateFoldersPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin FileChooserCreateFoldersPropertyInfo

type AttrOrigin FileChooserCreateFoldersPropertyInfo = FileChooser

type AttrLabel FileChooserCreateFoldersPropertyInfo

type AttrLabel FileChooserCreateFoldersPropertyInfo = "create-folders"

type AttrGetType FileChooserCreateFoldersPropertyInfo

type AttrGetType FileChooserCreateFoldersPropertyInfo = Bool

type AttrBaseTypeConstraint FileChooserCreateFoldersPropertyInfo

type AttrBaseTypeConstraint FileChooserCreateFoldersPropertyInfo = IsFileChooser

type AttrSetTypeConstraint FileChooserCreateFoldersPropertyInfo

type AttrSetTypeConstraint FileChooserCreateFoldersPropertyInfo = * ~ Bool

type AttrAllowedOps FileChooserCreateFoldersPropertyInfo

type AttrAllowedOps FileChooserCreateFoldersPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructFileChooserCreateFolders :: IsFileChooser o => Bool -> IO (GValueConstruct o)

fileChooserCreateFolders :: AttrLabelProxy "createFolders"

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

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

doOverwriteConfirmation

data FileChooserDoOverwriteConfirmationPropertyInfo

Instances

AttrInfo FileChooserDoOverwriteConfirmationPropertyInfo

Associated Types

type AttrAllowedOps FileChooserDoOverwriteConfirmationPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint FileChooserDoOverwriteConfirmationPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint FileChooserDoOverwriteConfirmationPropertyInfo :: * -> Constraint

type AttrGetType FileChooserDoOverwriteConfirmationPropertyInfo :: *

type AttrLabel FileChooserDoOverwriteConfirmationPropertyInfo :: Symbol

type AttrOrigin FileChooserDoOverwriteConfirmationPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint FileChooserDoOverwriteConfirmationPropertyInfo o => Proxy * FileChooserDoOverwriteConfirmationPropertyInfo -> o -> IO (AttrGetType FileChooserDoOverwriteConfirmationPropertyInfo)

attrSet :: (AttrBaseTypeConstraint FileChooserDoOverwriteConfirmationPropertyInfo o, AttrSetTypeConstraint FileChooserDoOverwriteConfirmationPropertyInfo b) => Proxy * FileChooserDoOverwriteConfirmationPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint FileChooserDoOverwriteConfirmationPropertyInfo o => Proxy * FileChooserDoOverwriteConfirmationPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint FileChooserDoOverwriteConfirmationPropertyInfo o, AttrSetTypeConstraint FileChooserDoOverwriteConfirmationPropertyInfo b) => Proxy * FileChooserDoOverwriteConfirmationPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin FileChooserDoOverwriteConfirmationPropertyInfo

type AttrOrigin FileChooserDoOverwriteConfirmationPropertyInfo = FileChooser

type AttrLabel FileChooserDoOverwriteConfirmationPropertyInfo

type AttrLabel FileChooserDoOverwriteConfirmationPropertyInfo = "do-overwrite-confirmation"

type AttrGetType FileChooserDoOverwriteConfirmationPropertyInfo

type AttrGetType FileChooserDoOverwriteConfirmationPropertyInfo = Bool

type AttrBaseTypeConstraint FileChooserDoOverwriteConfirmationPropertyInfo

type AttrBaseTypeConstraint FileChooserDoOverwriteConfirmationPropertyInfo = IsFileChooser

type AttrSetTypeConstraint FileChooserDoOverwriteConfirmationPropertyInfo

type AttrSetTypeConstraint FileChooserDoOverwriteConfirmationPropertyInfo = * ~ Bool

type AttrAllowedOps FileChooserDoOverwriteConfirmationPropertyInfo

type AttrAllowedOps FileChooserDoOverwriteConfirmationPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructFileChooserDoOverwriteConfirmation :: IsFileChooser o => Bool -> IO (GValueConstruct o)

fileChooserDoOverwriteConfirmation :: AttrLabelProxy "doOverwriteConfirmation"

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

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

extraWidget

data FileChooserExtraWidgetPropertyInfo

Instances

AttrInfo FileChooserExtraWidgetPropertyInfo

Associated Types

type AttrAllowedOps FileChooserExtraWidgetPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint FileChooserExtraWidgetPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint FileChooserExtraWidgetPropertyInfo :: * -> Constraint

type AttrGetType FileChooserExtraWidgetPropertyInfo :: *

type AttrLabel FileChooserExtraWidgetPropertyInfo :: Symbol

type AttrOrigin FileChooserExtraWidgetPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint FileChooserExtraWidgetPropertyInfo o => Proxy * FileChooserExtraWidgetPropertyInfo -> o -> IO (AttrGetType FileChooserExtraWidgetPropertyInfo)

attrSet :: (AttrBaseTypeConstraint FileChooserExtraWidgetPropertyInfo o, AttrSetTypeConstraint FileChooserExtraWidgetPropertyInfo b) => Proxy * FileChooserExtraWidgetPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint FileChooserExtraWidgetPropertyInfo o => Proxy * FileChooserExtraWidgetPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint FileChooserExtraWidgetPropertyInfo o, AttrSetTypeConstraint FileChooserExtraWidgetPropertyInfo b) => Proxy * FileChooserExtraWidgetPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin FileChooserExtraWidgetPropertyInfo

type AttrOrigin FileChooserExtraWidgetPropertyInfo = FileChooser

type AttrLabel FileChooserExtraWidgetPropertyInfo

type AttrLabel FileChooserExtraWidgetPropertyInfo = "extra-widget"

type AttrGetType FileChooserExtraWidgetPropertyInfo

type AttrGetType FileChooserExtraWidgetPropertyInfo = Maybe Widget

type AttrBaseTypeConstraint FileChooserExtraWidgetPropertyInfo

type AttrBaseTypeConstraint FileChooserExtraWidgetPropertyInfo = IsFileChooser

type AttrSetTypeConstraint FileChooserExtraWidgetPropertyInfo

type AttrSetTypeConstraint FileChooserExtraWidgetPropertyInfo = IsWidget

type AttrAllowedOps FileChooserExtraWidgetPropertyInfo

type AttrAllowedOps FileChooserExtraWidgetPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructFileChooserExtraWidget :: (IsFileChooser o, IsWidget a) => a -> IO (GValueConstruct o)

fileChooserExtraWidget :: AttrLabelProxy "extraWidget"

getFileChooserExtraWidget :: (MonadIO m, IsFileChooser o) => o -> m (Maybe Widget)

setFileChooserExtraWidget :: (MonadIO m, IsFileChooser o, IsWidget a) => o -> a -> m ()

filter

data FileChooserFilterPropertyInfo

Instances

AttrInfo FileChooserFilterPropertyInfo

Associated Types

type AttrAllowedOps FileChooserFilterPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint FileChooserFilterPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint FileChooserFilterPropertyInfo :: * -> Constraint

type AttrGetType FileChooserFilterPropertyInfo :: *

type AttrLabel FileChooserFilterPropertyInfo :: Symbol

type AttrOrigin FileChooserFilterPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint FileChooserFilterPropertyInfo o => Proxy * FileChooserFilterPropertyInfo -> o -> IO (AttrGetType FileChooserFilterPropertyInfo)

attrSet :: (AttrBaseTypeConstraint FileChooserFilterPropertyInfo o, AttrSetTypeConstraint FileChooserFilterPropertyInfo b) => Proxy * FileChooserFilterPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint FileChooserFilterPropertyInfo o => Proxy * FileChooserFilterPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint FileChooserFilterPropertyInfo o, AttrSetTypeConstraint FileChooserFilterPropertyInfo b) => Proxy * FileChooserFilterPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin FileChooserFilterPropertyInfo

type AttrOrigin FileChooserFilterPropertyInfo = FileChooser

type AttrLabel FileChooserFilterPropertyInfo

type AttrLabel FileChooserFilterPropertyInfo = "filter"

type AttrGetType FileChooserFilterPropertyInfo

type AttrGetType FileChooserFilterPropertyInfo = Maybe FileFilter

type AttrBaseTypeConstraint FileChooserFilterPropertyInfo

type AttrBaseTypeConstraint FileChooserFilterPropertyInfo = IsFileChooser

type AttrSetTypeConstraint FileChooserFilterPropertyInfo

type AttrSetTypeConstraint FileChooserFilterPropertyInfo = IsFileFilter

type AttrAllowedOps FileChooserFilterPropertyInfo

type AttrAllowedOps FileChooserFilterPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

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

fileChooserFilter :: AttrLabelProxy "filter"

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

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

localOnly

data FileChooserLocalOnlyPropertyInfo

Instances

AttrInfo FileChooserLocalOnlyPropertyInfo

Associated Types

type AttrAllowedOps FileChooserLocalOnlyPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint FileChooserLocalOnlyPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint FileChooserLocalOnlyPropertyInfo :: * -> Constraint

type AttrGetType FileChooserLocalOnlyPropertyInfo :: *

type AttrLabel FileChooserLocalOnlyPropertyInfo :: Symbol

type AttrOrigin FileChooserLocalOnlyPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint FileChooserLocalOnlyPropertyInfo o => Proxy * FileChooserLocalOnlyPropertyInfo -> o -> IO (AttrGetType FileChooserLocalOnlyPropertyInfo)

attrSet :: (AttrBaseTypeConstraint FileChooserLocalOnlyPropertyInfo o, AttrSetTypeConstraint FileChooserLocalOnlyPropertyInfo b) => Proxy * FileChooserLocalOnlyPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint FileChooserLocalOnlyPropertyInfo o => Proxy * FileChooserLocalOnlyPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint FileChooserLocalOnlyPropertyInfo o, AttrSetTypeConstraint FileChooserLocalOnlyPropertyInfo b) => Proxy * FileChooserLocalOnlyPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin FileChooserLocalOnlyPropertyInfo

type AttrOrigin FileChooserLocalOnlyPropertyInfo = FileChooser

type AttrLabel FileChooserLocalOnlyPropertyInfo

type AttrLabel FileChooserLocalOnlyPropertyInfo = "local-only"

type AttrGetType FileChooserLocalOnlyPropertyInfo

type AttrGetType FileChooserLocalOnlyPropertyInfo = Bool

type AttrBaseTypeConstraint FileChooserLocalOnlyPropertyInfo

type AttrBaseTypeConstraint FileChooserLocalOnlyPropertyInfo = IsFileChooser

type AttrSetTypeConstraint FileChooserLocalOnlyPropertyInfo

type AttrSetTypeConstraint FileChooserLocalOnlyPropertyInfo = * ~ Bool

type AttrAllowedOps FileChooserLocalOnlyPropertyInfo

type AttrAllowedOps FileChooserLocalOnlyPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructFileChooserLocalOnly :: IsFileChooser o => Bool -> IO (GValueConstruct o)

fileChooserLocalOnly :: AttrLabelProxy "localOnly"

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

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

previewWidget

data FileChooserPreviewWidgetPropertyInfo

Instances

AttrInfo FileChooserPreviewWidgetPropertyInfo

Associated Types

type AttrAllowedOps FileChooserPreviewWidgetPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint FileChooserPreviewWidgetPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint FileChooserPreviewWidgetPropertyInfo :: * -> Constraint

type AttrGetType FileChooserPreviewWidgetPropertyInfo :: *

type AttrLabel FileChooserPreviewWidgetPropertyInfo :: Symbol

type AttrOrigin FileChooserPreviewWidgetPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint FileChooserPreviewWidgetPropertyInfo o => Proxy * FileChooserPreviewWidgetPropertyInfo -> o -> IO (AttrGetType FileChooserPreviewWidgetPropertyInfo)

attrSet :: (AttrBaseTypeConstraint FileChooserPreviewWidgetPropertyInfo o, AttrSetTypeConstraint FileChooserPreviewWidgetPropertyInfo b) => Proxy * FileChooserPreviewWidgetPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint FileChooserPreviewWidgetPropertyInfo o => Proxy * FileChooserPreviewWidgetPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint FileChooserPreviewWidgetPropertyInfo o, AttrSetTypeConstraint FileChooserPreviewWidgetPropertyInfo b) => Proxy * FileChooserPreviewWidgetPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin FileChooserPreviewWidgetPropertyInfo

type AttrOrigin FileChooserPreviewWidgetPropertyInfo = FileChooser

type AttrLabel FileChooserPreviewWidgetPropertyInfo

type AttrLabel FileChooserPreviewWidgetPropertyInfo = "preview-widget"

type AttrGetType FileChooserPreviewWidgetPropertyInfo

type AttrGetType FileChooserPreviewWidgetPropertyInfo = Maybe Widget

type AttrBaseTypeConstraint FileChooserPreviewWidgetPropertyInfo

type AttrBaseTypeConstraint FileChooserPreviewWidgetPropertyInfo = IsFileChooser

type AttrSetTypeConstraint FileChooserPreviewWidgetPropertyInfo

type AttrSetTypeConstraint FileChooserPreviewWidgetPropertyInfo = IsWidget

type AttrAllowedOps FileChooserPreviewWidgetPropertyInfo

type AttrAllowedOps FileChooserPreviewWidgetPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructFileChooserPreviewWidget :: (IsFileChooser o, IsWidget a) => a -> IO (GValueConstruct o)

fileChooserPreviewWidget :: AttrLabelProxy "previewWidget"

getFileChooserPreviewWidget :: (MonadIO m, IsFileChooser o) => o -> m (Maybe Widget)

setFileChooserPreviewWidget :: (MonadIO m, IsFileChooser o, IsWidget a) => o -> a -> m ()

previewWidgetActive

data FileChooserPreviewWidgetActivePropertyInfo

Instances

AttrInfo FileChooserPreviewWidgetActivePropertyInfo

Associated Types

type AttrAllowedOps FileChooserPreviewWidgetActivePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint FileChooserPreviewWidgetActivePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint FileChooserPreviewWidgetActivePropertyInfo :: * -> Constraint

type AttrGetType FileChooserPreviewWidgetActivePropertyInfo :: *

type AttrLabel FileChooserPreviewWidgetActivePropertyInfo :: Symbol

type AttrOrigin FileChooserPreviewWidgetActivePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint FileChooserPreviewWidgetActivePropertyInfo o => Proxy * FileChooserPreviewWidgetActivePropertyInfo -> o -> IO (AttrGetType FileChooserPreviewWidgetActivePropertyInfo)

attrSet :: (AttrBaseTypeConstraint FileChooserPreviewWidgetActivePropertyInfo o, AttrSetTypeConstraint FileChooserPreviewWidgetActivePropertyInfo b) => Proxy * FileChooserPreviewWidgetActivePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint FileChooserPreviewWidgetActivePropertyInfo o => Proxy * FileChooserPreviewWidgetActivePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint FileChooserPreviewWidgetActivePropertyInfo o, AttrSetTypeConstraint FileChooserPreviewWidgetActivePropertyInfo b) => Proxy * FileChooserPreviewWidgetActivePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin FileChooserPreviewWidgetActivePropertyInfo

type AttrOrigin FileChooserPreviewWidgetActivePropertyInfo = FileChooser

type AttrLabel FileChooserPreviewWidgetActivePropertyInfo

type AttrLabel FileChooserPreviewWidgetActivePropertyInfo = "preview-widget-active"

type AttrGetType FileChooserPreviewWidgetActivePropertyInfo

type AttrGetType FileChooserPreviewWidgetActivePropertyInfo = Bool

type AttrBaseTypeConstraint FileChooserPreviewWidgetActivePropertyInfo

type AttrBaseTypeConstraint FileChooserPreviewWidgetActivePropertyInfo = IsFileChooser

type AttrSetTypeConstraint FileChooserPreviewWidgetActivePropertyInfo

type AttrSetTypeConstraint FileChooserPreviewWidgetActivePropertyInfo = * ~ Bool

type AttrAllowedOps FileChooserPreviewWidgetActivePropertyInfo

type AttrAllowedOps FileChooserPreviewWidgetActivePropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructFileChooserPreviewWidgetActive :: IsFileChooser o => Bool -> IO (GValueConstruct o)

fileChooserPreviewWidgetActive :: AttrLabelProxy "previewWidgetActive"

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

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

selectMultiple

data FileChooserSelectMultiplePropertyInfo

Instances

AttrInfo FileChooserSelectMultiplePropertyInfo

Associated Types

type AttrAllowedOps FileChooserSelectMultiplePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint FileChooserSelectMultiplePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint FileChooserSelectMultiplePropertyInfo :: * -> Constraint

type AttrGetType FileChooserSelectMultiplePropertyInfo :: *

type AttrLabel FileChooserSelectMultiplePropertyInfo :: Symbol

type AttrOrigin FileChooserSelectMultiplePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint FileChooserSelectMultiplePropertyInfo o => Proxy * FileChooserSelectMultiplePropertyInfo -> o -> IO (AttrGetType FileChooserSelectMultiplePropertyInfo)

attrSet :: (AttrBaseTypeConstraint FileChooserSelectMultiplePropertyInfo o, AttrSetTypeConstraint FileChooserSelectMultiplePropertyInfo b) => Proxy * FileChooserSelectMultiplePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint FileChooserSelectMultiplePropertyInfo o => Proxy * FileChooserSelectMultiplePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint FileChooserSelectMultiplePropertyInfo o, AttrSetTypeConstraint FileChooserSelectMultiplePropertyInfo b) => Proxy * FileChooserSelectMultiplePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin FileChooserSelectMultiplePropertyInfo

type AttrOrigin FileChooserSelectMultiplePropertyInfo = FileChooser

type AttrLabel FileChooserSelectMultiplePropertyInfo

type AttrLabel FileChooserSelectMultiplePropertyInfo = "select-multiple"

type AttrGetType FileChooserSelectMultiplePropertyInfo

type AttrGetType FileChooserSelectMultiplePropertyInfo = Bool

type AttrBaseTypeConstraint FileChooserSelectMultiplePropertyInfo

type AttrBaseTypeConstraint FileChooserSelectMultiplePropertyInfo = IsFileChooser

type AttrSetTypeConstraint FileChooserSelectMultiplePropertyInfo

type AttrSetTypeConstraint FileChooserSelectMultiplePropertyInfo = * ~ Bool

type AttrAllowedOps FileChooserSelectMultiplePropertyInfo

type AttrAllowedOps FileChooserSelectMultiplePropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructFileChooserSelectMultiple :: IsFileChooser o => Bool -> IO (GValueConstruct o)

fileChooserSelectMultiple :: AttrLabelProxy "selectMultiple"

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

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

showHidden

data FileChooserShowHiddenPropertyInfo

Instances

AttrInfo FileChooserShowHiddenPropertyInfo

Associated Types

type AttrAllowedOps FileChooserShowHiddenPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint FileChooserShowHiddenPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint FileChooserShowHiddenPropertyInfo :: * -> Constraint

type AttrGetType FileChooserShowHiddenPropertyInfo :: *

type AttrLabel FileChooserShowHiddenPropertyInfo :: Symbol

type AttrOrigin FileChooserShowHiddenPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint FileChooserShowHiddenPropertyInfo o => Proxy * FileChooserShowHiddenPropertyInfo -> o -> IO (AttrGetType FileChooserShowHiddenPropertyInfo)

attrSet :: (AttrBaseTypeConstraint FileChooserShowHiddenPropertyInfo o, AttrSetTypeConstraint FileChooserShowHiddenPropertyInfo b) => Proxy * FileChooserShowHiddenPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint FileChooserShowHiddenPropertyInfo o => Proxy * FileChooserShowHiddenPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint FileChooserShowHiddenPropertyInfo o, AttrSetTypeConstraint FileChooserShowHiddenPropertyInfo b) => Proxy * FileChooserShowHiddenPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin FileChooserShowHiddenPropertyInfo

type AttrOrigin FileChooserShowHiddenPropertyInfo = FileChooser

type AttrLabel FileChooserShowHiddenPropertyInfo

type AttrLabel FileChooserShowHiddenPropertyInfo = "show-hidden"

type AttrGetType FileChooserShowHiddenPropertyInfo

type AttrGetType FileChooserShowHiddenPropertyInfo = Bool

type AttrBaseTypeConstraint FileChooserShowHiddenPropertyInfo

type AttrBaseTypeConstraint FileChooserShowHiddenPropertyInfo = IsFileChooser

type AttrSetTypeConstraint FileChooserShowHiddenPropertyInfo

type AttrSetTypeConstraint FileChooserShowHiddenPropertyInfo = * ~ Bool

type AttrAllowedOps FileChooserShowHiddenPropertyInfo

type AttrAllowedOps FileChooserShowHiddenPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructFileChooserShowHidden :: IsFileChooser o => Bool -> IO (GValueConstruct o)

fileChooserShowHidden :: AttrLabelProxy "showHidden"

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

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

usePreviewLabel

data FileChooserUsePreviewLabelPropertyInfo

Instances

AttrInfo FileChooserUsePreviewLabelPropertyInfo

Associated Types

type AttrAllowedOps FileChooserUsePreviewLabelPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint FileChooserUsePreviewLabelPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint FileChooserUsePreviewLabelPropertyInfo :: * -> Constraint

type AttrGetType FileChooserUsePreviewLabelPropertyInfo :: *

type AttrLabel FileChooserUsePreviewLabelPropertyInfo :: Symbol

type AttrOrigin FileChooserUsePreviewLabelPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint FileChooserUsePreviewLabelPropertyInfo o => Proxy * FileChooserUsePreviewLabelPropertyInfo -> o -> IO (AttrGetType FileChooserUsePreviewLabelPropertyInfo)

attrSet :: (AttrBaseTypeConstraint FileChooserUsePreviewLabelPropertyInfo o, AttrSetTypeConstraint FileChooserUsePreviewLabelPropertyInfo b) => Proxy * FileChooserUsePreviewLabelPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint FileChooserUsePreviewLabelPropertyInfo o => Proxy * FileChooserUsePreviewLabelPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint FileChooserUsePreviewLabelPropertyInfo o, AttrSetTypeConstraint FileChooserUsePreviewLabelPropertyInfo b) => Proxy * FileChooserUsePreviewLabelPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin FileChooserUsePreviewLabelPropertyInfo

type AttrOrigin FileChooserUsePreviewLabelPropertyInfo = FileChooser

type AttrLabel FileChooserUsePreviewLabelPropertyInfo

type AttrLabel FileChooserUsePreviewLabelPropertyInfo = "use-preview-label"

type AttrGetType FileChooserUsePreviewLabelPropertyInfo

type AttrGetType FileChooserUsePreviewLabelPropertyInfo = Bool

type AttrBaseTypeConstraint FileChooserUsePreviewLabelPropertyInfo

type AttrBaseTypeConstraint FileChooserUsePreviewLabelPropertyInfo = IsFileChooser

type AttrSetTypeConstraint FileChooserUsePreviewLabelPropertyInfo

type AttrSetTypeConstraint FileChooserUsePreviewLabelPropertyInfo = * ~ Bool

type AttrAllowedOps FileChooserUsePreviewLabelPropertyInfo

type AttrAllowedOps FileChooserUsePreviewLabelPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructFileChooserUsePreviewLabel :: IsFileChooser o => Bool -> IO (GValueConstruct o)

fileChooserUsePreviewLabel :: AttrLabelProxy "usePreviewLabel"

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

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

Signals

confirmOverwrite

type C_FileChooserConfirmOverwriteCallback = Ptr () -> Ptr () -> IO CUInt

type FileChooserConfirmOverwriteCallback = IO FileChooserConfirmation

data FileChooserConfirmOverwriteSignalInfo

Instances

SignalInfo FileChooserConfirmOverwriteSignalInfo

Associated Types

type HaskellCallbackType FileChooserConfirmOverwriteSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o FileChooserConfirmOverwriteSignalInfo -> o -> HaskellCallbackType FileChooserConfirmOverwriteSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType FileChooserConfirmOverwriteSignalInfo

type HaskellCallbackType FileChooserConfirmOverwriteSignalInfo = FileChooserConfirmOverwriteCallback

afterFileChooserConfirmOverwrite :: (GObject a, MonadIO m) => a -> FileChooserConfirmOverwriteCallback -> m SignalHandlerId

genClosure_FileChooserConfirmOverwrite :: FileChooserConfirmOverwriteCallback -> IO Closure

mk_FileChooserConfirmOverwriteCallback :: C_FileChooserConfirmOverwriteCallback -> IO (FunPtr C_FileChooserConfirmOverwriteCallback)

noFileChooserConfirmOverwriteCallback :: Maybe FileChooserConfirmOverwriteCallback

onFileChooserConfirmOverwrite :: (GObject a, MonadIO m) => a -> FileChooserConfirmOverwriteCallback -> m SignalHandlerId

wrap_FileChooserConfirmOverwriteCallback :: FileChooserConfirmOverwriteCallback -> Ptr () -> Ptr () -> IO CUInt

currentFolderChanged

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

type FileChooserCurrentFolderChangedCallback = IO ()

data FileChooserCurrentFolderChangedSignalInfo

Instances

SignalInfo FileChooserCurrentFolderChangedSignalInfo

Associated Types

type HaskellCallbackType FileChooserCurrentFolderChangedSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o FileChooserCurrentFolderChangedSignalInfo -> o -> HaskellCallbackType FileChooserCurrentFolderChangedSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType FileChooserCurrentFolderChangedSignalInfo

type HaskellCallbackType FileChooserCurrentFolderChangedSignalInfo = FileChooserCurrentFolderChangedCallback

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

genClosure_FileChooserCurrentFolderChanged :: FileChooserCurrentFolderChangedCallback -> IO Closure

mk_FileChooserCurrentFolderChangedCallback :: C_FileChooserCurrentFolderChangedCallback -> IO (FunPtr C_FileChooserCurrentFolderChangedCallback)

noFileChooserCurrentFolderChangedCallback :: Maybe FileChooserCurrentFolderChangedCallback

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

wrap_FileChooserCurrentFolderChangedCallback :: FileChooserCurrentFolderChangedCallback -> Ptr () -> Ptr () -> IO ()

fileActivated

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

type FileChooserFileActivatedCallback = IO ()

data FileChooserFileActivatedSignalInfo

Instances

SignalInfo FileChooserFileActivatedSignalInfo

Associated Types

type HaskellCallbackType FileChooserFileActivatedSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o FileChooserFileActivatedSignalInfo -> o -> HaskellCallbackType FileChooserFileActivatedSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType FileChooserFileActivatedSignalInfo

type HaskellCallbackType FileChooserFileActivatedSignalInfo = FileChooserFileActivatedCallback

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

genClosure_FileChooserFileActivated :: FileChooserFileActivatedCallback -> IO Closure

mk_FileChooserFileActivatedCallback :: C_FileChooserFileActivatedCallback -> IO (FunPtr C_FileChooserFileActivatedCallback)

noFileChooserFileActivatedCallback :: Maybe FileChooserFileActivatedCallback

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

wrap_FileChooserFileActivatedCallback :: FileChooserFileActivatedCallback -> Ptr () -> Ptr () -> IO ()

selectionChanged

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

type FileChooserSelectionChangedCallback = IO ()

data FileChooserSelectionChangedSignalInfo

Instances

SignalInfo FileChooserSelectionChangedSignalInfo

Associated Types

type HaskellCallbackType FileChooserSelectionChangedSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o FileChooserSelectionChangedSignalInfo -> o -> HaskellCallbackType FileChooserSelectionChangedSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType FileChooserSelectionChangedSignalInfo

type HaskellCallbackType FileChooserSelectionChangedSignalInfo = FileChooserSelectionChangedCallback

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

genClosure_FileChooserSelectionChanged :: FileChooserSelectionChangedCallback -> IO Closure

mk_FileChooserSelectionChangedCallback :: C_FileChooserSelectionChangedCallback -> IO (FunPtr C_FileChooserSelectionChangedCallback)

noFileChooserSelectionChangedCallback :: Maybe FileChooserSelectionChangedCallback

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

wrap_FileChooserSelectionChangedCallback :: FileChooserSelectionChangedCallback -> Ptr () -> Ptr () -> IO ()

updatePreview

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

type FileChooserUpdatePreviewCallback = IO ()

data FileChooserUpdatePreviewSignalInfo

Instances

SignalInfo FileChooserUpdatePreviewSignalInfo

Associated Types

type HaskellCallbackType FileChooserUpdatePreviewSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o FileChooserUpdatePreviewSignalInfo -> o -> HaskellCallbackType FileChooserUpdatePreviewSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType FileChooserUpdatePreviewSignalInfo

type HaskellCallbackType FileChooserUpdatePreviewSignalInfo = FileChooserUpdatePreviewCallback

afterFileChooserUpdatePreview :: (GObject a, MonadIO m) => a -> FileChooserUpdatePreviewCallback -> m SignalHandlerId

genClosure_FileChooserUpdatePreview :: FileChooserUpdatePreviewCallback -> IO Closure

mk_FileChooserUpdatePreviewCallback :: C_FileChooserUpdatePreviewCallback -> IO (FunPtr C_FileChooserUpdatePreviewCallback)

noFileChooserUpdatePreviewCallback :: Maybe FileChooserUpdatePreviewCallback

onFileChooserUpdatePreview :: (GObject a, MonadIO m) => a -> FileChooserUpdatePreviewCallback -> m SignalHandlerId

wrap_FileChooserUpdatePreviewCallback :: FileChooserUpdatePreviewCallback -> Ptr () -> Ptr () -> IO ()