Interface (GI Interface)

Gtk-3.0 ▶ Gtk ▶ FileChooser

Gtk.FileChooser is an interface that can be implemented by file selection widgets. In GTK+, the main objects that implement this interface are Gtk.FileChooserWidget, Gtk.FileChooserDialog, and Gtk.FileChooserButton. You do not need to write an object that implements the Gtk.FileChooser interface unless you are trying to adapt an existing file selector to expose a standard programming interface.

Gtk.FileChooser allows for shortcuts to various places in the filesystem. In the default implementation these are displayed in the left pane. It may be a bit confusing at first that these shortcuts come from various sources and in various flavours, so lets explain the terminology here:

  • Bookmarks: are created by the user, by dragging folders from the right pane to the left pane, or by using the “Add”. Bookmarks can be renamed and deleted by the user.

  • Shortcuts: can be provided by the application. For example, a Paint program may want to add a shortcut for a Clipart folder. Shortcuts cannot be modified by the user.

  • Volumes: are provided by the underlying filesystem abstraction. They are the “roots” of the filesystem.

File Names and Encodings

When the user is finished selecting files in a Gtk.FileChooser, your program can get the selected names either as filenames or as URIs. For URIs, the normal escaping rules are applied if the URI contains non-ASCII characters. However, filenames are always returned in the character set specified by the G_FILENAME_ENCODING environment variable. Please see the GLib documentation for more details about this variable.

This means that while you can pass the result of gtk_file_chooser_get_filename() to g_open() or g_fopen(), you may not be able to directly set it as the text of a Gtk.Label widget unless you convert it first to UTF-8, which all GTK+ widgets expect. You should use g_filename_to_utf8() to convert filenames into strings that can be passed to GTK+ widgets.

Adding a Preview Widget

You can add a custom preview widget to a file chooser and then get notification about when the preview needs to be updated. To install a preview widget, use gtk_file_chooser_set_preview_widget(). Then, connect to the Gtk.FileChooser.SignalSignatures.update_preview | Gtk.FileChooser::update-preview signal to get notified when you need to update the contents of the preview.

Your callback should use gtk_file_chooser_get_preview_filename() to see what needs previewing. Once you have generated the preview for the corresponding file, you must call gtk_file_chooser_set_preview_widget_active() with a boolean flag that indicates whether your callback could successfully generate a preview.

{
  GtkImage *preview;

  ...

  preview = gtk_image_new ();

  gtk_file_chooser_set_preview_widget (my_file_chooser, preview);
  g_signal_connect (my_file_chooser, "update-preview",
		    G_CALLBACK (update_preview_cb), preview);
}

static void
update_preview_cb (GtkFileChooser *file_chooser, gpointer data)
{
  GtkWidget *preview;
  char *filename;
  GdkPixbuf *pixbuf;
  gboolean have_preview;

  preview = GTK_WIDGET (data);
  filename = gtk_file_chooser_get_preview_filename (file_chooser);

  pixbuf = gdk_pixbuf_new_from_file_at_size (filename, 128, 128, NULL);
  have_preview = (pixbuf != NULL);
  g_free (filename);

  gtk_image_set_from_pixbuf (GTK_IMAGE (preview), pixbuf);
  if (pixbuf)
    g_object_unref (pixbuf);

  gtk_file_chooser_set_preview_widget_active (file_chooser, have_preview);
}

Adding Extra Widgets

You can add extra widgets to a file chooser to provide options that are not present in the default design. For example, you can add a toggle button to give the user the option to open a file in read-only mode. You can use gtk_file_chooser_set_extra_widget() to insert additional widgets in a file chooser.

An example for adding extra widgets:


  GtkWidget *toggle;

  ...

  toggle = gtk_check_button_new_with_label ("Open file read-only");
  gtk_widget_show (toggle);
  gtk_file_chooser_set_extra_widget (my_file_chooser, toggle);
}

If you want to set more than one extra widget in the file chooser, you can a container such as a Gtk.Box or a Gtk.Grid and include your widgets in it. Then, set the container as the whole extra widget.

