Class

GtkFileChooserWidget

Description [src]

final class Gtk.FileChooserWidget : Gtk.Widget {
  /* No available fields */
}

GtkFileChooserWidget is a widget for choosing files.

It exposes the GtkFileChooser 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.

Hierarchy

hierarchy this GtkFileChooserWidget implements_0 GtkAccessible this--implements_0 implements_1 GtkBuildable this--implements_1 implements_2 GtkConstraintTarget this--implements_2 implements_3 GtkFileChooser this--implements_3 ancestor_0 GtkWidget ancestor_0--this ancestor_1 GInitiallyUnowned ancestor_1--ancestor_0 ancestor_2 GObject ancestor_2--ancestor_1

Constructors

gtk_file_chooser_widget_new

Creates a new GtkFileChooserWidget.

Instance methods

Methods inherited from GtkWidget (159)
gtk_widget_action_set_enabled

Enable or disable an action installed with gtk_widget_class_install_action().

gtk_widget_activate

For widgets that can be “activated” (buttons, menu items, etc.), this function activates them.

gtk_widget_activate_action

Looks up the action in the action groups associated with widget and its ancestors, and activates it.

gtk_widget_activate_action_variant

Looks up the action in the action groups associated with widget and its ancestors, and activates it.

gtk_widget_activate_default

Activates the default.activate action from widget.

gtk_widget_add_controller

Adds controller to widget so that it will receive events.

gtk_widget_add_css_class

Adds a style class to widget.

gtk_widget_add_mnemonic_label

Adds a widget to the list of mnemonic labels for this widget.

gtk_widget_add_tick_callback

Queues an animation frame update and adds a callback to be called before each frame.

gtk_widget_allocate

This function is only used by GtkWidget subclasses, to assign a size, position and (optionally) baseline to their child widgets.

gtk_widget_child_focus

Called by widgets as the user moves around the window using keyboard shortcuts.

gtk_widget_compute_bounds

Computes the bounds for widget in the coordinate space of target.

gtk_widget_compute_expand

Computes whether a container should give this widget extra space when possible.

gtk_widget_compute_point

Translates the given point in widgets coordinates to coordinates relative to target’s coordinate system.

gtk_widget_compute_transform

Computes a matrix suitable to describe a transformation from widgets coordinate system into targets coordinate system.

gtk_widget_contains

Tests if the point at (x, y) is contained in widget.

gtk_widget_create_pango_context

Creates a new PangoContext with the appropriate font map, font options, font description, and base direction for drawing text for this widget.

gtk_widget_create_pango_layout

Creates a new PangoLayout with the appropriate font map, font description, and base direction for drawing text for this widget.

gtk_drag_check_threshold

Checks to see if a drag movement has passed the GTK drag threshold.

gtk_widget_error_bell

Notifies the user about an input-related error on this widget.

gtk_widget_get_allocated_baseline

Returns the baseline that has currently been allocated to widget.

gtk_widget_get_allocated_height

Returns the height that has currently been allocated to widget.

gtk_widget_get_allocated_width

Returns the width that has currently been allocated to widget.

Methods inherited from GObject (42)
Methods inherited from GtkAccessible (10)
gtk_accessible_get_accessible_role

Retrieves the GtkAccessibleRole for the given GtkAccessible.

gtk_accessible_reset_property

Resets the accessible property to its default value.

gtk_accessible_reset_relation

Resets the accessible relation to its default value.

gtk_accessible_reset_state

Resets the accessible state to its default value.

gtk_accessible_update_property

Updates a list of accessible properties.

gtk_accessible_update_property_value

Updates an array of accessible properties.

gtk_accessible_update_relation

Updates a list of accessible relations.

gtk_accessible_update_relation_value

Updates an array of accessible relations.

gtk_accessible_update_state

Updates a list of accessible states. See the GtkAccessibleState documentation for the value types of accessible states.

