FileChooserWidget
GtkFileChooserWidget
is a widget for choosing files.
It exposes the iface@Gtk.FileChooser interface, and you should use the methods of this interface to interact with the widget.
Shortcuts and Gestures
GtkFileChooserWidget
supports the following keyboard shortcuts:
Shift+F10 or Menu opens the context menu.
The following signals have default keybindings:
signal@Gtk.FileChooserWidget::desktop-folder
signal@Gtk.FileChooserWidget::down-folder
signal@Gtk.FileChooserWidget::home-folder
signal@Gtk.FileChooserWidget::location-popup
signal@Gtk.FileChooserWidget::location-popup-on-paste
signal@Gtk.FileChooserWidget::location-toggle-popup
signal@Gtk.FileChooserWidget::places-shortcut
signal@Gtk.FileChooserWidget::quick-bookmark
signal@Gtk.FileChooserWidget::recent-shortcut
signal@Gtk.FileChooserWidget::search-shortcut
signal@Gtk.FileChooserWidget::show-hidden
signal@Gtk.FileChooserWidget::up-folder
CSS nodes
GtkFileChooserWidget
has a single CSS node with name filechooser.
Skipped during bindings generation
method
search-mode
: Property has no getter nor settermethod
show-time
: Property has no getter nor settermethod
subtitle
: Property has no getter nor setter
Constructors
Properties
The accessible role of the given GtkAccessible
implementation.
The type of operation that the file chooser is performing.
Whether a file chooser not in %GTK_FILE_CHOOSER_ACTION_OPEN mode will offer the user to create new folders.
A list of css classes applied to this widget.
Whether the widget should grab focus when it is clicked with the mouse.
Enables or disables the emission of the ::query-tooltip signal on @widget.
Whether to use the hexpand
property.
The GtkLayoutManager
instance to use to compute the preferred size of the widget, and allocate its children.
Margin on bottom side of widget.
Margin on start of widget, horizontally.
Whether the widget will receive the default action when it is focused.
The scale factor of the widget.
Whether to allow multiple files to be selected.
A GListModel
containing the shortcut folders that have been added with gtk_file_chooser_add_shortcut_folder().
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
Sets the text of tooltip to be the given string.
Whether to use the vexpand
property.
Functions
Enable or disable an action installed with gtk_widget_class_install_action().
Looks up the action in the action groups associated with
Activates the default.activate
action from @widget.
For widgets that can be “activated” (buttons, menu items, etc.), this function activates them.
Adds @controller to @widget so that it will receive events.
Adds a style class to @widget.
Adds @filter to the list of filters that the user can select between.
Adds a widget to the list of mnemonic labels for this widget.
Adds a folder to be displayed with the shortcut folders in a file chooser.
Queues an animation frame update and adds a callback to be called before each frame.
This function is only used by GtkWidget
subclasses, to assign a size, position and (optionally) baseline to their child widgets.
Requests the user's screen reader to announce the given message.
Called by widgets as the user moves around the window using keyboard shortcuts.
Computes the bounds for @widget in the coordinate space of @target.
Computes whether a container should give this widget extra space when possible.
Translates the given @point in @widget's coordinates to coordinates relative to @target’s coordinate system.
Computes a matrix suitable to describe a transformation from
Creates a new PangoContext
with the appropriate font map, font options, font description, and base direction for drawing text for this widget.
Creates a new PangoLayout
with the appropriate font map, font description, and base direction for drawing text for this widget.
Clears the template children for the given widget.
Checks to see if a drag movement has passed the GTK drag threshold.
Emits the "desktop-folder" signal. See onDesktopFolder.
Emits the "destroy" signal. See onDestroy.
Emits the "direction-changed" signal. See onDirectionChanged.
Emits the "down-folder" signal. See onDownFolder.
Emits the "home-folder" signal. See onHomeFolder.
Emits the "location-popup" signal. See onLocationPopup.
Emits the "location-popup-on-paste" signal. See onLocationPopupOnPaste.
Emits the "location-toggle-popup" signal. See onLocationTogglePopup.
Emits the "move-focus" signal. See onMoveFocus.
Emits the "places-shortcut" signal. See onPlacesShortcut.
Emits the "quick-bookmark" signal. See onQuickBookmark.
Emits the "realize" signal. See onRealize.
Emits the "recent-shortcut" signal. See onRecentShortcut.
Emits the "search-shortcut" signal. See onSearchShortcut.
Emits the "show-hidden" signal. See onShowHidden.
Emits the "state-flags-changed" signal. See onStateFlagsChanged.
Emits the "unrealize" signal. See onUnrealize.
Emits the "up-folder" signal. See onUpFolder.
Retrieves the accessible parent for an accessible object.
Retrieves the accessible role of an accessible object.
Gets the type of operation that the file chooser is performing.
Returns the baseline that has currently been allocated to @widget.
Returns the height that has currently been allocated to @widget.
Returns the width that has currently been allocated to @widget.
Retrieves the widget’s allocation.
Gets the first ancestor of @widget with type @widget_type.
Retrieves the accessible implementation for the given GtkAccessible
.
Returns the baseline that has currently been allocated to @widget.
Gets the ID of the @buildable object.
Gets the value set with gtk_widget_set_child_visible().
Gets the clipboard object for @widget.
Gets whether file chooser will offer to create new folders.
Gets the current folder of @chooser as GFile
.
Gets the current name in the file selector, as entered by the user.
Gets the reading direction for a particular widget.
Get the GdkDisplay
for the toplevel window associated with this widget.
Gets the current filter.
Gets the current set of user-selectable filters, as a list model.
Retrieves the first accessible child of an accessible object.
Returns the widget’s first child.
Returns the current focus child of @widget.
Gets the font map of @widget.
Returns the cairo_font_options_t
of widget.
Obtains the frame clock for a widget.
Returns the widget’s last child.
Retrieves the next accessible sibling of an accessible object
Returns the widget’s next sibling.
Gets a PangoContext
with the appropriate font map, font description, and base direction for this widget.
Query a platform state, such as focus.
Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management.
Returns the widget’s previous sibling.
Gets the primary clipboard of @widget.
Determines whether @widget is realized.
Gets whether the widget prefers a height-for-width layout or a width-for-height layout.
Gets whether multiple files can be selected in the file chooser.
Returns the widget’s sensitivity.
Gets the settings object holding the settings used for this widget.
Queries the list of shortcut folders in the file chooser.
Returns the content width or height of the widget.
Returns the widget state as a flag set.
Returns the style context associated to @widget.
Fetch an object build from the template XML for @widget_type in this @widget instance.
Determines whether the widget is visible.
Returns whether @css_class is currently applied to @widget.
Determines whether @widget is the current default widget within its toplevel.
Determines if the widget should show a visible indication that it has the global input focus.
Returns whether the widget is currently being destroyed.
Creates and initializes child widgets defined in templates.
Inserts @group into @widget.
Inserts @widget into the child widget list of @parent.
Inserts @widget into the child widget list of @parent.
Determines whether @widget is somewhere inside @ancestor, possibly with intermediate containers.
Determines whether @widget can be drawn to.
Returns the widget’s effective sensitivity.
Emits the ::keynav-failed
signal on the widget.
Returns the widgets for which this widget is the target of a mnemonic.
Emits the ::mnemonic-activate signal.
Returns a GListModel
to track the children of @widget.
Returns a GListModel
to track the class@Gtk.EventControllers of @widget.
Emitted when the user asks for it.
Emitted when the text direction of a widget changes.
Emitted when the user asks for it.
Emitted when the user asks for it.
Emitted if keyboard navigation fails.
Emitted when the user asks for it.
Emitted when the user asks for it.
Emitted when the user asks for it.
Emitted when a widget is activated via a mnemonic.
Emitted when the focus is moved.
Emitted when the user asks for it.
Emitted when the widget’s tooltip is about to be shown.
Emitted when the user asks for it.
Emitted when the user asks for it.
Emitted when the user asks for it.
Emitted when the user asks for it.
Emitted when the widget state changes.
Emitted when the GdkSurface
associated with @widget is destroyed.
Emitted when the user asks for it.
Flags the widget for a rerun of the vfunc@Gtk.Widget.size_allocate function.
Flags a widget to have its size renegotiated.
Removes a 'choice' that has been added with gtk_file_chooser_add_choice().
Removes @controller from @widget, so that it doesn't process events anymore.
Removes a style from @widget.
Removes @filter from the list of filters that the user can select between.
Removes a widget from the list of mnemonic labels for this widget.
Removes a folder from the shortcut folders in a file chooser.
Removes a tick callback previously registered with gtk_widget_add_tick_callback().
Resets the accessible @property to its default value.
Resets the accessible @relation to its default value.
Resets the accessible @state to its default value.
Sets the parent and sibling of an accessible object.
Sets the type of operation that the chooser is performing.
Sets whether @widget should be mapped along with its parent.
Sets whether file chooser will offer to create new folders.
Sets the current folder for @chooser from a GFile
.
Sets the current name in the file selector, as if entered by the user.
Sets a named cursor to be shown when pointer devices point towards @widget.
Sets the reading direction on a particular widget.
Sets the current filter.
Set @child as the current focus child of @widget.
Sets the font map to use for Pango rendering.
Sets the cairo_font_options_t
used for Pango rendering in this widget.
Set all margins to the same value.
Set start and end margin to horizontal and top and bottom margin to vertical
Set margins.
Sets whether multiple files can be selected in the file chooser.
Sets the sensitivity of a widget.
Sets the minimum size of a widget.
Turns on flag values in the current widget state.
Sets the visibility state of @widget.
Returns whether @widget should contribute to the measuring and allocation of its parent.
Allocates widget with a transformation that translates the origin to the position in @allocation.
Snapshot the a child of @widget.
Triggers a tooltip query on the display where the toplevel of @widget is located.
Turns off flag values for the current widget state.
Updates the next accessible sibling of @self.