FileChooserDialog
GtkFileChooserDialog is a dialog suitable for use with “File Open” or “File Save” commands.
This widget works by putting a class@Gtk.FileChooserWidget inside a class@Gtk.Dialog. It exposes the iface@Gtk.FileChooser interface, so you can use all of the iface@Gtk.FileChooser functions on the file chooser dialog as well as those for class@Gtk.Dialog.
Note that GtkFileChooserDialog does not have any methods of its own. Instead, you should use the functions that work on a iface@Gtk.FileChooser.
If you want to integrate well with the platform you should use the class@Gtk.FileChooserNative API, which will use a platform-specific dialog if available and fall back to GtkFileChooserDialog otherwise.
Typical usage
In the simplest of cases, you can the following code to use GtkFileChooserDialog to select a file for opening:
static void
on_open_response (GtkDialog *dialog,
int response)
{
if (response == GTK_RESPONSE_ACCEPT)
{
GtkFileChooser *chooser = GTK_FILE_CHOOSER (dialog);
g_autoptr(GFile) file = gtk_file_chooser_get_file (chooser);
open_file (file);
}
gtk_window_destroy (GTK_WINDOW (dialog));
}
// ...
GtkWidget *dialog;
GtkFileChooserAction action = GTK_FILE_CHOOSER_ACTION_OPEN;
dialog = gtk_file_chooser_dialog_new ("Open File",
parent_window,
action,
_("_Cancel"),
GTK_RESPONSE_CANCEL,
_("_Open"),
GTK_RESPONSE_ACCEPT,
NULL);
gtk_window_present (GTK_WINDOW (dialog));
g_signal_connect (dialog, "response",
G_CALLBACK (on_open_response),
NULL);To use a dialog for saving, you can use this:
static void
on_save_response (GtkDialog *dialog,
int response)
{
if (response == GTK_RESPONSE_ACCEPT)
{
GtkFileChooser *chooser = GTK_FILE_CHOOSER (dialog);
g_autoptr(GFile) file = gtk_file_chooser_get_file (chooser);
save_to_file (file);
}
gtk_window_destroy (GTK_WINDOW (dialog));
}
// ...
GtkWidget *dialog;
GtkFileChooser *chooser;
GtkFileChooserAction action = GTK_FILE_CHOOSER_ACTION_SAVE;
dialog = gtk_file_chooser_dialog_new ("Save File",
parent_window,
action,
_("_Cancel"),
GTK_RESPONSE_CANCEL,
_("_Save"),
GTK_RESPONSE_ACCEPT,
NULL);
chooser = GTK_FILE_CHOOSER (dialog);
if (user_edited_a_new_document)
gtk_file_chooser_set_current_name (chooser, _("Untitled document"));
else
gtk_file_chooser_set_file (chooser, existing_filename);
gtk_window_present (GTK_WINDOW (dialog));
g_signal_connect (dialog, "response",
G_CALLBACK (on_save_response),
NULL);Setting up a file chooser dialog
There are various cases in which you may need to use a GtkFileChooserDialog:
To select a file for opening, use %GTK_FILE_CHOOSER_ACTION_OPEN.
To save a file for the first time, use %GTK_FILE_CHOOSER_ACTION_SAVE, and suggest a name such as “Untitled” with method@Gtk.FileChooser.set_current_name.
To save a file under a different name, use %GTK_FILE_CHOOSER_ACTION_SAVE, and set the existing file with method@Gtk.FileChooser.set_file.
To choose a folder instead of a filem use %GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER.
In general, you should only cause the file chooser to show a specific folder when it is appropriate to use method@Gtk.FileChooser.set_file, i.e. when you are doing a “Save As” command and you already have a file saved somewhere.
Response Codes
GtkFileChooserDialog inherits from class@Gtk.Dialog, so buttons that go in its action area have response codes such as %GTK_RESPONSE_ACCEPT and %GTK_RESPONSE_CANCEL. For example, you could call ctor@Gtk.FileChooserDialog.new as follows:
GtkWidget *dialog;
GtkFileChooserAction action = GTK_FILE_CHOOSER_ACTION_OPEN;
dialog = gtk_file_chooser_dialog_new ("Open File",
parent_window,
action,
_("_Cancel"),
GTK_RESPONSE_CANCEL,
_("_Open"),
GTK_RESPONSE_ACCEPT,
NULL);This will create buttons for “Cancel” and “Open” that use predefined response identifiers from enum@Gtk.ResponseType. For most dialog boxes you can use your own custom response codes rather than the ones in enum@Gtk.ResponseType, but GtkFileChooserDialog assumes that its “accept”-type action, e.g. an “Open” or “Save” button, will have one of the following response codes:
%GTK_RESPONSE_ACCEPT
%GTK_RESPONSE_OK
%GTK_RESPONSE_YES
%GTK_RESPONSE_APPLY
This is because GtkFileChooserDialog must intercept responses and switch to folders if appropriate, rather than letting the dialog terminate — the implementation uses these known response codes to know which responses can be blocked if appropriate.
To summarize, make sure you use a predefined response code when you use GtkFileChooserDialog to ensure proper operation.
CSS nodes
GtkFileChooserDialog has a single CSS node with the name window and style class .filechooser.
Skipped during bindings generation
constructor
new: Varargs parameter is not supported
Constructors
Properties
The accessible role of the given GtkAccessible implementation.
The type of operation that the file chooser is performing.
The GtkApplication associated with the window.
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.
The default widget.
If this window should be destroyed when the parent is destroyed.
Whether the widget should grab focus when it is clicked with the mouse.
Whether 'focus rectangles' are currently visible in this window.
The focus widget.
Whether the window frame should handle F10 for activating menubars.
Enables or disables the emission of the ::query-tooltip signal on @widget.
Whether to use the hexpand property.
If this window should be hidden when the users clicks the close button.
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 mnemonics are currently visible in this window.
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.
The transient parent of the window.
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 an activatable widget to the action area of a GtkDialog.
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
Emitted when the user activates the default widget of @window.
Emitted when the user activates the currently focused widget of @window.
Emitted when the user uses a keybinding to close the dialog.
Emitted when the user clicks on the close button of the window.
Signals that all holders of a reference to the widget should release the reference that they hold.
Emitted when the text direction of a widget changes.
Emitted when the user enables or disables interactive debugging.
Emitted when @widget is hidden.
Emitted if keyboard navigation fails.
emitted when the set of accelerators or mnemonics that are associated with @window changes.
Emitted when @widget is going to be mapped.
Emitted when a widget is activated via a mnemonic.
Emitted when the focus is moved.
Emitted when the widget’s tooltip is about to be shown.
Emitted when @widget is associated with a GdkSurface.
Emitted when an action widget is clicked.
Emitted when @widget is shown.
Emitted when the widget state changes.
Emitted when @widget is going to be unmapped.
Emitted when the GdkSurface associated with @widget is destroyed.
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.
Asks to place @window in the fullscreen state.
Asks to place @window in the fullscreen state on the given @monitor.
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.
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.
Returns the content area of @dialog.
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.
Obtains the frame clock for a widget.
Returns the group for @window.
Returns the header bar of @dialog.
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.
Returns the renderer that is used for this GtkNative.
Gets whether the widget prefers a height-for-width layout or a width-for-height layout.
Gets the response id of a widget in the action area of a dialog.
Returns the display that this GtkRoot is on.
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.
Returns the surface of this GtkNative.
Fetch an object build from the template XML for @widget_type in this @widget instance.
Determines whether the widget is visible.
Gets the widget button that uses the given response ID in the action area of a dialog.
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.
Retrieves the current fullscreen state of @window.
Retrieves the current maximized state of @window.
Returns the widget’s effective sensitivity.
Retrieves the current suspended state of @window.
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.
Realizes a GtkNative.
Unrealizes a GtkNative.
Returns a GListModel to track the children of @widget.
Returns a GListModel to track the class@Gtk.EventControllers of @widget.
Presents a window to the user in response to an user interaction.
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 default widget for the dialog based on the response ID.
Sets the default size of a window.
Sets the reading direction on a particular widget.
Sets the GdkDisplay where the @window is displayed.
Sets the current filter.
Set @child as the current focus child of @widget.
Sets the font map to use for Pango rendering.
Set all margins to the same value.
Set start and end margin to horizontal and top and bottom margin to vertical
Set margins.
A convenient way to sensitize/desensitize dialog buttons.
Sets whether multiple files can be selected in the file chooser.
Sets the sensitivity of a widget.
Sets the minimum size of a widget.
Sets the startup notification ID.
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.
Triggers a tooltip query on the display where the toplevel of @widget is located.
Asks to remove the fullscreen state for @window, and return to its previous state.
Asks to unmaximize @window.
Asks to unminimize the specified @window.
Turns off flag values for the current widget state.
Updates the next accessible sibling of @self.