interface FileChooser {
    $signals: GObject.Object.SignalSignatures;
    get action(): Gtk.FileChooserAction;
    set action(val: Gtk.FileChooserAction): void;
    get create_folders(): boolean;
    set create_folders(val: boolean): void;
    get createFolders(): boolean;
    set createFolders(val: boolean): void;
    get do_overwrite_confirmation(): boolean;
    set do_overwrite_confirmation(val: boolean): void;
    get doOverwriteConfirmation(): boolean;
    set doOverwriteConfirmation(val: boolean): void;
    get extra_widget(): Gtk.Widget;
    set extra_widget(val: Gtk.Widget): void;
    get extraWidget(): Gtk.Widget;
    set extraWidget(val: Gtk.Widget): void;
    get filter(): Gtk.FileFilter;
    set filter(val: Gtk.FileFilter): void;
    get local_only(): boolean;
    set local_only(val: boolean): void;
    get localOnly(): boolean;
    set localOnly(val: boolean): void;
    get preview_widget(): Gtk.Widget;
    set preview_widget(val: Gtk.Widget): void;
    get preview_widget_active(): boolean;
    set preview_widget_active(val: boolean): void;
    get previewWidget(): Gtk.Widget;
    set previewWidget(val: Gtk.Widget): void;
    get previewWidgetActive(): boolean;
    set previewWidgetActive(val: boolean): void;
    get select_multiple(): boolean;
    set select_multiple(val: boolean): void;
    get selectMultiple(): boolean;
    set selectMultiple(val: boolean): void;
    get show_hidden(): boolean;
    set show_hidden(val: boolean): void;
    get showHidden(): boolean;
    set showHidden(val: boolean): void;
    get use_preview_label(): boolean;
    set use_preview_label(val: boolean): void;
    get usePreviewLabel(): boolean;
    set usePreviewLabel(val: boolean): void;
    _init(...args: any[]): void;
    add_choice(
        id: string,
        label: string,
        options?: string[],
        option_labels?: string[],
    ): void;
    add_filter(filter: Gtk.FileFilter): void;
    add_shortcut_folder(folder: string): boolean;
    add_shortcut_folder_uri(uri: string): boolean;
    bind_property(
        source_property: string,
        target: GObject.Object,
        target_property: string,
        flags: GObject.BindingFlags,
    ): GObject.Binding;
    bind_property_full(
        source_property: string,
        target: GObject.Object,
        target_property: string,
        flags: GObject.BindingFlags,
        transform_to?: BindingTransformFunc,
        transform_from?: BindingTransformFunc,
        notify?: DestroyNotify,
    ): GObject.Binding;
    bind_property_full(
        source_property: string,
        target: GObject.Object,
        target_property: string,
        flags: GObject.BindingFlags,
        transform_to: Closure<any, any>,
        transform_from: Closure<any, any>,
    ): GObject.Binding;
    block_signal_handler(id: number): void;
    connect<K extends "notify">(
        signal: K,
        callback: SignalCallback<
            Gtk.FileChooser,
            GObject.Object.SignalSignatures[K],
        >,
    ): number;
    connect(signal: string, callback: (...args: any[]) => any): number;
    connect_after<K extends "notify">(
        signal: K,
        callback: SignalCallback<
            Gtk.FileChooser,
            GObject.Object.SignalSignatures[K],
        >,
    ): number;
    connect_after(signal: string, callback: (...args: any[]) => any): number;
    disconnect(id: number): void;
    emit<K extends "notify">(
        signal: K,
        ...args: GjsParameters<GObject.Object.SignalSignatures[K]> extends [
            any,
            ...Q[],
        ]
            ? Q
            : never,
    ): void;
    emit(signal: string, ...args: any[]): void;
    force_floating(): void;
    freeze_notify(): void;
    get_action(): Gtk.FileChooserAction;
    get_choice(id: string): string;
    get_create_folders(): boolean;
    get_current_folder(): string;
    get_current_folder_file(): Gio.File;
    get_current_folder_uri(): string;
    get_current_name(): string;
    get_data(key: string): any;
    get_do_overwrite_confirmation(): boolean;
    get_extra_widget(): Gtk.Widget;
    get_file(): Gio.File;
    get_filename(): string;
    get_filenames(): string[];
    get_files(): Gio.File[];
    get_filter(): Gtk.FileFilter;
    get_local_only(): boolean;
    get_preview_file(): Gio.File;
    get_preview_filename(): string;
    get_preview_uri(): string;
    get_preview_widget(): Gtk.Widget;
    get_preview_widget_active(): boolean;
    get_property(property_name: string, value: any): any;
    get_qdata(quark: number): any;
    get_select_multiple(): boolean;
    get_show_hidden(): boolean;
    get_uri(): string;
    get_uris(): string[];
    get_use_preview_label(): boolean;
    getv(names: string[], values: any[]): void;
    is_floating(): boolean;
    list_filters(): Gtk.FileFilter[];
    list_shortcut_folder_uris(): string[];
    list_shortcut_folders(): string[];
    notify(property_name: string): void;
    notify_by_pspec(pspec: GObject.ParamSpec): void;
    ref(): GObject.Object;
    ref_sink(): GObject.Object;
    remove_choice(id: string): void;
    remove_filter(filter: Gtk.FileFilter): void;
    remove_shortcut_folder(folder: string): boolean;
    remove_shortcut_folder_uri(uri: string): boolean;
    run_dispose(): void;
    select_all(): void;
    select_file(file: Gio.File): boolean;
    select_filename(filename: string): boolean;
    select_uri(uri: string): boolean;
    set(properties: { [key: string]: any }): void;
    set_action(action: Gtk.FileChooserAction): void;
    set_choice(id: string, option: string): void;
    set_create_folders(create_folders: boolean): void;
    set_current_folder(filename: string): boolean;
    set_current_folder_file(file: Gio.File): boolean;
    set_current_folder_uri(uri: string): boolean;
    set_current_name(name: string): void;
    set_data(key: string, data?: any): void;
    set_do_overwrite_confirmation(do_overwrite_confirmation: boolean): void;
    set_extra_widget(extra_widget: Gtk.Widget): void;
    set_file(file: Gio.File): boolean;
    set_filename(filename: string): boolean;
    set_filter(filter: Gtk.FileFilter): void;
    set_local_only(local_only: boolean): void;
    set_preview_widget(preview_widget: Gtk.Widget): void;
    set_preview_widget_active(active: boolean): void;
    set_property(property_name: string, value: any): void;
    set_select_multiple(select_multiple: boolean): void;
    set_show_hidden(show_hidden: boolean): void;
    set_uri(uri: string): boolean;
    set_use_preview_label(use_label: boolean): void;
    steal_data(key: string): any;
    steal_qdata(quark: number): any;
    stop_emission_by_name(detailedName: string): void;
    thaw_notify(): void;
    unblock_signal_handler(id: number): void;
    unref(): void;
    unselect_all(): void;
    unselect_file(file: Gio.File): void;
    unselect_filename(filename: string): void;
    unselect_uri(uri: string): void;
    vfunc_constructed(): void;
    vfunc_dispatch_properties_changed(
        n_pspecs: number,
        pspecs: GObject.ParamSpec,
    ): void;
    vfunc_dispose(): void;
    vfunc_finalize(): void;
    vfunc_get_property(
        property_id: number,
        value: any,
        pspec: GObject.ParamSpec,
    ): void;
    vfunc_notify(pspec: GObject.ParamSpec): void;
    vfunc_set_property(
        property_id: number,
        value: any,
        pspec: GObject.ParamSpec,
    ): void;
    watch_closure(closure: Closure): void;
}

