DeprecatedconstructorOptionalDeprecatedproperties: Partial<Gtk.FileChooserNative.ConstructorProps>Deprecated...args: any[]InternalDeprecated$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.
StaticDeprecated$gtypeDeprecatedaccept_The text used for the label on the accept button in the dialog, or
null to use the default text.
Deprecatedval: stringDeprecatedacceptThe text used for the label on the accept button in the dialog, or
null to use the default text.
Deprecatedval: stringDeprecatedcancel_The text used for the label on the cancel button in the dialog, or
null to use the default text.
Deprecatedval: stringDeprecatedcancelThe text used for the label on the cancel button in the dialog, or
null to use the default text.
Deprecatedval: stringDeprecatedactionThe type of operation that the file chooser is performing.
since 4.10: Use Gtk.FileDialog instead
The type of operation that the file chooser is performing.
Deprecatedval: Gtk.FileChooserActionsince 4.10: Use Gtk.FileDialog instead
Deprecatedcreate_Whether a file chooser not in Gtk.FileChooserAction.OPEN mode will offer the user to create new folders.
since 4.10: Use Gtk.FileDialog instead
Whether a file chooser not in Gtk.FileChooserAction.OPEN mode will offer the user to create new folders.
Deprecatedval: booleansince 4.10: Use Gtk.FileDialog instead
DeprecatedcreateWhether a file chooser not in Gtk.FileChooserAction.OPEN mode will offer the user to create new folders.
since 4.10: Use Gtk.FileDialog instead
Whether a file chooser not in Gtk.FileChooserAction.OPEN mode will offer the user to create new folders.
Deprecatedval: booleansince 4.10: Use Gtk.FileDialog instead
DeprecatedfilterThe current filter for selecting files that are displayed.
since 4.10: Use Gtk.FileDialog instead
The current filter for selecting files that are displayed.
Deprecatedval: Gtk.FileFiltersince 4.10: Use Gtk.FileDialog instead
DeprecatedfiltersA Gio.ListModel containing the filters that have been
added with gtk_file_chooser_add_filter().
The returned object should not be modified. It may or may not be updated for later changes.
since 4.10: Use Gtk.FileDialog instead
Deprecatedselect_Whether to allow multiple files to be selected.
since 4.10: Use Gtk.FileDialog instead
Whether to allow multiple files to be selected.
Deprecatedval: booleansince 4.10: Use Gtk.FileDialog instead
DeprecatedselectWhether to allow multiple files to be selected.
since 4.10: Use Gtk.FileDialog instead
Whether to allow multiple files to be selected.
Deprecatedval: booleansince 4.10: Use Gtk.FileDialog instead
Deprecatedshortcut_A Gio.ListModel containing the shortcut folders that have been
added with gtk_file_chooser_add_shortcut_folder().
The returned object should not be modified. It may or may not be updated for later changes.
since 4.10: Use Gtk.FileDialog instead
DeprecatedshortcutA Gio.ListModel containing the shortcut folders that have been
added with gtk_file_chooser_add_shortcut_folder().
The returned object should not be modified. It may or may not be updated for later changes.
since 4.10: Use Gtk.FileDialog instead
DeprecatedmodalWhether the window should be modal with respect to its transient parent.
Deprecatedval: booleanDeprecatedtitleThe title of the dialog window
Deprecatedval: stringDeprecatedtransient_DeprecatedtransientDeprecatedvisibleWhether the window is currently visible.
Deprecatedval: booleanDeprecated_Deprecated...args: any[]Deprecatedadd_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.FileChooser.set_choice before the dialog is shown,
and you can obtain the user-selected value in the
Gtk.Dialog::response signal handler using
Gtk.FileChooser.get_choice.
Deprecatedid: stringid for the added choice
Deprecatedlabel: stringuser-visible label for the added choice
OptionalDeprecatedoptions: string[]ids for the options of the choice, or null for a boolean choice
OptionalDeprecatedoption_labels: string[]user-visible labels for the options, must be the same length as options
Deprecatedadd_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 if it is floating,
so you have to ref and sink it if you want to keep a reference.
Deprecatedfilter: Gtk.FileFilterDeprecatedadd_Deprecatedbind_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.
Deprecatedsource_property: stringthe property on source to bind
Deprecatedtarget: GObject.Objectthe target GObject.Object
Deprecatedtarget_property: stringthe property on target to bind
Deprecatedflags: GObject.BindingFlagsflags 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.
Deprecatedbind_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.
Deprecatedsource_property: stringthe property on source to bind
Deprecatedtarget: GObject.Objectthe target GObject.Object
Deprecatedtarget_property: stringthe property on target to bind
Deprecatedflags: GObject.BindingFlagsflags to pass to GObject.Binding
OptionalDeprecatedtransform_to: BindingTransformFuncthe transformation function from the source to the target, or null to use the default
OptionalDeprecatedtransform_from: BindingTransformFuncthe transformation function from the target to the source, or null to use the default
OptionalDeprecatednotify: 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.
Deprecated...args: never[]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.
Deprecatedblock_Blocks a handler of an instance so it will not be called during any signal emissions
Deprecatedid: numberHandler ID of the handler to be blocked
SignalDeprecatedconnectDeprecatedsignal: KDeprecatedcallback: SignalCallback<Gtk.FileChooserNative, Gtk.FileChooserNative.SignalSignatures[K]>Deprecatedsignal: stringDeprecatedcallback: (...args: any[]) => anySignalDeprecatedconnect_Deprecatedsignal: KDeprecatedcallback: SignalCallback<Gtk.FileChooserNative, Gtk.FileChooserNative.SignalSignatures[K]>Deprecatedsignal: stringDeprecatedcallback: (...args: any[]) => anyDeprecateddisconnectDisconnects 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.
Deprecatedid: numberHandler ID of the handler to be disconnected
SignalDeprecatedemitDeprecatedsignal: KDeprecated...args: GjsParameters<Gtk.FileChooserNative.SignalSignatures[K]> extends [any, ...Q[]]Deprecatedsignal: stringDeprecated...args: any[]Deprecatedforce_This 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().
Deprecatedfreeze_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.
Deprecatedget_Retrieves the custom label text for the accept button.
The custom label
Deprecatedget_Gets the type of operation that the file chooser is performing.
the action that the file selector is performing
Deprecatedget_Retrieves the custom label text for the cancel button.
The custom label
Deprecatedget_Gets the currently selected option in the 'choice' with the given ID.
Deprecatedid: stringthe ID of the choice to get
the ID of the currently selected option
Deprecatedget_Gets whether file chooser will offer to create new folders.
true if the Create Folder button should be displayed.
Deprecatedget_Deprecatedget_Gets the current name in the file selector, as entered by the user.
This is meant to be used in save dialogs, to get the currently typed filename when the file itself does not exist yet.
The raw text from the file chooser’s “Name” entry. Free 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.
Deprecatedget_Gets a named field from the objects table of associations (see g_object_set_data()).
Deprecatedkey: stringname of the key for that association
the data if found, or null if no such data exists.
Deprecatedget_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.
Deprecatedget_Deprecatedget_Deprecatedget_Gets the current set of user-selectable filters, as a list model.
See Gtk.FileChooser.add_filter and Gtk.FileChooser.remove_filter for changing individual filters.
You should not modify the returned list model. Future changes to
chooser may or may not affect the returned model.
a Gio.ListModel containing the current set of user-selectable filters.
Deprecatedget_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.
Deprecatedproperty_name: stringThe name of the property to get
Deprecatedvalue: anyReturn 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
Deprecatedget_This function gets back user data pointers stored via
g_object_set_qdata().
Deprecatedquark: numberA GLib.Quark, naming the user data pointer
The user data pointer set, or null
Deprecatedget_Gets whether multiple files can be selected in the file chooser.
true if multiple files can be selected.
Deprecatedget_DeprecatedgetvGets 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.
Deprecatednames: string[]the names of each property to get
Deprecatedvalues: any[]the values of each property to get
Deprecatedis_Checks whether object has a [floating][floating-ref] reference.
true if object has a floating reference
DeprecatednotifyEmits 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.
Deprecatedproperty_name: stringthe name of a property installed on the class of object.
Deprecatednotify_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]);
Deprecatedpspec: GObject.ParamSpecthe GObject.ParamSpec of a property installed on the class of object.
DeprecatedrefIncreases 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
Deprecatedref_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
Deprecatedremove_Removes a 'choice' that has been added with gtk_file_chooser_add_choice().
Deprecatedid: stringthe ID of the choice to remove
Deprecatedremove_Removes filter from the list of filters that the user can select between.
Deprecatedfilter: Gtk.FileFilterDeprecatedremove_Deprecatedrun_Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
DeprecatedsetSets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
Deprecatedproperties: { [key: string]: any }Object containing the properties to set
Deprecatedset_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 should activate the button.
OptionalDeprecatedaccept_label: stringcustom label
Deprecatedset_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.
Deprecatedaction: Gtk.FileChooserActionthe action that the file selector is performing
Deprecatedset_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 should activate the button.
OptionalDeprecatedcancel_label: stringcustom label
Deprecatedset_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".
Deprecatedid: stringthe ID of the choice to set
Deprecatedoption: stringthe ID of the option to select
Deprecatedset_Sets whether file chooser will offer to create new folders.
This is only relevant if the action is not set to be Gtk.FileChooserAction.OPEN.
Deprecatedcreate_folders: booleantrue if the Create Folder button should be displayed
Deprecatedset_Deprecatedset_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.FileChooser.set_file instead.
Please see the documentation for those functions for an example of using Gtk.FileChooser.set_current_name as well.
Deprecatedname: stringthe filename to use, as a UTF-8 string
Deprecatedset_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.
Deprecatedkey: stringname of the key
OptionalDeprecateddata: anydata to associate with that key
Deprecatedset_Sets file as the current filename for the file chooser.
This includes 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 file.
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:
static void
prepare_file_chooser (GtkFileChooser *chooser,
GFile *existing_file)
{
gboolean document_is_new = (existing_file == NULL);
if (document_is_new)
{
GFile *default_file_for_saving = g_file_new_for_path ("./out.txt");
// the user just created a new document
gtk_file_chooser_set_current_folder (chooser, default_file_for_saving, NULL);
gtk_file_chooser_set_current_name (chooser, "Untitled document");
g_object_unref (default_file_for_saving);
}
else
{
// the user edited an existing document
gtk_file_chooser_set_file (chooser, existing_file, NULL);
}
}
Not useful
Deprecatedset_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.
Deprecatedfilter: Gtk.FileFilterDeprecatedset_Sets a property on an object.
Deprecatedproperty_name: stringThe name of the property to set
Deprecatedvalue: anyThe value to set the property to
Deprecatedset_Sets whether multiple files can be selected in the file chooser.
This is only relevant if the action is set to be Gtk.FileChooserAction.OPEN or Gtk.FileChooserAction.SELECT_FOLDER.
Deprecatedselect_multiple: booleantrue if multiple files can be selected.
Deprecatedsteal_Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
Deprecatedkey: stringname of the key
the data if found, or null if no such data exists.
Deprecatedsteal_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().
Deprecatedquark: numberA GLib.Quark, naming the user data pointer
The user data pointer set, or null
Deprecatedstop_Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
DeprecateddetailedName: stringName of the signal to stop emission of
Deprecatedthaw_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.
Deprecatedunblock_Unblocks a handler so it will be called again during any signal emissions
Deprecatedid: numberHandler ID of the handler to be unblocked
DeprecatedunrefDecreases 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.
VirtualDeprecatedvfunc_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.
VirtualDeprecatedvfunc_VirtualDeprecatedvfunc_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.
VirtualDeprecatedvfunc_instance finalization function, should finish the finalization of
the instance begun in dispose and chain up to the finalize method of the
parent class.
VirtualDeprecatedvfunc_VirtualDeprecatedvfunc_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.
VirtualDeprecatedvfunc_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.
Deprecatedwatch_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.
Deprecatedclosure: ClosureGObject.Closure to watch
StaticDeprecatednewDeprecatedtitle: stringDeprecatedparent: Gtk.WindowDeprecatedaction: Gtk.FileChooserActionOptionalDeprecatedaccept_label: stringOptionalDeprecatedcancel_label: stringDeprecateddestroyDestroys 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 Gtk.Window) because there is no reference from the windowing system to the Gtk.NativeDialog.
Deprecatedget_Returns whether the dialog is modal.
true if the dialog is set to be modal
Deprecatedget_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.
Deprecatedget_Deprecatedget_Determines whether the dialog is visible.
true if the dialog is visible
DeprecatedhideHides the dialog if it is visible, aborting any interaction.
Once this is called the Gtk.NativeDialog::response signal
will not be emitted until after the next call to
Gtk.NativeDialog.show.
If the dialog is not visible this does nothing.
Deprecatedset_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.NativeDialog.set_transient_for to make the dialog transient for the parent; most window managers will then disallow lowering the dialog below the parent.
Deprecatedmodal: booleanwhether the window is modal
Deprecatedset_Sets the title of the GtkNativeDialog.
Deprecatedtitle: stringtitle of the dialog
Deprecatedset_Dialog windows should be set transient for the main application window they were spawned from.
This allows window managers 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.
DeprecatedshowShows the dialog on the display.
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.
VirtualDeprecatedvfunc_Hides the dialog if it is visible, aborting any interaction.
Once this is called the Gtk.NativeDialog::response signal
will not be emitted until after the next call to
Gtk.NativeDialog.show.
If the dialog is not visible this does nothing.
VirtualDeprecatedvfunc_class handler for the Gtk.NativeDialog::response signal
Deprecatedresponse_id: numberVirtualDeprecatedvfunc_Shows the dialog on the display.
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.
StaticDeprecated_Deprecatedklass: anyStaticDeprecatedcompat_Deprecatedwhat: numberOptionalDeprecateddata: anyStaticDeprecatedfind_StaticDeprecatedinstall_StaticDeprecatedinstall_Deprecatedproperty_id: numberthe id for the new property
Deprecatedpspec: GObject.ParamSpecthe GObject.ParamSpec for the new property
StaticDeprecatedinterface_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().
Deprecatedg_iface: TypeInterfaceany interface vtable for the interface, or the default vtable for the interface
Deprecatedproperty_name: stringname of a property to look up.
StaticDeprecatedinterface_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.
Deprecatedg_iface: TypeInterfaceany interface vtable for the interface, or the default vtable for the interface.
Deprecatedpspec: GObject.ParamSpecthe GObject.ParamSpec for the new property
StaticDeprecatedinterface_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().
Deprecatedg_iface: TypeInterfaceany interface vtable for the interface, or the default vtable for the interface
StaticDeprecatedlist_StaticDeprecatednewvStaticDeprecatedoverride_Deprecatedproperty_id: numberthe new property ID
Deprecatedname: stringthe name of a property registered in a parent class or in an interface of this class.
Gtk.FileChooserNative is an abstraction of a dialog 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 some 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.
Note that unlike Gtk.FileChooserDialog, Gtk.FileChooserNative objects are not toplevel widgets, and GTK does not keep them alive. It is your responsibility to keep a reference until you are done with the object.
Typical usage
In the simplest of cases, you can the following code to use Gtk.FileChooserNative to select a file for opening:
To use a Gtk.FileChooserNative for saving, you can use this:
For more information on how to best set up a file dialog, see the Gtk.FileChooserDialog documentation.
Response Codes
Gtk.FileChooserNative inherits from Gtk.NativeDialog, which means it will return Gtk.ResponseType.ACCEPT if the user accepted, and Gtk.ResponseType.CANCEL if he pressed cancel. It can also return Gtk.ResponseType.DELETE_EVENT if the window was unexpectedly closed.
Differences from Gtk.FileChooserDialog
There are a few things in the Gtk.FileChooser interface that are not possible to use with Gtk.FileChooserNative, as such use would prohibit the use of a native dialog.
No operations that change the dialog work while the dialog is visible. Set all the properties that are required before showing the dialog.
Win32 details
On windows the
IFileDialogimplementation (added in Windows Vista) is used. It supports many of the features that Gtk.FileChooser has, but there are some things it does not handle:If any of these features are used the regular Gtk.FileChooserDialog will be used in place of the native one.
Portal details
When the
org.freedesktop.portal.FileChooserportal 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.macOS details
On macOS the
NSSavePanelandNSOpenPanelclasses are used to provide native file chooser dialogs. Some features provided by Gtk.FileChooser are not supported:Deprecated
since 4.10: Use Gtk.FileDialog instead