Skip to main content

Type Alias: GtkFileChooserWidgetProps

GtkFileChooserWidgetProps = WidgetProps & object

Defined in: generated/jsx.ts:4086

Props for the GtkFileChooserWidget widget.

Type Declaration

NameTypeDescriptionDefined in
action?Gtk.FileChooserActionThe type of operation that the file chooser is performing.generated/jsx.ts:4090
createFolders?booleanWhether a file chooser not in %GTK_FILE_CHOOSER_ACTION_OPEN mode will offer the user to create new folders.generated/jsx.ts:4095
filter?Gtk.FileFilterThe current filter for selecting files that are displayed.generated/jsx.ts:4097
onDesktopFolder()?(self) => void | nullEmitted 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 Alt-D.generated/jsx.ts:4110
onDownFolder()?(self) => void | nullEmitted 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 Alt-Down.generated/jsx.ts:4125
onHomeFolder()?(self) => void | nullEmitted 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 Alt-Home.generated/jsx.ts:4136
onLocationPopup()?(self, path) => void | nullEmitted 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 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.generated/jsx.ts:4152
onLocationPopupOnPaste()?(self) => void | nullEmitted 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 Control-V.generated/jsx.ts:4163
onLocationTogglePopup()?(self) => void | nullEmitted 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 Control-L.generated/jsx.ts:4175
onNotify?(self, propName) => void | nullCalled when any property on this widget changes. Param The widget that emitted the notification Param The name of the property that changed (in kebab-case)generated/jsx.ts:4249
onPlacesShortcut()?(self) => void | nullEmitted 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 Alt-P.generated/jsx.ts:4185
onQuickBookmark()?(self, bookmarkIndex) => void | nullEmitted 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 bookmark_index 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.generated/jsx.ts:4202
onRecentShortcut()?(self) => void | nullEmitted 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 Alt-R.generated/jsx.ts:4212
onSearchShortcut()?(self) => void | nullEmitted 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 Alt-S.generated/jsx.ts:4222
onShowHidden()?(self) => void | nullEmitted 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 Control-H.generated/jsx.ts:4232
onUpFolder()?(self) => void | nullEmitted 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 Alt-Up.generated/jsx.ts:4243
ref?Ref<Gtk.FileChooserWidget>-generated/jsx.ts:4255
searchMode?booleanWhether search mode is enabled.generated/jsx.ts:4088
selectMultiple?booleanWhether to allow multiple files to be selected.generated/jsx.ts:4099