Hierarchy (View Summary)

Implemented by

Index

Properties - Inherited from GObject

$signals

Accessors

action create_folders createFolders do_overwrite_confirmation doOverwriteConfirmation extra_widget extraWidget filter local_only localOnly preview_widget preview_widget_active previewWidget previewWidgetActive select_multiple selectMultiple show_hidden showHidden use_preview_label usePreviewLabel

Methods

add_choice add_filter add_shortcut_folder add_shortcut_folder_uri get_action get_choice get_create_folders get_current_folder get_current_folder_file get_current_folder_uri get_current_name get_do_overwrite_confirmation get_extra_widget get_file get_filename get_filenames get_files get_filter get_local_only get_preview_file get_preview_filename get_preview_uri get_preview_widget get_preview_widget_active get_select_multiple get_show_hidden get_uri get_uris get_use_preview_label list_filters list_shortcut_folder_uris list_shortcut_folders remove_choice remove_filter remove_shortcut_folder remove_shortcut_folder_uri select_all select_file select_filename select_uri set_action set_choice set_create_folders set_current_folder set_current_folder_file set_current_folder_uri set_current_name set_do_overwrite_confirmation set_extra_widget set_file set_filename set_filter set_local_only set_preview_widget set_preview_widget_active set_select_multiple set_show_hidden set_uri set_use_preview_label unselect_all unselect_file unselect_filename unselect_uri

