GI.Gtk.Objects.FileChooserWidget

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

Exported types

newtype FileChooserWidget

Memory-managed wrapper type.

Constructors

FileChooserWidget (ManagedPtr FileChooserWidget)

Instances

Eq FileChooserWidget

Defined in GI.Gtk.Objects.FileChooserWidget

Methods

(==) :: FileChooserWidget -> FileChooserWidget -> Bool

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

GObject FileChooserWidget

Defined in GI.Gtk.Objects.FileChooserWidget

ManagedPtrNewtype FileChooserWidget

Defined in GI.Gtk.Objects.FileChooserWidget

Methods

toManagedPtr :: FileChooserWidget -> ManagedPtr FileChooserWidget

TypedObject FileChooserWidget

Defined in GI.Gtk.Objects.FileChooserWidget

Methods

glibType :: IO GType

HasParentTypes FileChooserWidget

Defined in GI.Gtk.Objects.FileChooserWidget

IsGValue (Maybe FileChooserWidget)

Convert FileChooserWidget to and from GValue. See toGValue and fromGValue.

Defined in GI.Gtk.Objects.FileChooserWidget

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe FileChooserWidget -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe FileChooserWidget)

type ParentTypes FileChooserWidget

Defined in GI.Gtk.Objects.FileChooserWidget

type ParentTypes FileChooserWidget = '[Widget, Object, Accessible, Buildable, ConstraintTarget, FileChooser]

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

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

Instances

(GObject o, IsDescendantOf FileChooserWidget o) => IsFileChooserWidget o

Defined in GI.Gtk.Objects.FileChooserWidget

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

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

Methods

Click to display all available methods, including inherited ones

Methods

actionSetEnabled, activate, activateAction, activateDefault, addChoice, addController, addCssClass, addFilter, addMnemonicLabel, addShortcutFolder, addTickCallback, allocate, announce, bindProperty, bindPropertyFull, childFocus, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, disposeTemplate, dragCheckThreshold, errorBell, forceFloating, freezeNotify, getv, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFloating, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, notify, notifyByPspec, observeChildren, observeControllers, pick, queueAllocate, queueDraw, queueResize, realize, ref, refSink, removeChoice, removeController, removeCssClass, removeFilter, removeMnemonicLabel, removeShortcutFolder, removeTickCallback, resetProperty, resetRelation, resetState, runDispose, shouldLayout, show, sizeAllocate, snapshotChild, stealData, stealQdata, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unsetStateFlags, updateNextAccessibleSibling, updateProperty, updateRelation, updateState, watchClosure.

Getters

getAccessibleParent, getAccessibleRole, getAction, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getAtContext, getBaseline, getBounds, getBuildableId, getCanFocus, getCanTarget, getChildVisible, getChoice, getClipboard, getColor, getCreateFolders, getCssClasses, getCssName, getCurrentFolder, getCurrentName, getCursor, getData, getDirection, getDisplay, getFile, getFiles, getFilter, getFilters, getFirstAccessibleChild, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextAccessibleSibling, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPlatformState, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSelectMultiple, getSensitive, getSettings, getShortcutFolders, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth.

Setters

setAccessibleParent, setAction, setCanFocus, setCanTarget, setChildVisible, setChoice, setCreateFolders, setCssClasses, setCurrentFolder, setCurrentName, setCursor, setCursorFromName, setData, setDataFull, setDirection, setFile, setFilter, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setProperty, setReceivesDefault, setSelectMultiple, setSensitive, setSizeRequest, setStateFlags, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible.

new

fileChooserWidgetNew

Arguments

:: (HasCallStack, MonadIO m)

=> FileChooserAction

action: Open or save mode for the widget

-> m FileChooserWidget

Returns: a new GtkFileChooserWidget

Deprecated: (Since version 4.10)Direct use of GtkFileChooserWidget is deprecated

Creates a new GtkFileChooserWidget.

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

Properties

searchMode

No description available in the introspection data.

constructFileChooserWidgetSearchMode :: (IsFileChooserWidget o, MonadIO m) => Bool -> m (GValueConstruct o)

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

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

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

