Gjsify LogoGjsify Logo

GtkFileChooserNative is an abstraction of a dialog suitable for use with “File Open” or “File Save as” commands.

By default, this just uses a GtkFileChooserDialog 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), GtkFileChooserNative may call the proper APIs (portals) to let the user choose a file and make it available to the application.

While the API of GtkFileChooserNative closely mirrors GtkFileChooserDialog, the main difference is that there is no access to any GtkWindow or GtkWidget 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 [classGtk.NativeDialog] functions.

Note that unlike GtkFileChooserDialog, GtkFileChooserNative 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 GtkFileChooserNative to select a file for opening:

static void
on_response (GtkNativeDialog *native,
int response)
{
if (response == GTK_RESPONSE_ACCEPT)
{
GtkFileChooser *chooser = GTK_FILE_CHOOSER (native);
GFile *file = gtk_file_chooser_get_file (chooser);

open_file (file);

g_object_unref (file);
}

g_object_unref (native);
}

// ...
GtkFileChooserNative *native;
GtkFileChooserAction action = GTK_FILE_CHOOSER_ACTION_OPEN;

native = gtk_file_chooser_native_new ("Open File",
parent_window,
action,
"_Open",
"_Cancel");

g_signal_connect (native, "response", G_CALLBACK (on_response), NULL);
gtk_native_dialog_show (GTK_NATIVE_DIALOG (native));

To use a GtkFileChooserNative for saving, you can use this:

static void
on_response (GtkNativeDialog *native,
int response)
{
if (response == GTK_RESPONSE_ACCEPT)
{
GtkFileChooser *chooser = GTK_FILE_CHOOSER (native);
GFile *file = gtk_file_chooser_get_file (chooser);

save_to_file (file);

g_object_unref (file);
}

g_object_unref (native);
}

// ...
GtkFileChooserNative *native;
GtkFileChooser *chooser;
GtkFileChooserAction action = GTK_FILE_CHOOSER_ACTION_SAVE;

native = gtk_file_chooser_native_new ("Save File",
parent_window,
action,
"_Save",
"_Cancel");
chooser = GTK_FILE_CHOOSER (native);

if (user_edited_a_new_document)
gtk_file_chooser_set_current_name (chooser, _("Untitled document"));
else
gtk_file_chooser_set_file (chooser, existing_file, NULL);

g_signal_connect (native, "response", G_CALLBACK (on_response), NULL);
gtk_native_dialog_show (GTK_NATIVE_DIALOG (native));

For more information on how to best set up a file dialog, see the [classGtk.FileChooserDialog] documentation.

Response Codes

