Optionalproperties: Partial<Gtk.FileChooserNative.ConstructorProps>Internal$signalsCompile-time signal type information.
This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.
Static$gtypeThe text used for the label on the accept button in the dialog, or
null to use the default text.
The text used for the label on the accept button in the dialog, or
null to use the default text.
The text used for the label on the cancel button in the dialog, or
null to use the default text.
The text used for the label on the cancel button in the dialog, or
null to use the default text.
Whether a file chooser not in Gtk.FileChooserAction.OPEN mode will offer the user to create new folders.
Whether a file chooser not in Gtk.FileChooserAction.OPEN mode will offer the user to create new folders.
Whether a file chooser not in Gtk.FileChooserAction.OPEN mode will offer the user to create new folders.
Whether a file chooser not in Gtk.FileChooserAction.OPEN mode will offer the user to create new folders.
Whether a file chooser in Gtk.FileChooserAction.SAVE mode will present an overwrite confirmation dialog if the user selects a file name that already exists.
Whether a file chooser in Gtk.FileChooserAction.SAVE mode will present an overwrite confirmation dialog if the user selects a file name that already exists.
Whether a file chooser in Gtk.FileChooserAction.SAVE mode will present an overwrite confirmation dialog if the user selects a file name that already exists.
Whether a file chooser in Gtk.FileChooserAction.SAVE mode will present an overwrite confirmation dialog if the user selects a file name that already exists.
Adds a 'choice' to the file chooser. This is typically implemented
as a combobox or, for boolean choices, as a checkbutton. You can select
a value using gtk_file_chooser_set_choice() before the dialog is shown,
and you can obtain the user-selected value in the ::response signal handler
using gtk_file_chooser_get_choice().
Compare gtk_file_chooser_set_extra_widget().
id for the added choice
user-visible label for the added choice
Optionaloptions: string[]ids for the options of the choice, or null for a boolean choice
Optionaloption_labels: string[]user-visible labels for the options, must be the same length as options
Adds filter to the list of filters that the user can select between.
When a filter is selected, only files that are passed by that
filter are displayed.
Note that the chooser takes ownership of the filter, so you have to
ref and sink it if you want to keep a reference.
Adds a folder to be displayed with the shortcut folders in a file chooser. Note that shortcut folders do not get saved, as they are provided by the application. For example, you can use this to add a “/usr/share/mydrawprogram/Clipart” folder to the volume list.
filename of the folder to add
true if the folder could be added successfully, false otherwise. In the latter case, the error will be set as appropriate.
Adds a folder URI to be displayed with the shortcut folders in a file chooser. Note that shortcut folders do not get saved, as they are provided by the application. For example, you can use this to add a “file:///usr/share/mydrawprogram/Clipart” folder to the volume list.
URI of the folder to add
true if the folder could be added successfully, false otherwise. In the latter case, the error will be set as appropriate.
Creates a binding between source_property on source and target_property
on target.
Whenever the source_property is changed the target_property is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
GObject.Binding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A GObject.Object can have multiple bindings.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Complete version of g_object_bind_property().
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well. The transform_from function is only used in case
of bidirectional bindings, otherwise it will be ignored
The binding will automatically be removed when either the source or the
target instances are finalized. This will release the reference that is
being held on the GObject.Binding instance; if you want to hold on to the
GObject.Binding instance, you will need to hold a reference to it.
To remove the binding, call g_binding_unbind().
A GObject.Object can have multiple bindings.
The same user_data parameter will be used for both transform_to
and transform_from transformation functions; the notify function will
be called once, when the binding is removed. If you need different data
for each transformation function, please use
g_object_bind_property_with_closures() instead.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
Optionaltransform_to: BindingTransformFuncthe transformation function from the source to the target, or null to use the default
Optionaltransform_from: BindingTransformFuncthe transformation function from the target to the source, or null to use the default
Optionalnotify: DestroyNotifya function to call when disposing the binding, to free resources used by the transformation functions, or null if not required
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of
g_object_bind_property_full(), using GClosures instead of
function pointers.
the property on source to bind
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Blocks a handler of an instance so it will not be called during any signal emissions
Handler ID of the handler to be blocked
SignalconnectSignalconnect_Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
Handler ID of the handler to be disconnected
SignalemitThis function is intended for GObject.Object implementations to re-enforce
a [floating][floating-ref] object reference. Doing this is seldom
required: all GInitiallyUnowneds are created with a floating reference
which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object. If the freeze count is
non-zero, the emission of "notify" signals on object is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
GObject.Object::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Retrieves the custom label text for the accept button.
The custom label, or null for the default. This string is owned by GTK+ and should not be modified or freed
Gets the type of operation that the file chooser is performing; see
gtk_file_chooser_set_action().
the action that the file selector is performing
Retrieves the custom label text for the cancel button.
The custom label, or null for the default. This string is owned by GTK+ and should not be modified or freed
Gets the currently selected option in the 'choice' with the given ID.
the ID of the choice to get
the ID of the currenly selected option
Gets whether file choser will offer to create new folders.
See gtk_file_chooser_set_create_folders().
true if the Create Folder button should be displayed.
Gets the current folder of chooser as a local filename.
See gtk_file_chooser_set_current_folder().
Note that this is the folder that the file chooser is currently displaying
(e.g. "/home/username/Documents"), which is not the same
as the currently-selected folder if the chooser is in
Gtk.FileChooserAction.SELECT_FOLDER mode
(e.g. "/home/username/Documents/selected-folder/". To get the
currently-selected folder in that mode, use gtk_file_chooser_get_uri() as the
usual way to get the selection.
the full path of the current folder, or null if the current path cannot be represented as a local filename. Free with g_free(). This function will also return null if the file chooser was unable to load the last folder that was requested from it; for example, as would be for calling gtk_file_chooser_set_current_folder() on a nonexistent folder.
Gets the current folder of chooser as an URI.
See gtk_file_chooser_set_current_folder_uri().
Note that this is the folder that the file chooser is currently displaying
(e.g. "file:///home/username/Documents"), which is not the same
as the currently-selected folder if the chooser is in
Gtk.FileChooserAction.SELECT_FOLDER mode
(e.g. "file:///home/username/Documents/selected-folder/". To get the
currently-selected folder in that mode, use gtk_file_chooser_get_uri() as the
usual way to get the selection.
the URI for the current folder. Free with g_free(). This function will also return null if the file chooser was unable to load the last folder that was requested from it; for example, as would be for calling gtk_file_chooser_set_current_folder_uri() on a nonexistent folder.
Gets the current name in the file selector, as entered by the user in the text entry for “Name”.
This is meant to be used in save dialogs, to get the currently typed filename when the file itself does not exist yet. For example, an application that adds a custom extra widget to the file chooser for “file format” may want to change the extension of the typed filename based on the chosen format, say, from “.jpg” to “.png”.
The raw text from the file chooser’s “Name” entry. Free this with g_free(). Note that this string is not a full pathname or URI; it is whatever the contents of the entry are. Note also that this string is in UTF-8 encoding, which is not necessarily the system’s encoding for filenames.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
the data if found, or null if no such data exists.
Queries whether a file chooser is set to confirm for overwriting when the user types a file name that already exists.
true if the file chooser will present a confirmation dialog; false otherwise.
Gets the Gio.File for the currently selected file in the file selector. If multiple files are selected, one of the files will be returned at random.
If the file chooser is in folder mode, this function returns the selected folder.
a selected Gio.File. You own the returned file; use g_object_unref() to release it.
Gets the filename for the currently selected file in the file selector. The filename is returned as an absolute path. If multiple files are selected, one of the filenames will be returned at random.
If the file chooser is in folder mode, this function returns the selected folder.
The currently selected filename, or null if no file is selected, or the selected file can't be represented with a local filename. Free with g_free().
Lists all the selected files and subfolders in the current folder of
chooser. The returned names are full absolute paths. If files in the current
folder cannot be represented as local filenames they will be ignored. (See
gtk_file_chooser_get_uris())
a GLib.SList containing the filenames of all selected files and subfolders in the current folder. Free the returned list with g_slist_free(), and the filenames with g_free().
Lists all the selected files and subfolders in the current folder of chooser
as Gio.File. An internal function, see gtk_file_chooser_get_uris().
a GLib.SList containing a Gio.File for each selected file and subfolder in the current folder. Free the returned list with g_slist_free(), and the files with g_object_unref().
Gets the current filter; see gtk_file_chooser_set_filter().
the current filter, or null
Gets whether only local files can be selected in the
file selector. See gtk_file_chooser_set_local_only()
true if only local files can be selected.
Gets the filename that should be previewed in a custom preview
widget. See gtk_file_chooser_set_preview_widget().
the filename to preview, or null if no file is selected, or if the selected file cannot be represented as a local filename. Free with g_free()
Gets the URI that should be previewed in a custom preview
widget. See gtk_file_chooser_set_preview_widget().
the URI for the file to preview, or null if no file is selected. Free with g_free().
Gets whether the preview widget set by gtk_file_chooser_set_preview_widget()
should be shown for the current filename. See
gtk_file_chooser_set_preview_widget_active().
true if the preview widget is active for the current filename.
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
The name of the property to get
Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
This function gets back user data pointers stored via
g_object_set_qdata().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Gets whether multiple files can be selected in the file
selector. See gtk_file_chooser_set_select_multiple().
true if multiple files can be selected.
Gets whether hidden files and folders are displayed in the file selector.
See gtk_file_chooser_set_show_hidden().
true if hidden files and folders are displayed.
Gets the URI for the currently selected file in the file selector. If multiple files are selected, one of the filenames will be returned at random.
If the file chooser is in folder mode, this function returns the selected folder.
The currently selected URI, or null if no file is selected. If gtk_file_chooser_set_local_only() is set to true (the default) a local URI will be returned for any FUSE locations. Free with g_free()
Lists all the selected files and subfolders in the current folder of
chooser. The returned names are full absolute URIs.
a GLib.SList containing the URIs of all selected files and subfolders in the current folder. Free the returned list with g_slist_free(), and the filenames with g_free().
Gets whether a stock label should be drawn with the name of the previewed
file. See gtk_file_chooser_set_use_preview_label().
true if the file chooser is set to display a label with the name of the previewed file, false otherwise.
Gets n_properties properties for an object.
Obtained properties will be set to values. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Checks whether object has a [floating][floating-ref] reference.
true if object has a floating reference
Lists the current set of user-selectable filters; see
gtk_file_chooser_add_filter(), gtk_file_chooser_remove_filter().
a GLib.SList containing the current set of user selectable filters. The contents of the list are owned by GTK+, but you must free the list itself with g_slist_free() when you are done with it.
Queries the list of shortcut folders in the file chooser, as set by
gtk_file_chooser_add_shortcut_folder_uri().
A list of folder URIs, or null if there are no shortcut folders. Free the returned list with g_slist_free(), and the URIs with g_free().
Queries the list of shortcut folders in the file chooser, as set by
gtk_file_chooser_add_shortcut_folder().
A list of folder filenames, or null if there are no shortcut folders. Free the returned list with g_slist_free(), and the filenames with g_free().
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
the name of a property installed on the class of object.
Emits a "notify" signal for the property specified by pspec on object.
This function omits the property name lookup, hence it is faster than
g_object_notify().
One way to avoid using g_object_notify() from within the
class that registered the properties, and using g_object_notify_by_pspec()
instead, is to store the GParamSpec used with
g_object_class_install_property() inside a static array, e.g.:
typedef enum
{
PROP_FOO = 1,
PROP_LAST
} MyObjectProperty;
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
0, 100,
50,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the GObject.ParamSpec of a property installed on the class of object.
Increases the reference count of object.
Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type
of object will be propagated to the return type (using the GCC typeof()
extension), so any casting the caller needs to do on the return type must be
explicit.
the same object
Increase the reference count of object, and possibly remove the
[floating][floating-ref] reference, if object has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object will be propagated to the return type
under the same conditions as for g_object_ref().
object
Removes a 'choice' that has been added with gtk_file_chooser_add_choice().
the ID of the choice to remove
Removes filter from the list of filters that the user can select between.
Removes a folder from a file chooser’s list of shortcut folders.
filename of the folder to remove
true if the operation succeeds, false otherwise. In the latter case, the error will be set as appropriate. See also: gtk_file_chooser_add_shortcut_folder()
Removes a folder URI from a file chooser’s list of shortcut folders.
URI of the folder to remove
true if the operation succeeds, false otherwise. In the latter case, the error will be set as appropriate. See also: gtk_file_chooser_add_shortcut_folder_uri()
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Selects all the files in the current folder of a file chooser.
Selects a filename. If the file name isn’t in the current
folder of chooser, then the current folder of chooser will
be changed to the folder containing filename.
the filename to select
Not useful. See also: gtk_file_chooser_set_filename()
Selects the file to by uri. If the URI doesn’t refer to a
file in the current folder of chooser, then the current folder of
chooser will be changed to the folder containing filename.
the URI to select
Not useful.
Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
Object containing the properties to set
Sets the custom label text for the accept button.
If characters in label are preceded by an underscore, they are underlined.
If you need a literal underscore character in a label, use “__” (two
underscores). The first underlined character represents a keyboard
accelerator called a mnemonic.
Pressing Alt and that key activates the button.
Optionalaccept_label: stringcustom label or null for the default
Sets the type of operation that the chooser is performing; the user interface is adapted to suit the selected action. For example, an option to create a new folder might be shown if the action is Gtk.FileChooserAction.SAVE but not if the action is Gtk.FileChooserAction.OPEN.
the action that the file selector is performing
Sets the custom label text for the cancel button.
If characters in label are preceded by an underscore, they are underlined.
If you need a literal underscore character in a label, use “__” (two
underscores). The first underlined character represents a keyboard
accelerator called a mnemonic.
Pressing Alt and that key activates the button.
Optionalcancel_label: stringcustom label or null for the default
Selects an option in a 'choice' that has been added with
gtk_file_chooser_add_choice(). For a boolean choice, the
possible options are "true" and "false".
the ID of the choice to set
the ID of the option to select
Sets whether file choser will offer to create new folders. This is only relevant if the action is not set to be Gtk.FileChooserAction.OPEN.
true if the Create Folder button should be displayed
Sets the current folder for chooser from a local filename.
The user will be shown the full contents of the current folder,
plus user interface elements for navigating to other folders.
In general, you should not use this function. See the [section on setting up a file chooser dialog][gtkfilechooserdialog-setting-up] for the rationale behind this.
the full path of the new current folder
Not useful.
Sets the current folder for chooser from an URI.
The user will be shown the full contents of the current folder,
plus user interface elements for navigating to other folders.
In general, you should not use this function. See the [section on setting up a file chooser dialog][gtkfilechooserdialog-setting-up] for the rationale behind this.
the URI for the new current folder
true if the folder could be changed successfully, false otherwise.
Sets the current name in the file selector, as if entered
by the user. Note that the name passed in here is a UTF-8
string rather than a filename. This function is meant for
such uses as a suggested name in a “Save As...” dialog. You can
pass “Untitled.doc” or a similarly suitable suggestion for the name.
If you want to preselect a particular existing file, you should use
gtk_file_chooser_set_filename() or gtk_file_chooser_set_uri() instead.
Please see the documentation for those functions for an example of using
gtk_file_chooser_set_current_name() as well.
the filename to use, as a UTF-8 string
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key is converted to a GLib.Quark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the GLib.Quark storage growing unbounded.
name of the key
Optionaldata: anydata to associate with that key
Sets whether a file chooser in Gtk.FileChooserAction.SAVE mode will present
a confirmation dialog if the user types a file name that already exists. This
is false by default.
If set to true, the chooser will emit the
Gtk.FileChooser.SignalSignatures.confirm_overwrite | Gtk.FileChooser::confirm-overwrite signal when appropriate.
If all you need is the stock confirmation dialog, set this property to true.
You can override the way confirmation is done by actually handling the
Gtk.FileChooser.SignalSignatures.confirm_overwrite | Gtk.FileChooser::confirm-overwrite signal; please refer to its documentation
for the details.
whether to confirm overwriting in save mode
Sets file as the current filename for the file chooser, by changing
to the file’s parent folder and actually selecting the file in list. If
the chooser is in Gtk.FileChooserAction.SAVE mode, the file’s base name
will also appear in the dialog’s file name entry.
If the file name isn’t in the current folder of chooser, then the current
folder of chooser will be changed to the folder containing filename. This
is equivalent to a sequence of gtk_file_chooser_unselect_all() followed by
gtk_file_chooser_select_filename().
Note that the file must exist, or nothing will be done except for the directory change.
If you are implementing a save dialog, you should use this function if you already have a file name to which the user may save; for example, when the user opens an existing file and then does Save As... If you don’t have a file name already — for example, if the user just created a new file and is saving it for the first time, do not call this function. Instead, use something similar to this:
if (document_is_new)
{
// the user just created a new document
gtk_file_chooser_set_current_folder_file (chooser, default_file_for_saving);
gtk_file_chooser_set_current_name (chooser, "Untitled document");
}
else
{
// the user edited an existing document
gtk_file_chooser_set_file (chooser, existing_file);
}
Not useful.
Sets filename as the current filename for the file chooser, by changing to
the file’s parent folder and actually selecting the file in list; all other
files will be unselected. If the chooser is in
Gtk.FileChooserAction.SAVE mode, the file’s base name will also appear in
the dialog’s file name entry.
Note that the file must exist, or nothing will be done except for the directory change.
You should use this function only when implementing a save dialog for which you already have a file name to which the user may save. For example, when the user opens an existing file and then does Save As... to save a copy or a modified version. If you don’t have a file name already — for example, if the user just created a new file and is saving it for the first time, do not call this function. Instead, use something similar to this:
if (document_is_new)
{
// the user just created a new document
gtk_file_chooser_set_current_name (chooser, "Untitled document");
}
else
{
// the user edited an existing document
gtk_file_chooser_set_filename (chooser, existing_filename);
}
In the first case, the file chooser will present the user with useful suggestions as to where to save his new file. In the second case, the file’s existing location is already known, so the file chooser will use it.
the filename to set as current
Not useful.
Sets the current filter; only the files that pass the filter will be displayed. If the user-selectable list of filters is non-empty, then the filter should be one of the filters in that list. Setting the current filter when the list of filters is empty is useful if you want to restrict the displayed set of files without letting the user change it.
Sets whether only local files can be selected in the
file selector. If local_only is true (the default),
then the selected file or files are guaranteed to be
accessible through the operating systems native file
system and therefore the application only
needs to worry about the filename functions in
Gtk.FileChooser, like gtk_file_chooser_get_filename(),
rather than the URI functions like
gtk_file_chooser_get_uri(),
On some systems non-native files may still be available using the native filesystem via a userspace filesystem (FUSE).
true if only local files can be selected
Sets an application-supplied widget to use to display a custom preview
of the currently selected file. To implement a preview, after setting the
preview widget, you connect to the Gtk.FileChooser.SignalSignatures.update_preview | Gtk.FileChooser::update-preview
signal, and call gtk_file_chooser_get_preview_filename() or
gtk_file_chooser_get_preview_uri() on each change. If you can
display a preview of the new file, update your widget and
set the preview active using gtk_file_chooser_set_preview_widget_active().
Otherwise, set the preview inactive.
When there is no application-supplied preview widget, or the application-supplied preview widget is not active, the file chooser will display no preview at all.
Sets whether the preview widget set by
gtk_file_chooser_set_preview_widget() should be shown for the
current filename. When active is set to false, the file chooser
may display an internally generated preview of the current file
or it may display no preview at all. See
gtk_file_chooser_set_preview_widget() for more details.
whether to display the user-specified preview widget
Sets a property on an object.
The name of the property to set
The value to set the property to
Sets whether multiple files can be selected in the file selector. This is only relevant if the action is set to be Gtk.FileChooserAction.OPEN or Gtk.FileChooserAction.SELECT_FOLDER.
true if multiple files can be selected.
Sets whether hidden files and folders are displayed in the file selector.
true if hidden files and folders should be displayed.
Sets the file referred to by uri as the current file for the file chooser,
by changing to the URI’s parent folder and actually selecting the URI in the
list. If the chooser is Gtk.FileChooserAction.SAVE mode, the URI’s base
name will also appear in the dialog’s file name entry.
Note that the URI must exist, or nothing will be done except for the directory change.
You should use this function only when implementing a save dialog for which you already have a file name to which the user may save. For example, when the user opens an existing file and then does Save As... to save a copy or a modified version. If you don’t have a file name already — for example, if the user just created a new file and is saving it for the first time, do not call this function. Instead, use something similar to this:
if (document_is_new)
{
// the user just created a new document
gtk_file_chooser_set_current_name (chooser, "Untitled document");
}
else
{
// the user edited an existing document
gtk_file_chooser_set_uri (chooser, existing_uri);
}
In the first case, the file chooser will present the user with useful suggestions as to where to save his new file. In the second case, the file’s existing location is already known, so the file chooser will use it.
the URI to set as current
Not useful.
Sets whether the file chooser should display a stock label with the name of
the file that is being previewed; the default is true. Applications that
want to draw the whole preview area themselves should set this to false and
display the name themselves in their preview widget.
See also: gtk_file_chooser_set_preview_widget()
whether to display a stock label with the name of the previewed file
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
the data if found, or null if no such data exists.
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of
g_object_steal_qdata() would have left the destroy function set,
and thus the partial string list would have been freed upon
g_object_set_qdata_full().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
Name of the signal to stop emission of
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Unblocks a handler so it will be called again during any signal emissions
Handler ID of the handler to be unblocked
Decreases the reference count of object. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the GObject.Object may be reused in future (for example, if it is
an instance variable of another object), it is recommended to clear the
pointer to null rather than retain a dangling pointer to a potentially
invalid GObject.Object instance. Use g_clear_object() for this.
Unselects all the files in the current folder of a file chooser.
Unselects a currently selected filename. If the filename is not in the current directory, does not exist, or is otherwise not currently selected, does nothing.
the filename to unselect
Unselects the file referred to by uri. If the file
is not in the current directory, does not exist, or
is otherwise not currently selected, does nothing.
the URI to unselect
Virtualvfunc_the constructed function is called by g_object_new() as the
final step of the object creation process. At the point of the call, all
construction properties have been set on the object. The purpose of this
call is to allow for object initialisation steps that can only be performed
after construction properties have been set. constructed implementors
should chain up to the constructed call of their parent class to allow it
to complete its initialisation.
Virtualvfunc_Virtualvfunc_the dispose function is supposed to drop all references to other
objects, but keep the instance otherwise intact, so that client method
invocations still work. It may be run multiple times (due to reference
loops). Before returning, dispose should chain up to the dispose method
of the parent class.
Virtualvfunc_instance finalization function, should finish the finalization of
the instance begun in dispose and chain up to the finalize method of the
parent class.
Virtualvfunc_Virtualvfunc_Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
Virtualvfunc_the generic setter for all properties of this type. Should be
overridden for every type with properties. If implementations of
set_property don't emit property change notification explicitly, this will
be done implicitly by the type system. However, if the notify signal is
emitted explicitly, the type system will not emit it a second time.
This function essentially limits the life time of the closure to
the life time of the object. That is, when the object is finalized,
the closure is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure, to ensure that an extra
reference count is held on object during invocation of the
closure. Usually, this function will be called on closures that
use this object as closure data.
GObject.Closure to watch
StaticnewOptionalaccept_label: stringOptionalcancel_label: stringDestroys a dialog.
When a dialog is destroyed, it will break any references it holds to other objects. If it is visible it will be hidden and any underlying window system resources will be destroyed.
Note that this does not release any reference to the object (as opposed to destroying a GtkWindow) because there is no reference from the windowing system to the Gtk.NativeDialog.
Returns whether the dialog is modal. See gtk_native_dialog_set_modal().
true if the dialog is set to be modal
Gets the title of the Gtk.NativeDialog.
the title of the dialog, or null if none has been set explicitly. The returned string is owned by the widget and must not be modified or freed.
Determines whether the dialog is visible.
true if the dialog is visible
Hides the dialog if it is visilbe, aborting any interaction. Once this
is called the Gtk.NativeDialog::response signal will not be emitted
until after the next call to gtk_native_dialog_show().
If the dialog is not visible this does nothing.
Blocks in a recursive main loop until self emits the
Gtk.NativeDialog::response signal. It then returns the response ID
from the ::response signal emission.
Before entering the recursive main loop, gtk_native_dialog_run()
calls gtk_native_dialog_show() on the dialog for you.
After gtk_native_dialog_run() returns, then dialog will be hidden.
Typical usage of this function might be:
gint result = gtk_native_dialog_run (GTK_NATIVE_DIALOG (dialog));
switch (result)
{
case GTK_RESPONSE_ACCEPT:
do_application_specific_something ();
break;
default:
do_nothing_since_dialog_was_cancelled ();
break;
}
g_object_unref (dialog);
Note that even though the recursive main loop gives the effect of a
modal dialog (it prevents the user from interacting with other
windows in the same window group while the dialog is run), callbacks
such as timeouts, IO channel watches, DND drops, etc, will
be triggered during a gtk_native_dialog_run() call.
response ID
Sets a dialog modal or non-modal. Modal dialogs prevent interaction
with other windows in the same application. To keep modal dialogs
on top of main application windows, use
gtk_native_dialog_set_transient_for() to make the dialog transient for the
parent; most [window managers][gtk-X11-arch]
will then disallow lowering the dialog below the parent.
whether the window is modal
Dialog windows should be set transient for the main application window they were spawned from. This allows [window managers][gtk-X11-arch] to e.g. keep the dialog on top of the main window, or center the dialog over the main window.
Passing null for parent unsets the current transient window.
Shows the dialog on the display, allowing the user to interact with it. When the user accepts the state of the dialog the dialog will be automatically hidden and the Gtk.NativeDialog::response signal will be emitted.
Multiple calls while the dialog is visible will be ignored.
Virtualvfunc_Hides the dialog if it is visilbe, aborting any interaction. Once this
is called the Gtk.NativeDialog::response signal will not be emitted
until after the next call to gtk_native_dialog_show().
If the dialog is not visible this does nothing.
Virtualvfunc_Virtualvfunc_Shows the dialog on the display, allowing the user to interact with it. When the user accepts the state of the dialog the dialog will be automatically hidden and the Gtk.NativeDialog::response signal will be emitted.
Multiple calls while the dialog is visible will be ignored.
Static_Staticcompat_Optionaldata: anyStaticfind_Staticinstall_Staticinstall_the id for the new property
the GObject.ParamSpec for the new property
Staticinterface_Find the GObject.ParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Staticinterface_Add a property to an interface; this is only useful for interfaces
that are added to GObject-derived types. Adding a property to an
interface forces all objects classes with that interface to have a
compatible property. The compatible property could be a newly
created GObject.ParamSpec, but normally
g_object_class_override_property() will be used so that the object
class only needs to provide an implementation and inherits the
property description, default value, bounds, and so forth from the
interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init member of
GObject.TypeInfo.) It must not be called after after class_init has
been called for any object types implementing this interface.
If pspec is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the GObject.ParamSpec for the new property
Staticinterface_Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Staticlist_StaticnewvStaticoverride_the new property ID
the name of a property registered in a parent class or in an interface of this class.
Gtk.FileChooserNative is an abstraction of a dialog box suitable for use with “File/Open” or “File/Save as” commands. By default, this just uses a Gtk.FileChooserDialog to implement the actual dialog. However, on certain platforms, such as Windows and macOS, the native platform file chooser is used instead. When the application is running in a sandboxed environment without direct filesystem access (such as Flatpak), Gtk.FileChooserNative may call the proper APIs (portals) to let the user choose a file and make it available to the application.
While the API of Gtk.FileChooserNative closely mirrors Gtk.FileChooserDialog, the main difference is that there is no access to any Gtk.Window or Gtk.Widget for the dialog. This is required, as there may not be one in the case of a platform native dialog. Showing, hiding and running the dialog is handled by the Gtk.NativeDialog functions.
Typical usage ## {#gtkfilechoosernative-typical-usage}
In the simplest of cases, you can the following code to use Gtk.FileChooserDialog to select a file for opening:
To use a dialog for saving, you can use this:
For more information on how to best set up a file dialog, see Gtk.FileChooserDialog.
Response Codes ## {#gtkfilechooserdialognative-responses}
Gtk.FileChooserNative inherits from Gtk.NativeDialog, which means it will return #GTK_RESPONSE_ACCEPT if the user accepted, and #GTK_RESPONSE_CANCEL if he pressed cancel. It can also return #GTK_RESPONSE_DELETE_EVENT if the window was unexpectedly closed.
Differences from Gtk.FileChooserDialog ## {#gtkfilechooserdialognative-differences}
There are a few things in the GtkFileChooser API that are not possible to use with Gtk.FileChooserNative, as such use would prohibit the use of a native dialog.
There is no support for the signals that are emitted when the user navigates in the dialog, including:
You can also not use the methods that directly control user navigation:
gtk_file_chooser_unselect_filename()gtk_file_chooser_select_all()gtk_file_chooser_unselect_all()If you need any of the above you will have to use Gtk.FileChooserDialog directly.
No operations that change the the dialog work while the dialog is visible. Set all the properties that are required before showing the dialog.
Win32 details ## {#gtkfilechooserdialognative-win32}
On windows the IFileDialog implementation (added in Windows Vista) is used. It supports many of the features that Gtk.FileChooserDialog does, but there are some things it does not handle:
Extra widgets added with
gtk_file_chooser_set_extra_widget().Use of custom previews by connecting to Gtk.FileChooser.SignalSignatures.update_preview | Gtk.FileChooser::update-preview.
Any Gtk.FileFilter added using a mimetype or custom filter.
If any of these features are used the regular Gtk.FileChooserDialog will be used in place of the native one.
Portal details ## {#gtkfilechooserdialognative-portal}
When the org.freedesktop.portal.FileChooser portal is available on the session bus, it is used to bring up an out-of-process file chooser. Depending on the kind of session the application is running in, this may or may not be a GTK+ file chooser. In this situation, the following things are not supported and will be silently ignored:
Extra widgets added with
gtk_file_chooser_set_extra_widget().Use of custom previews by connecting to Gtk.FileChooser.SignalSignatures.update_preview | Gtk.FileChooser::update-preview.
Any Gtk.FileFilter added with a custom filter.
macOS details ## {#gtkfilechooserdialognative-macos}
On macOS the NSSavePanel and NSOpenPanel classes are used to provide native file chooser dialogs. Some features provided by Gtk.FileChooserDialog are not supported:
Extra widgets added with
gtk_file_chooser_set_extra_widget(), unless the widget is an instance of GtkLabel, in which case the label text will be used to set the NSSavePanel message instance property.Use of custom previews by connecting to Gtk.FileChooser.SignalSignatures.update_preview | Gtk.FileChooser::update-preview.
Any Gtk.FileFilter added with a custom filter.
Shortcut folders.