set fileChooserWidget [ #searchMode := value ]

showTime

Whether to show the time.

Since: 4.10

getFileChooserWidgetShowTime :: (MonadIO m, IsFileChooserWidget o) => o -> m Bool

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

get fileChooserWidget #showTime

subtitle

No description available in the introspection data.

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

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

get fileChooserWidget #subtitle

Signals

desktopFolder

type FileChooserWidgetDesktopFolderCallback = IO ()

Emitted when the user asks for it.

This is a keybinding signal.

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 <kbd>Alt</kbd>-<kbd>D</kbd>.

afterFileChooserWidgetDesktopFolder :: (IsFileChooserWidget a, MonadIO m) => a -> ((?self :: a) => FileChooserWidgetDesktopFolderCallback) -> m SignalHandlerId

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

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onFileChooserWidgetDesktopFolder :: (IsFileChooserWidget a, MonadIO m) => a -> ((?self :: a) => FileChooserWidgetDesktopFolderCallback) -> m SignalHandlerId

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 FileChooserWidgetDownFolderCallback = IO ()

Emitted when the user asks for it.

This is a keybinding signal.

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 <kbd>Alt</kbd>-<kbd>Down</kbd>.

afterFileChooserWidgetDownFolder :: (IsFileChooserWidget a, MonadIO m) => a -> ((?self :: a) => FileChooserWidgetDownFolderCallback) -> m SignalHandlerId

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

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onFileChooserWidgetDownFolder :: (IsFileChooserWidget a, MonadIO m) => a -> ((?self :: a) => FileChooserWidgetDownFolderCallback) -> m SignalHandlerId

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 FileChooserWidgetHomeFolderCallback = IO ()

Emitted when the user asks for it.

This is a keybinding signal.

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 <kbd>Alt</kbd>-<kbd>Home</kbd>.

afterFileChooserWidgetHomeFolder :: (IsFileChooserWidget a, MonadIO m) => a -> ((?self :: a) => FileChooserWidgetHomeFolderCallback) -> m SignalHandlerId

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

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onFileChooserWidgetHomeFolder :: (IsFileChooserWidget a, MonadIO m) => a -> ((?self :: a) => FileChooserWidgetHomeFolderCallback) -> m SignalHandlerId

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 FileChooserWidgetLocationPopupCallback

Arguments

 = Text

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

-> IO ()

Emitted when the user asks for it.

This is a keybinding signal.

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 <kbd>Control</kbd>-<kbd>L</kbd> with a path string of "" (the empty string). It is also bound to <kbd>/</kbd> with a path string of "/" (a slash): this lets you type / and immediately type a path name. On Unix systems, this is bound to <kbd>~</kbd> (tilde) with a path string of "~" itself for access to home directories.

afterFileChooserWidgetLocationPopup :: (IsFileChooserWidget a, MonadIO m) => a -> ((?self :: a) => FileChooserWidgetLocationPopupCallback) -> m SignalHandlerId

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

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onFileChooserWidgetLocationPopup :: (IsFileChooserWidget a, MonadIO m) => a -> ((?self :: a) => FileChooserWidgetLocationPopupCallback) -> m SignalHandlerId

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 FileChooserWidgetLocationPopupOnPasteCallback = IO ()

Emitted when the user asks for it.

This is a keybinding signal.

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

The default binding for this signal is <kbd>Control</kbd>-<kbd>V</kbd>.

afterFileChooserWidgetLocationPopupOnPaste :: (IsFileChooserWidget a, MonadIO m) => a -> ((?self :: a) => FileChooserWidgetLocationPopupOnPasteCallback) -> m SignalHandlerId

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

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onFileChooserWidgetLocationPopupOnPaste :: (IsFileChooserWidget a, MonadIO m) => a -> ((?self :: a) => FileChooserWidgetLocationPopupOnPasteCallback) -> m SignalHandlerId

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 FileChooserWidgetLocationTogglePopupCallback = IO ()

Emitted when the user asks for it.

This is a keybinding signal.

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 <kbd>Control</kbd>-<kbd>L</kbd>.

afterFileChooserWidgetLocationTogglePopup :: (IsFileChooserWidget a, MonadIO m) => a -> ((?self :: a) => FileChooserWidgetLocationTogglePopupCallback) -> m SignalHandlerId

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

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onFileChooserWidgetLocationTogglePopup :: (IsFileChooserWidget a, MonadIO m) => a -> ((?self :: a) => FileChooserWidgetLocationTogglePopupCallback) -> m SignalHandlerId

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 FileChooserWidgetPlacesShortcutCallback = IO ()

Emitted when the user asks for it.

This is a keybinding signal.

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

The default binding for this signal is <kbd>Alt</kbd>-<kbd>P</kbd>.

afterFileChooserWidgetPlacesShortcut :: (IsFileChooserWidget a, MonadIO m) => a -> ((?self :: a) => FileChooserWidgetPlacesShortcutCallback) -> m SignalHandlerId

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

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onFileChooserWidgetPlacesShortcut :: (IsFileChooserWidget a, MonadIO m) => a -> ((?self :: a) => FileChooserWidgetPlacesShortcutCallback) -> m SignalHandlerId

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 FileChooserWidgetQuickBookmarkCallback

Arguments

 = Int32

bookmarkIndex: the number of the bookmark to switch to

-> IO ()

Emitted when the user asks for it.

This is a keybinding signal.

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 <kbd>Alt</kbd>-<kbd>1</kbd>, <kbd>Alt</kbd>-<kbd>2</kbd>, etc. until <kbd>Alt</kbd>-<kbd>0</kbd>. Note that in the default binding, that <kbd>Alt</kbd>-<kbd>1</kbd> is actually defined to switch to the bookmark at index 0, and so on successively.

afterFileChooserWidgetQuickBookmark :: (IsFileChooserWidget a, MonadIO m) => a -> ((?self :: a) => FileChooserWidgetQuickBookmarkCallback) -> m SignalHandlerId

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

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onFileChooserWidgetQuickBookmark :: (IsFileChooserWidget a, MonadIO m) => a -> ((?self :: a) => FileChooserWidgetQuickBookmarkCallback) -> m SignalHandlerId

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 FileChooserWidgetRecentShortcutCallback = IO ()

Emitted when the user asks for it.

This is a keybinding signal.

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

The default binding for this signal is <kbd>Alt</kbd>-<kbd>R</kbd>.

afterFileChooserWidgetRecentShortcut :: (IsFileChooserWidget a, MonadIO m) => a -> ((?self :: a) => FileChooserWidgetRecentShortcutCallback) -> m SignalHandlerId

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

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onFileChooserWidgetRecentShortcut :: (IsFileChooserWidget a, MonadIO m) => a -> ((?self :: a) => FileChooserWidgetRecentShortcutCallback) -> m SignalHandlerId

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 FileChooserWidgetSearchShortcutCallback = IO ()

Emitted when the user asks for it.

This is a keybinding signal.

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

The default binding for this signal is <kbd>Alt</kbd>-<kbd>S</kbd>.

afterFileChooserWidgetSearchShortcut :: (IsFileChooserWidget a, MonadIO m) => a -> ((?self :: a) => FileChooserWidgetSearchShortcutCallback) -> m SignalHandlerId

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

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onFileChooserWidgetSearchShortcut :: (IsFileChooserWidget a, MonadIO m) => a -> ((?self :: a) => FileChooserWidgetSearchShortcutCallback) -> m SignalHandlerId

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 FileChooserWidgetShowHiddenCallback = IO ()

Emitted when the user asks for it.

This is a keybinding signal.

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

The default binding for this signal is <kbd>Control</kbd>-<kbd>H</kbd>.

afterFileChooserWidgetShowHidden :: (IsFileChooserWidget a, MonadIO m) => a -> ((?self :: a) => FileChooserWidgetShowHiddenCallback) -> m SignalHandlerId

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

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onFileChooserWidgetShowHidden :: (IsFileChooserWidget a, MonadIO m) => a -> ((?self :: a) => FileChooserWidgetShowHiddenCallback) -> m SignalHandlerId

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 FileChooserWidgetUpFolderCallback = IO ()

Emitted when the user asks for it.

This is a keybinding signal.

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 <kbd>Alt</kbd>-<kbd>Up</kbd>.

afterFileChooserWidgetUpFolder :: (IsFileChooserWidget a, MonadIO m) => a -> ((?self :: a) => FileChooserWidgetUpFolderCallback) -> m SignalHandlerId

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

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onFileChooserWidgetUpFolder :: (IsFileChooserWidget a, MonadIO m) => a -> ((?self :: a) => FileChooserWidgetUpFolderCallback) -> m SignalHandlerId

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