GtkFileChooserNative inherits from [classGtk.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 GtkFileChooserDialog

There are a few things in the [ifaceGtk.FileChooser] interface that are not possible to use with GtkFileChooserNative, 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 IFileDialog implementation (added in Windows Vista) is used. It supports many of the features that GtkFileChooser has, but there are some things it does not handle:

  • Any [classGtk.FileFilter] added using a mimetype

If any of these features are used the regular GtkFileChooserDialog will be used in place of the native one.

Portal details

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.

macOS details

On macOS the NSSavePanel and NSOpenPanel classes are used to provide native file chooser dialogs. Some features provided by GtkFileChooser are not supported:

  • Shortcut folders.

Hierarchy

Index

Constructors

Properties

acceptLabel: string

The text used for the label on the accept button in the dialog, or %NULL to use the default text.

The type of operation that the file chooser is performing.

cancelLabel: string

The text used for the label on the cancel button in the dialog, or %NULL to use the default text.

createFolders: boolean

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

filter: Gtk.FileFilter

The current filter for selecting files that are displayed.

filters: Gio.ListModel

A GListModel 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.

gTypeInstance: TypeInstance
modal: boolean

Whether the window should be modal with respect to its transient parent.

parentInstance: GObject.Object
selectMultiple: boolean

Whether to allow multiple files to be selected.

shortcutFolders: Gio.ListModel

A GListModel 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.

title: string

The title of the dialog window

transientFor: Gtk.Window

The transient parent of the dialog, or %NULL for none.

visible: boolean

Whether the window is currently visible.

name: string

Methods

  • addChoice(id: string, label: string, options: string[], optionLabels: string[]): void
  • 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 [methodGtk.FileChooser.set_choice] before the dialog is shown, and you can obtain the user-selected value in the [signalGtk.Dialog::response] signal handler using [methodGtk.FileChooser.get_choice].

    Parameters

    • id: string

      id for the added choice

    • label: string

      user-visible label for the added choice

    • options: string[]

      ids for the options of the choice, or %NULL for a boolean choice

    • optionLabels: string[]

      user-visible labels for the options, must be the same length as options

    Returns void

  • 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.

    Parameters

    Returns void

  • addShortcutFolder(folder: Gio.File): boolean
  • 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 instance to be updated with the same value of the "active" property of the action #GObject instance.

    If flags contains %G_BINDING_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 #GBinding 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 can have multiple bindings.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • 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.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transformTo: TClosure<any, any>

      a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default

    • transformFrom: TClosure<any, any>

      a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default

    Returns Binding

  • connect(sigName: "notify::accept-label", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::cancel-label", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::modal", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::title", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::transient-for", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::visible", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::action", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::create-folders", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::filter", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::filters", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::select-multiple", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::shortcut-folders", callback: ((...args: any[]) => void)): number
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • Parameters

    • sigName: "notify::accept-label"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::cancel-label"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::modal"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::title"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::transient-for"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::visible"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::action"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::create-folders"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::filter"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::filters"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::select-multiple"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::shortcut-folders"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • destroy(): void
  • Destroys 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 GtkNativeDialog.

    Returns void

  • emit(sigName: "notify::accept-label", ...args: any[]): void
  • emit(sigName: "notify::cancel-label", ...args: any[]): void
  • emit(sigName: "notify::modal", ...args: any[]): void
  • emit(sigName: "notify::title", ...args: any[]): void
  • emit(sigName: "notify::transient-for", ...args: any[]): void
  • emit(sigName: "notify::visible", ...args: any[]): void
  • emit(sigName: "notify::action", ...args: any[]): void
  • emit(sigName: "notify::create-folders", ...args: any[]): void
  • emit(sigName: "notify::filter", ...args: any[]): void
  • emit(sigName: "notify::filters", ...args: any[]): void
  • emit(sigName: "notify::select-multiple", ...args: any[]): void
  • emit(sigName: "notify::shortcut-folders", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • forceFloating(): void
  • This function is intended for #GObject 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().

    Returns void

  • freezeNotify(): void
  • 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::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.

    Returns void

  • getAcceptLabel(): string
  • Retrieves the custom label text for the accept button.

    Returns string

  • getCancelLabel(): string
  • Retrieves the custom label text for the cancel button.

    Returns string

  • getChoice(id: string): string
  • Gets the currently selected option in the 'choice' with the given ID.

    Parameters

    • id: string

      the ID of the choice to get

    Returns string

  • getCreateFolders(): boolean
  • getCurrentName(): string
  • 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.

    Returns string

  • getData(key?: string): object
  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • Optional key: string

      name of the key for that association

    Returns object

  • Gets the GFile 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.

    Returns Gio.File

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

    See [methodGtk.FileChooser.add_filter] and [methodGtk.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.

    Returns Gio.ListModel

  • getModal(): boolean
  • getProperty(propertyName?: string, value?: any): void
  • Gets a property of an object.

    The value can be:

    • an empty #GValue initialized by %G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a #GValue initialized with the expected type of the property
    • a #GValue initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().

    Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.

    Parameters

    • Optional propertyName: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • getQdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • getSelectMultiple(): boolean
  • getTitle(): string
  • getVisible(): boolean
  • getv(names: string[], values: any[]): void
  • 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.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • hide(): void
  • Hides the dialog if it is visible, aborting any interaction.

    Once this is called the [signalGtk.NativeDialog::response] signal will not be emitted until after the next call to [methodGtk.NativeDialog.show].

    If the dialog is not visible this does nothing.

    Returns void

  • isFloating(): boolean
  • notify(propertyName: string): void
  • 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.

    Parameters

    • propertyName: string

      the name of a property installed on the class of object.

    Returns void

  • 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.:

      enum
    {
    PROP_0,
    PROP_FOO,
    PROP_LAST
    };

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
    0, 100,
    50,
    G_PARAM_READWRITE);
    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]);
    

    Parameters

    • pspec: ParamSpec

      the #GParamSpec of a property installed on the class of object.

    Returns void

  • off(sigName: "notify::accept-label", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::cancel-label", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::modal", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::title", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::transient-for", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::visible", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::action", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::create-folders", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::filter", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::filters", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::select-multiple", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::shortcut-folders", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: string, callback: ((...args: any[]) => void)): EventEmitter
  • Parameters

    • sigName: "notify::accept-label"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::cancel-label"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::modal"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::title"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::transient-for"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::visible"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::action"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::create-folders"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::filter"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::filters"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::select-multiple"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::shortcut-folders"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • on(sigName: "notify::accept-label", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::cancel-label", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::modal", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::title", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::transient-for", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::visible", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::action", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::create-folders", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::filter", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::filters", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::select-multiple", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::shortcut-folders", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    • sigName: "notify::accept-label"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::cancel-label"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::modal"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::title"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::transient-for"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::visible"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::action"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::create-folders"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::filter"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::filters"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::select-multiple"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::shortcut-folders"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • once(sigName: "notify::accept-label", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::cancel-label", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::modal", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::title", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::transient-for", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::visible", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::action", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::create-folders", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::filter", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::filters", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::select-multiple", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::shortcut-folders", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    • sigName: "notify::accept-label"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::cancel-label"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::modal"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::title"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::transient-for"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::visible"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::action"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::create-folders"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::filter"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::filters"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::select-multiple"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::shortcut-folders"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • 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.

    Returns GObject.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().

    Returns GObject.Object

  • removeChoice(id: string): void
  • Removes a 'choice' that has been added with gtk_file_chooser_add_choice().

    Parameters

    • id: string

      the ID of the choice to remove

    Returns void

  • removeShortcutFolder(folder: Gio.File): boolean
  • runDispose(): void
  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • setAcceptLabel(acceptLabel: string): void
  • 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.

    Parameters

    • acceptLabel: string

      custom label

    Returns void

  • 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_FILE_CHOOSER_ACTION_SAVE but not if the action is %GTK_FILE_CHOOSER_ACTION_OPEN.

    Parameters

    Returns void

  • setCancelLabel(cancelLabel: string): void
  • 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.

    Parameters

    • cancelLabel: string

      custom label

    Returns void

  • setChoice(id: string, option: string): void
  • 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".

    Parameters

    • id: string

      the ID of the choice to set

    • option: string

      the ID of the option to select

    Returns void

  • setCreateFolders(createFolders: boolean): void
  • Sets whether file chooser will offer to create new folders.

    This is only relevant if the action is not set to be %GTK_FILE_CHOOSER_ACTION_OPEN.

    Parameters

    • createFolders: boolean

      %TRUE if the Create Folder button should be displayed

    Returns void

  • setCurrentFolder(file: Gio.File): boolean
  • setCurrentName(name: string): void
  • 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 [methodGtk.FileChooser.set_file] instead.

    Please see the documentation for those functions for an example of using [methodGtk.FileChooser.set_current_name] as well.

    Parameters

    • name: string

      the filename to use, as a UTF-8 string

    Returns void

  • setData(key: string, data?: object): void
  • 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 #GQuark 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 #GQuark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optional data: object

      data to associate with that key

    Returns void

  • 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_FILE_CHOOSER_ACTION_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);
    }
    }

    Parameters

    • file: Gio.File

      the GFile to set as current

    Returns boolean

  • 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.

    Parameters

    Returns void

  • setModal(modal: boolean): void
  • 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 [methodGtk.NativeDialog.set_transient_for] to make the dialog transient for the parent; most window managers will then disallow lowering the dialog below the parent.

    Parameters

    • modal: boolean

      whether the window is modal

    Returns void

  • setProperty(propertyName: string, value?: any): void
  • setSelectMultiple(selectMultiple: boolean): void
  • Sets whether multiple files can be selected in the file chooser.

    This is only relevant if the action is set to be %GTK_FILE_CHOOSER_ACTION_OPEN or %GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER.

    Parameters

    • selectMultiple: boolean

      %TRUE if multiple files can be selected.

    Returns void

  • setTitle(title: string): void
  • 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.

    Parameters

    Returns void

  • show(): void
  • Shows the dialog on the display.

    When the user accepts the state of the dialog the dialog will be automatically hidden and the [signalGtk.NativeDialog::response] signal will be emitted.

    Multiple calls while the dialog is visible will be ignored.

    Returns void

  • stealData(key?: string): object
  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • Optional key: string

      name of the key

    Returns object

  • stealQdata(quark: number): object
  • 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().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • thawNotify(): void
  • 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::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.

    Returns void

  • unref(): void
  • 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 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 instance. Use g_clear_object() for this.

    Returns void

  • watchClosure(closure: TClosure<any, any>): void
  • 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.

    Parameters

    • closure: TClosure<any, any>

      #GClosure to watch

    Returns void

  • compatControl(what: number, data: object): number
  • Find the #GParamSpec 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().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    • propertyName: string

      name of a property to look up.

    Returns ParamSpec

  • 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 #GParamSpec, 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 #GTypeInfo.) 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.

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface.

    • pspec: ParamSpec

      the #GParamSpec for the new property

    Returns void

  • 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().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    Returns ParamSpec[]

  • Creates a new GtkFileChooserNative.

    Parameters

    • title: string

      Title of the native

    • parent: Gtk.Window

      Transient parent of the native

    • action: Gtk.FileChooserAction

      Open or save mode for the dialog

    • acceptLabel: string

      text to go in the accept button, or %NULL for the default

    • cancelLabel: string

      text to go in the cancel button, or %NULL for the default

    Returns Gtk.FileChooserNative

  • Creates a new instance of a #GObject subtype and sets its properties.

    Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.

    Parameters

    • objectType: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method