gi-gtk-3.0.32: Gtk bindings
CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.Gtk.Objects.FileChooserWidget

Description

FileChooserWidget is a widget for choosing files. It exposes the FileChooser interface, and you should use the methods of this interface to interact with the widget.

CSS nodes

GtkFileChooserWidget has a single CSS node with name filechooser.

Synopsis

Exported types

class (GObject o, IsDescendantOf FileChooserWidget o) => IsFileChooserWidget o Source #

Type class for types which can be safely cast to FileChooserWidget, for instance with toFileChooserWidget.

Instances

Instances details
(GObject o, IsDescendantOf FileChooserWidget o) => IsFileChooserWidget o Source # 
Instance details

Defined in GI.Gtk.Objects.FileChooserWidget

toFileChooserWidget :: (MonadIO m, IsFileChooserWidget o) => o -> m FileChooserWidget Source #

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

Methods

Overloaded methods

new

fileChooserWidgetNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FileChooserAction

action: Open or save mode for the widget

-> m FileChooserWidget

Returns: a new FileChooserWidget

Creates a new FileChooserWidget. This is a file chooser widget that can be embedded in custom windows, and it is the same widget that is used by FileChooserDialog.

Since: 2.4

Properties

searchMode

No description available in the introspection data.

constructFileChooserWidgetSearchMode :: IsFileChooserWidget o => Bool -> IO (GValueConstruct o) Source #

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

getFileChooserWidgetSearchMode :: (MonadIO m, IsFileChooserWidget o) => o -> m Bool Source #

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

get fileChooserWidget #searchMode

setFileChooserWidgetSearchMode :: (MonadIO m, IsFileChooserWidget o) => o -> Bool -> m () Source #

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