gtk_accessible_update_state_value

Updates an array of accessible states.

Methods inherited from GtkBuildable (1)
gtk_buildable_get_buildable_id

Gets the ID of the buildable object.

Methods inherited from GtkFileChooser (25)
gtk_file_chooser_add_choice

Adds a ‘choice’ to the file chooser.

gtk_file_chooser_add_filter

Adds filter to the list of filters that the user can select between.

gtk_file_chooser_add_shortcut_folder

Adds a folder to be displayed with the shortcut folders in a file chooser.

gtk_file_chooser_get_action

Gets the type of operation that the file chooser is performing.

gtk_file_chooser_get_choice

Gets the currently selected option in the ‘choice’ with the given ID.

gtk_file_chooser_get_create_folders

Gets whether file chooser will offer to create new folders.

gtk_file_chooser_get_current_folder

Gets the current folder of chooser as GFile.

gtk_file_chooser_get_current_name

Gets the current name in the file selector, as entered by the user.

gtk_file_chooser_get_file

Gets the GFile for the currently selected file in the file selector.

gtk_file_chooser_get_files

Lists all the selected files and subfolders in the current folder of chooser as GFile.

gtk_file_chooser_get_filter

Gets the current filter.

gtk_file_chooser_get_filters

Gets the current set of user-selectable filters, as a list model.

gtk_file_chooser_get_select_multiple

Gets whether multiple files can be selected in the file chooser.

gtk_file_chooser_get_shortcut_folders

Queries the list of shortcut folders in the file chooser.

gtk_file_chooser_remove_choice

Removes a ‘choice’ that has been added with gtk_file_chooser_add_choice().

gtk_file_chooser_remove_filter

Removes filter from the list of filters that the user can select between.

gtk_file_chooser_remove_shortcut_folder

Removes a folder from the shortcut folders in a file chooser.

gtk_file_chooser_set_action

Sets the type of operation that the chooser is performing.

gtk_file_chooser_set_choice

Selects an option in a ‘choice’ that has been added with gtk_file_chooser_add_choice().

gtk_file_chooser_set_create_folders

Sets whether file chooser will offer to create new folders.

gtk_file_chooser_set_current_folder

Sets the current folder for chooser from a GFile.

gtk_file_chooser_set_current_name

Sets the current name in the file selector, as if entered by the user.

gtk_file_chooser_set_file

Sets file as the current filename for the file chooser.

Properties

Gtk.FileChooserWidget:search-mode
No description available.
Gtk.FileChooserWidget:subtitle
No description available.
Properties inherited from GtkWidget (34)
Gtk.Widget:can-focus

Whether the widget or any of its descendents can accept the input focus.

Gtk.Widget:can-target

Whether the widget can receive pointer events.

Gtk.Widget:css-classes

A list of css classes applied to this widget.

Gtk.Widget:css-name

The name of this widget in the CSS tree.

Gtk.Widget:cursor

The cursor used by widget.

Gtk.Widget:focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

Gtk.Widget:focusable

Whether this widget itself will accept the input focus.

Gtk.Widget:halign

How to distribute horizontal space if widget gets extra space.

Gtk.Widget:has-default

Whether the widget is the default widget.

Gtk.Widget:has-focus

Whether the widget has the input focus.

Gtk.Widget:has-tooltip

Enables or disables the emission of the ::query-tooltip signal on widget.

Gtk.Widget:height-request

Override for height request of the widget.

Gtk.Widget:hexpand

Whether to expand horizontally.

Gtk.Widget:hexpand-set

Whether to use the hexpand property.

Gtk.Widget:layout-manager

The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

Gtk.Widget:margin-bottom

Margin on bottom side of widget.

Gtk.Widget:margin-end

Margin on end of widget, horizontally.

Gtk.Widget:margin-start

Margin on start of widget, horizontally.

Gtk.Widget:margin-top

Margin on top side of widget.

Gtk.Widget:name