Methods - Inherited from GObject

_init bind_property bind_property_full block_signal_handler connect connect_after disconnect emit force_floating freeze_notify get_data get_property get_qdata getv is_floating notify notify_by_pspec ref ref_sink run_dispose set set_data set_property steal_data steal_qdata stop_emission_by_name thaw_notify unblock_signal_handler unref vfunc_constructed vfunc_dispatch_properties_changed vfunc_dispose vfunc_finalize vfunc_get_property vfunc_notify vfunc_set_property watch_closure

Properties - Inherited from GObject

$signals: GObject.Object.SignalSignatures

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

Accessors

Methods

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

    Parameters

    • id: string

      id for the added choice

    • label: string

      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

    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, so you have to ref and sink it if you want to keep a reference.

    Parameters

    Returns void

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

    Parameters

    • folder: string

      filename of the folder to add

    Returns boolean

    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.

    Parameters

    • uri: string

      URI of the folder to add

    Returns boolean

    true if the folder could be added successfully, false otherwise. In the latter case, the error will be set as appropriate.

  • Gets the currently selected option in the 'choice' with the given ID.

    Parameters

    • id: string

      the ID of the choice to get

    Returns string

    the ID of the currenly selected option

  • Gets whether file choser will offer to create new folders. See gtk_file_chooser_set_create_folders().

    Returns boolean

    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.

    Returns string

    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.

    Returns string

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

    Returns string

    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.

  • Queries whether a file chooser is set to confirm for overwriting when the user types a file name that already exists.

    Returns boolean

    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.

    Returns Gio.File

    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.

    Returns string

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

    Returns string[]

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

    Returns Gio.File[]

    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 whether only local files can be selected in the file selector. See gtk_file_chooser_set_local_only()

    Returns boolean

    true if only local files can be selected.

  • Gets the Gio.File that should be previewed in a custom preview Internal function, see gtk_file_chooser_get_preview_uri().

    Returns Gio.File

    the Gio.File for the file to preview, or null if no file is selected. Free with g_object_unref().

  • Gets the filename that should be previewed in a custom preview widget. See gtk_file_chooser_set_preview_widget().

    Returns string

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

    Returns string

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

    Returns boolean

    true if the preview widget is active for the current filename.

  • Gets whether multiple files can be selected in the file selector. See gtk_file_chooser_set_select_multiple().

    Returns boolean

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

    Returns boolean

    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.

    Returns string

    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.

    Returns string[]

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

    Returns boolean

    true if the file chooser is set to display a label with the name of the previewed file, false otherwise.

  • Lists the current set of user-selectable filters; see gtk_file_chooser_add_filter(), gtk_file_chooser_remove_filter().

    Returns Gtk.FileFilter[]

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

    Returns string[]

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

    Returns string[]

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

  • 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

  • Removes a folder from a file chooser’s list of shortcut folders.

    Parameters

    • folder: string

      filename of the folder to remove

    Returns boolean

    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.

    Parameters

    • uri: string

      URI of the folder to remove

    Returns boolean

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

  • Selects the file referred to by file. An internal function. See _gtk_file_chooser_select_uri().

    Parameters

    Returns boolean

    Not useful.

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

    Parameters

    • filename: string

      the filename to select

    Returns boolean

    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.

    Parameters

    • uri: string

      the URI to select

    Returns boolean

    Not useful.

  • 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

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

    Parameters

    • create_folders: boolean

      true if the Create Folder button should be displayed

    Returns void

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

    Parameters

    • filename: string

      the full path of the new current folder

    Returns boolean

    Not useful.

  • Sets the current folder for chooser from a Gio.File. Internal function, see gtk_file_chooser_set_current_folder_uri().

    Parameters

    Returns boolean

    true if the folder could be changed successfully, false otherwise.

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

    Parameters

    • uri: string

      the URI for the new current folder

    Returns boolean

    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.

    Parameters

    • name: string

      the filename to use, as a UTF-8 string

    Returns void

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

    Parameters

    • do_overwrite_confirmation: boolean

      whether to confirm overwriting in save mode

    Returns void

  • Sets an application-supplied widget to provide extra options to the user.

    Parameters

    • extra_widget: Gtk.Widget

      widget for extra options

    Returns void

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

    Parameters

    Returns boolean

    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.

    Parameters

    • filename: string

      the filename to set as current

    Returns boolean

    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.

    Parameters

    Returns void

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

    Parameters

    • local_only: boolean

      true if only local files can be selected

    Returns void

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

    Parameters

    • preview_widget: Gtk.Widget

      widget for displaying preview.

    Returns void

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

    Parameters

    • active: boolean

      whether to display the user-specified preview widget

    Returns void

  • Sets whether hidden files and folders are displayed in the file selector.

    Parameters

    • show_hidden: boolean

      true if hidden files and folders should be displayed.

    Returns void

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

    Parameters

    • uri: string

      the URI to set as current

    Returns boolean

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

    Parameters

    • use_label: boolean

      whether to display a stock label with the name of the previewed file

    Returns void

  • Unselects all the files in the current folder of a file chooser.

    Returns void

  • Unselects the file referred to by file. If the file is not in the current directory, does not exist, or is otherwise not currently selected, does nothing.

    Parameters

    Returns void

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

    Parameters

    • filename: string

      the filename to unselect

    Returns void

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

    Parameters

    • uri: string

      the URI to unselect

    Returns void