set fileChooserWidget [ #searchMode := value ]

subtitle

No description available in the introspection data.

getFileChooserWidgetSubtitle :: (MonadIO m, IsFileChooserWidget o) => o -> m (Maybe Text) Source #

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

get fileChooserWidget #subtitle

Signals

desktopFolder

type C_FileChooserWidgetDesktopFolderCallback = Ptr () -> Ptr () -> IO () Source #

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

type FileChooserWidgetDesktopFolderCallback = IO () Source #

The desktopFolder signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user asks for it.

This is used to make the file chooser show the user's Desktop folder in the file list.

The default binding for this signal is Alt + D.

afterFileChooserWidgetDesktopFolder :: (IsFileChooserWidget a, MonadIO m) => a -> FileChooserWidgetDesktopFolderCallback -> m SignalHandlerId Source #

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

after fileChooserWidget #desktopFolder callback

onFileChooserWidgetDesktopFolder :: (IsFileChooserWidget a, MonadIO m) => a -> FileChooserWidgetDesktopFolderCallback -> m SignalHandlerId Source #

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

on fileChooserWidget #desktopFolder callback

downFolder

type C_FileChooserWidgetDownFolderCallback = Ptr () -> Ptr () -> IO () Source #

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

type FileChooserWidgetDownFolderCallback = IO () Source #

The downFolder signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user asks for it.

This is used to make the file chooser go to a child of the current folder in the file hierarchy. The subfolder that will be used is displayed in the path bar widget of the file chooser. For example, if the path bar is showing "/foo/bar/baz", with bar currently displayed, then this will cause the file chooser to switch to the "baz" subfolder.

The default binding for this signal is Alt + Down.

afterFileChooserWidgetDownFolder :: (IsFileChooserWidget a, MonadIO m) => a -> FileChooserWidgetDownFolderCallback -> m SignalHandlerId Source #

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

after fileChooserWidget #downFolder callback

onFileChooserWidgetDownFolder :: (IsFileChooserWidget a, MonadIO m) => a -> FileChooserWidgetDownFolderCallback -> m SignalHandlerId Source #

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

on fileChooserWidget #downFolder callback

homeFolder

type C_FileChooserWidgetHomeFolderCallback = Ptr () -> Ptr () -> IO () Source #

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

type FileChooserWidgetHomeFolderCallback = IO () Source #

The homeFolder signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user asks for it.

This is used to make the file chooser show the user's home folder in the file list.

The default binding for this signal is Alt + Home.

afterFileChooserWidgetHomeFolder :: (IsFileChooserWidget a, MonadIO m) => a -> FileChooserWidgetHomeFolderCallback -> m SignalHandlerId Source #

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

after fileChooserWidget #homeFolder callback

onFileChooserWidgetHomeFolder :: (IsFileChooserWidget a, MonadIO m) => a -> FileChooserWidgetHomeFolderCallback -> m SignalHandlerId Source #

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

on fileChooserWidget #homeFolder callback

locationPopup

type C_FileChooserWidgetLocationPopupCallback = Ptr () -> CString -> Ptr () -> IO () Source #

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

type FileChooserWidgetLocationPopupCallback Source #

Arguments

 = Text

path: a string that gets put in the text entry for the file name

-> IO () 

The locationPopup signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user asks for it.

This is used to make the file chooser show a "Location" prompt which the user can use to manually type the name of the file he wishes to select.

The default bindings for this signal are Control + L with a path string of "" (the empty string). It is also bound to / with a path string of "/" (a slash): this lets you type / and immediately type a path name. On Unix systems, this is bound to ~ (tilde) with a path string of "~" itself for access to home directories.

afterFileChooserWidgetLocationPopup :: (IsFileChooserWidget a, MonadIO m) => a -> FileChooserWidgetLocationPopupCallback -> m SignalHandlerId Source #

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

after fileChooserWidget #locationPopup callback

onFileChooserWidgetLocationPopup :: (IsFileChooserWidget a, MonadIO m) => a -> FileChooserWidgetLocationPopupCallback -> m SignalHandlerId Source #

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

on fileChooserWidget #locationPopup callback

locationPopupOnPaste

type C_FileChooserWidgetLocationPopupOnPasteCallback = Ptr () -> Ptr () -> IO () Source #

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

type FileChooserWidgetLocationPopupOnPasteCallback = IO () Source #

The locationPopupOnPaste signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user asks for it.

This is used to make the file chooser show a "Location" prompt when the user pastes into a FileChooserWidget.

The default binding for this signal is Control + V.

afterFileChooserWidgetLocationPopupOnPaste :: (IsFileChooserWidget a, MonadIO m) => a -> FileChooserWidgetLocationPopupOnPasteCallback -> m SignalHandlerId Source #

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

after fileChooserWidget #locationPopupOnPaste callback

onFileChooserWidgetLocationPopupOnPaste :: (IsFileChooserWidget a, MonadIO m) => a -> FileChooserWidgetLocationPopupOnPasteCallback -> m SignalHandlerId Source #

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

on fileChooserWidget #locationPopupOnPaste callback

locationTogglePopup

type C_FileChooserWidgetLocationTogglePopupCallback = Ptr () -> Ptr () -> IO () Source #

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

type FileChooserWidgetLocationTogglePopupCallback = IO () Source #

The locationTogglePopup signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user asks for it.

This is used to toggle the visibility of a "Location" prompt which the user can use to manually type the name of the file he wishes to select.

The default binding for this signal is Control + L.

afterFileChooserWidgetLocationTogglePopup :: (IsFileChooserWidget a, MonadIO m) => a -> FileChooserWidgetLocationTogglePopupCallback -> m SignalHandlerId Source #

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

after fileChooserWidget #locationTogglePopup callback

onFileChooserWidgetLocationTogglePopup :: (IsFileChooserWidget a, MonadIO m) => a -> FileChooserWidgetLocationTogglePopupCallback -> m SignalHandlerId Source #

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

on fileChooserWidget #locationTogglePopup callback

placesShortcut

type C_FileChooserWidgetPlacesShortcutCallback = Ptr () -> Ptr () -> IO () Source #

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

type FileChooserWidgetPlacesShortcutCallback = IO () Source #

The placesShortcut signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user asks for it.

This is used to move the focus to the places sidebar.

The default binding for this signal is Alt + P.

afterFileChooserWidgetPlacesShortcut :: (IsFileChooserWidget a, MonadIO m) => a -> FileChooserWidgetPlacesShortcutCallback -> m SignalHandlerId Source #

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

after fileChooserWidget #placesShortcut callback

onFileChooserWidgetPlacesShortcut :: (IsFileChooserWidget a, MonadIO m) => a -> FileChooserWidgetPlacesShortcutCallback -> m SignalHandlerId Source #

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

on fileChooserWidget #placesShortcut callback

quickBookmark

type C_FileChooserWidgetQuickBookmarkCallback = Ptr () -> Int32 -> Ptr () -> IO () Source #

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

type FileChooserWidgetQuickBookmarkCallback Source #

Arguments

 = Int32

bookmarkIndex: the number of the bookmark to switch to

-> IO () 

The quickBookmark signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user asks for it.

This is used to make the file chooser switch to the bookmark specified in the bookmarkIndex parameter. For example, if you have three bookmarks, you can pass 0, 1, 2 to this signal to switch to each of them, respectively.

The default binding for this signal is Alt + 1, Alt + 2, etc. until Alt + 0. Note that in the default binding, that Alt + 1 is actually defined to switch to the bookmark at index 0, and so on successively; Alt + 0 is defined to switch to the bookmark at index 10.

afterFileChooserWidgetQuickBookmark :: (IsFileChooserWidget a, MonadIO m) => a -> FileChooserWidgetQuickBookmarkCallback -> m SignalHandlerId Source #

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

after fileChooserWidget #quickBookmark callback

onFileChooserWidgetQuickBookmark :: (IsFileChooserWidget a, MonadIO m) => a -> FileChooserWidgetQuickBookmarkCallback -> m SignalHandlerId Source #

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

on fileChooserWidget #quickBookmark callback

recentShortcut

type C_FileChooserWidgetRecentShortcutCallback = Ptr () -> Ptr () -> IO () Source #

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

type FileChooserWidgetRecentShortcutCallback = IO () Source #

The recentShortcut signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user asks for it.

This is used to make the file chooser show the Recent location.

The default binding for this signal is Alt + R.

afterFileChooserWidgetRecentShortcut :: (IsFileChooserWidget a, MonadIO m) => a -> FileChooserWidgetRecentShortcutCallback -> m SignalHandlerId Source #

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

after fileChooserWidget #recentShortcut callback

onFileChooserWidgetRecentShortcut :: (IsFileChooserWidget a, MonadIO m) => a -> FileChooserWidgetRecentShortcutCallback -> m SignalHandlerId Source #

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

on fileChooserWidget #recentShortcut callback

searchShortcut

type C_FileChooserWidgetSearchShortcutCallback = Ptr () -> Ptr () -> IO () Source #

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

type FileChooserWidgetSearchShortcutCallback = IO () Source #

The searchShortcut signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user asks for it.

This is used to make the file chooser show the search entry.

The default binding for this signal is Alt + S.

afterFileChooserWidgetSearchShortcut :: (IsFileChooserWidget a, MonadIO m) => a -> FileChooserWidgetSearchShortcutCallback -> m SignalHandlerId Source #

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

after fileChooserWidget #searchShortcut callback

onFileChooserWidgetSearchShortcut :: (IsFileChooserWidget a, MonadIO m) => a -> FileChooserWidgetSearchShortcutCallback -> m SignalHandlerId Source #

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

on fileChooserWidget #searchShortcut callback

showHidden

type C_FileChooserWidgetShowHiddenCallback = Ptr () -> Ptr () -> IO () Source #

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

type FileChooserWidgetShowHiddenCallback = IO () Source #

The showHidden signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user asks for it.

This is used to make the file chooser display hidden files.

The default binding for this signal is Control + H.

afterFileChooserWidgetShowHidden :: (IsFileChooserWidget a, MonadIO m) => a -> FileChooserWidgetShowHiddenCallback -> m SignalHandlerId Source #

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

after fileChooserWidget #showHidden callback

onFileChooserWidgetShowHidden :: (IsFileChooserWidget a, MonadIO m) => a -> FileChooserWidgetShowHiddenCallback -> m SignalHandlerId Source #

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

on fileChooserWidget #showHidden callback

upFolder

type C_FileChooserWidgetUpFolderCallback = Ptr () -> Ptr () -> IO () Source #

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

type FileChooserWidgetUpFolderCallback = IO () Source #

The upFolder signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user asks for it.

This is used to make the file chooser go to the parent of the current folder in the file hierarchy.

The default binding for this signal is Alt + Up.

afterFileChooserWidgetUpFolder :: (IsFileChooserWidget a, MonadIO m) => a -> FileChooserWidgetUpFolderCallback -> m SignalHandlerId Source #

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

after fileChooserWidget #upFolder callback

onFileChooserWidgetUpFolder :: (IsFileChooserWidget a, MonadIO m) => a -> FileChooserWidgetUpFolderCallback -> m SignalHandlerId Source #

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

on fileChooserWidget #upFolder callback