The name of the widget.

Gtk.Widget:opacity

The requested opacity of the widget.

Gtk.Widget:overflow

How content outside the widget’s content area is treated.

Gtk.Widget:parent

The parent widget of this widget.

Gtk.Widget:receives-default

Whether the widget will receive the default action when it is focused.

Gtk.Widget:root

The GtkRoot widget of the widget tree containing this widget.

Gtk.Widget:scale-factor

The scale factor of the widget.

Gtk.Widget:sensitive

Whether the widget responds to input.

Gtk.Widget:tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Gtk.Widget:tooltip-text

Sets the text of tooltip to be the given string.

Gtk.Widget:valign

How to distribute vertical space if widget gets extra space.

Gtk.Widget:vexpand

Whether to expand vertically.

Gtk.Widget:vexpand-set

Whether to use the vexpand property.

Gtk.Widget:visible

Whether the widget is visible.

Gtk.Widget:width-request

Override for width request of the widget.

Properties inherited from GtkAccessible (1)
Gtk.Accessible:accessible-role

The accessible role of the given GtkAccessible implementation.

Properties inherited from GtkFileChooser (6)
Gtk.FileChooser:action

The type of operation that the file chooser is performing.

Gtk.FileChooser:create-folders

Whether a file chooser not in GTK_FILE_CHOOSER_ACTION_OPEN mode will offer the user to create new folders.

Gtk.FileChooser:filter

The current filter for selecting files that are displayed.

Gtk.FileChooser:filters

A GListModel containing the filters that have been added with gtk_file_chooser_add_filter().

Gtk.FileChooser:select-multiple

Whether to allow multiple files to be selected.

Gtk.FileChooser:shortcut-folders

A GListModel containing the shortcut folders that have been added with gtk_file_chooser_add_shortcut_folder().

Signals

Gtk.FileChooserWidget::desktop-folder

Emitted when the user asks for it.

Gtk.FileChooserWidget::down-folder

Emitted when the user asks for it.

Gtk.FileChooserWidget::home-folder

Emitted when the user asks for it.

Gtk.FileChooserWidget::location-popup

Emitted when the user asks for it.

Gtk.FileChooserWidget::location-popup-on-paste

Emitted when the user asks for it.

Gtk.FileChooserWidget::location-toggle-popup

Emitted when the user asks for it.

Gtk.FileChooserWidget::places-shortcut

Emitted when the user asks for it.

Gtk.FileChooserWidget::quick-bookmark

Emitted when the user asks for it.

Gtk.FileChooserWidget::recent-shortcut

Emitted when the user asks for it.

Gtk.FileChooserWidget::search-shortcut

Emitted when the user asks for it.

Gtk.FileChooserWidget::show-hidden

Emitted when the user asks for it.

Gtk.FileChooserWidget::up-folder

Emitted when the user asks for it.

Signals inherited from GtkWidget (13)
Gtk.Widget::destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

Gtk.Widget::direction-changed

Emitted when the text direction of a widget changes.

Gtk.Widget::hide

Emitted when widget is hidden.

Gtk.Widget::keynav-failed

Emitted if keyboard navigation fails.

Gtk.Widget::map

Emitted when widget is going to be mapped.

Gtk.Widget::mnemonic-activate

Emitted when a widget is activated via a mnemonic.

Gtk.Widget::move-focus

Emitted when the focus is moved.

Gtk.Widget::query-tooltip

Emitted when the widgets tooltip is about to be shown.

Gtk.Widget::realize

Emitted when widget is associated with a GdkSurface.

Gtk.Widget::show

Emitted when widget is shown.

Gtk.Widget::state-flags-changed

Emitted when the widget state changes.

Gtk.Widget::unmap

Emitted when widget is going to be unmapped.

Gtk.Widget::unrealize

Emitted when the GdkSurface associated with widget is destroyed.

Signals inherited from GObject (1)