Methods - Inherited from GObject

_init

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

    Parameters

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

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target GObject.Object

    • target_property: string

      the property on target to bind

    • flags: GObject.BindingFlags

      flags to pass to GObject.Binding

    • Optionaltransform_to: BindingTransformFunc

      the transformation function from the source to the target, or null to use the default

    • Optionaltransform_from: BindingTransformFunc

      the transformation function from the target to the source, or null to use the default

    • Optionalnotify: DestroyNotify

      a function to call when disposing the binding, to free resources used by the transformation functions, or null if not required

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

  • 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

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

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

    Parameters

    • id: number

      Handler ID of the handler to be disconnected

    Returns void

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

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

    Returns void

  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • key: string

      name of the key for that association

    Returns any

    the data if found, or null if no such data exists.

  • Gets a property of an object.

    The value can be:

    • an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a GObject.Value initialized with the expected type of the property
    • a GObject.Value 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 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.

    Parameters

    • property_name: string

      The name of the property to get

    • value: any

      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

    Returns any

  • This function gets back user data pointers stored via g_object_set_qdata().

    Parameters

    • quark: number

      A GLib.Quark, naming the user data pointer

    Returns any

    The user data pointer set, or null

  • 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

  • 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

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

      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]);

    Parameters

    Returns void

  • 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

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

    Returns GObject.Object

    object

  • 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

  • Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.

    Parameters

    • properties: { [key: string]: any }

      Object containing the properties to set

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

    Parameters

    • key: string

      name of the key

    • Optionaldata: any

      data to associate with that key

    Returns void

  • Sets a property on an object.

    Parameters

    • property_name: string

      The name of the property to set

    • value: any

      The value to set the property to

    Returns void

  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • key: string

      name of the key

    Returns any

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

    Parameters

    • quark: number

      A GLib.Quark, naming the user data pointer

    Returns any

    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.

    Parameters

    • detailedName: string

      Name of the signal to stop emission of

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

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

    Returns void

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

    Returns void

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

    Returns void

  • instance finalization function, should finish the finalization of the instance begun in dispose and chain up to the finalize method of the parent class.

    Returns 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

    Returns void

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

    Parameters

    Returns 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

    Returns void

Interfaces

ConstructorProps