Interface (GI Interface)

Gtk-3.0GtkRecentChooser

Gtk.RecentChooser is an interface that can be implemented by widgets displaying the list of recently used files. In GTK+, the main objects that implement this interface are Gtk.RecentChooserWidget, Gtk.RecentChooserDialog and Gtk.RecentChooserMenu.

Recently used files are supported since GTK+ 2.10.

interface RecentChooser {
    $signals: GObject.Object.SignalSignatures;
    get filter(): Gtk.RecentFilter;
    set filter(val: Gtk.RecentFilter): void;
    get limit(): number;
    set limit(val: number): void;
    get local_only(): boolean;
    set local_only(val: boolean): void;
    get localOnly(): boolean;
    set localOnly(val: boolean): void;
    set recent_manager(val: Gtk.RecentManager): void;
    set recentManager(val: Gtk.RecentManager): void;
    get select_multiple(): boolean;
    set select_multiple(val: boolean): void;
    get selectMultiple(): boolean;
    set selectMultiple(val: boolean): void;
    get show_icons(): boolean;
    set show_icons(val: boolean): void;
    get show_not_found(): boolean;
    set show_not_found(val: boolean): void;
    get show_private(): boolean;
    set show_private(val: boolean): void;
    get show_tips(): boolean;
    set show_tips(val: boolean): void;
    get showIcons(): boolean;
    set showIcons(val: boolean): void;
    get showNotFound(): boolean;
    set showNotFound(val: boolean): void;
    get showPrivate(): boolean;
    set showPrivate(val: boolean): void;
    get showTips(): boolean;
    set showTips(val: boolean): void;
    get sort_type(): Gtk.RecentSortType;
    set sort_type(val: Gtk.RecentSortType): void;
    get sortType(): Gtk.RecentSortType;
    set sortType(val: Gtk.RecentSortType): void;
    _init(...args: any[]): void;
    add_filter(filter: Gtk.RecentFilter): void;
    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.RecentChooser,
            GObject.Object.SignalSignatures[K],
        >,
    ): number;
    connect(signal: string, callback: (...args: any[]) => any): number;
    connect_after<K extends "notify">(
        signal: K,
        callback: SignalCallback<
            Gtk.RecentChooser,
            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_current_item(): Gtk.RecentInfo;
    get_current_uri(): string;
    get_data(key: string): any;
    get_filter(): Gtk.RecentFilter;
    get_items(): Gtk.RecentInfo[];
    get_limit(): number;
    get_local_only(): boolean;
    get_property(property_name: string, value: any): any;
    get_qdata(quark: number): any;
    get_select_multiple(): boolean;
    get_show_icons(): boolean;
    get_show_not_found(): boolean;
    get_show_private(): boolean;
    get_show_tips(): boolean;
    get_sort_type(): Gtk.RecentSortType;
    get_uris(): string[];
    getv(names: string[], values: any[]): void;
    is_floating(): boolean;
    list_filters(): Gtk.RecentFilter[];
    notify(property_name: string): void;
    notify_by_pspec(pspec: GObject.ParamSpec): void;
    ref(): GObject.Object;
    ref_sink(): GObject.Object;
    remove_filter(filter: Gtk.RecentFilter): void;
    run_dispose(): void;
    select_all(): void;
    select_uri(uri: string): boolean;
    set(properties: { [key: string]: any }): void;
    set_current_uri(uri: string): boolean;
    set_data(key: string, data?: any): void;
    set_filter(filter?: Gtk.RecentFilter): void;
    set_limit(limit: number): void;
    set_local_only(local_only: boolean): void;
    set_property(property_name: string, value: any): void;
    set_select_multiple(select_multiple: boolean): void;
    set_show_icons(show_icons: boolean): void;
    set_show_not_found(show_not_found: boolean): void;
    set_show_private(show_private: boolean): void;
    set_show_tips(show_tips: boolean): void;
    set_sort_func(
        sort_func: RecentSortFunc,
        data_destroy?: DestroyNotify,
    ): void;
    set_sort_type(sort_type: Gtk.RecentSortType): 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_uri(uri: string): void;
    vfunc_add_filter(filter: Gtk.RecentFilter): void;
    vfunc_constructed(): void;
    vfunc_dispatch_properties_changed(
        n_pspecs: number,
        pspecs: GObject.ParamSpec,
    ): void;
    vfunc_dispose(): void;
    vfunc_finalize(): void;
    vfunc_get_current_uri(): string;
    vfunc_get_items(): Gtk.RecentInfo[];
    vfunc_get_property(
        property_id: number,
        value: any,
        pspec: GObject.ParamSpec,
    ): void;
    vfunc_item_activated(): void;
    vfunc_list_filters(): Gtk.RecentFilter[];
    vfunc_notify(pspec: GObject.ParamSpec): void;
    vfunc_remove_filter(filter: Gtk.RecentFilter): void;
    vfunc_select_all(): void;
    vfunc_select_uri(uri: string): boolean;
    vfunc_selection_changed(): void;
    vfunc_set_current_uri(uri: string): boolean;
    vfunc_set_property(
        property_id: number,
        value: any,
        pspec: GObject.ParamSpec,
    ): void;
    vfunc_set_sort_func(
        sort_func: RecentSortFunc,
        data_destroy?: DestroyNotify,
    ): void;
    vfunc_unselect_all(): void;
    vfunc_unselect_uri(uri: string): void;
    watch_closure(closure: Closure): void;
}

Hierarchy (View Summary)

Implemented by

Index

Properties - Inherited from GObject

Accessors

Methods

Methods - Inherited from GObject

Methods - Inherited from Gtk.RecentChooser.Interface

Properties - Inherited from GObject

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

  • get limit(): number

    The maximum number of recently used resources to be displayed, or -1 to display all items.

    Returns number

    2.10

  • set limit(val: number): void

    Parameters

    • val: number

    Returns void

  • get show_not_found(): boolean

    Whether this Gtk.RecentChooser should display the recently used resources even if not present anymore. Setting this to false will perform a potentially expensive check on every local resource (every remote resource will always be displayed).

    Returns boolean

    2.10

  • set show_not_found(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get showNotFound(): boolean

    Whether this Gtk.RecentChooser should display the recently used resources even if not present anymore. Setting this to false will perform a potentially expensive check on every local resource (every remote resource will always be displayed).

    Returns boolean

    2.10

  • set showNotFound(val: boolean): void

    Parameters

    • val: boolean

    Returns void

Methods

  • Gets the URI currently selected by chooser.

    Returns string

    a newly allocated string holding a URI.

  • Gets the list of recently used resources in form of Gtk.RecentInfo objects.

    The return value of this function is affected by the “sort-type” and “limit” properties of chooser.

    Returns Gtk.RecentInfo[]

    A newly allocated list of Gtk.RecentInfo objects. You should use gtk_recent_info_unref() on every item of the list, and then free the list itself using g_list_free().

  • Gets the number of items returned by gtk_recent_chooser_get_items() and gtk_recent_chooser_get_uris().

    Returns number

    A positive integer, or -1 meaning that all items are returned.

  • Gets whether only local resources should be shown in the recently used resources selector. See gtk_recent_chooser_set_local_only()

    Returns boolean

    true if only local resources should be shown.

  • Gets whether chooser can select multiple items.

    Returns boolean

    true if chooser can select more than one item.

  • Retrieves whether chooser should show an icon near the resource.

    Returns boolean

    true if the icons should be displayed, false otherwise.

  • Retrieves whether chooser should show the recently used resources that were not found.

    Returns boolean

    true if the resources not found should be displayed, and false otheriwse.

  • Returns whether chooser should display recently used resources registered as private.

    Returns boolean

    true if the recent chooser should show private items, false otherwise.

  • Gets whether chooser should display tooltips containing the full path of a recently user resource.

    Returns boolean

    true if the recent chooser should show tooltips, false otherwise.

  • Gets the URI of the recently used resources.

    The return value of this function is affected by the “sort-type” and “limit” properties of chooser.

    Since the returned array is null terminated, length may be null.

    Returns string[]

    A newly allocated, null-terminated array of strings. Use g_strfreev() to free it.

  • Selects all the items inside chooser, if the chooser supports multiple selection.

    Returns void

  • Selects uri inside chooser.

    Parameters

    • uri: string

      a URI

    Returns boolean

    true if uri was found.

  • Sets uri as the current URI for chooser.

    Parameters

    • uri: string

      a URI

    Returns boolean

    true if the URI was found.

  • Sets the number of items that should be returned by gtk_recent_chooser_get_items() and gtk_recent_chooser_get_uris().

    Parameters

    • limit: number

      a positive integer, or -1 for all items

    Returns void

  • Sets whether only local resources, that is resources using the file:// URI scheme, should be shown in the recently used resources selector. If local_only is true (the default) then the shown resources are guaranteed to be accessible through the operating system native file system.

    Parameters

    • local_only: boolean

      true if only local files can be shown

    Returns void

  • Sets whether chooser can select multiple items.

    Parameters

    • select_multiple: boolean

      true if chooser can select more than one item

    Returns void

  • Sets whether chooser should show an icon near the resource when displaying it.

    Parameters

    • show_icons: boolean

      whether to show an icon near the resource

    Returns void

  • Sets whether chooser should display the recently used resources that it didn’t find. This only applies to local resources.

    Parameters

    • show_not_found: boolean

      whether to show the local items we didn’t find

    Returns void

  • Whether to show recently used resources marked registered as private.

    Parameters

    • show_private: boolean

      true to show private items, false otherwise

    Returns void

  • Sets whether to show a tooltips containing the full path of each recently used resource in a Gtk.RecentChooser widget.

    Parameters

    • show_tips: boolean

      true if tooltips should be shown

    Returns void

  • Sets the comparison function used when sorting to be sort_func. If the chooser has the sort type set to #GTK_RECENT_SORT_CUSTOM then the chooser will sort using this function.

    To the comparison function will be passed two Gtk.RecentInfo structs and sort_data; sort_func should return a positive integer if the first item comes before the second, zero if the two items are equal and a negative integer if the first item comes after the second.

    Parameters

    Returns void

  • Unselects uri inside chooser.

    Parameters

    • uri: string

      a URI

    Returns void

Methods - Inherited from GObject

  • 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

Methods - Inherited from Gtk.RecentChooser.Interface

  • Sets the comparison function used when sorting to be sort_func. If the chooser has the sort type set to #GTK_RECENT_SORT_CUSTOM then the chooser will sort using this function.

    To the comparison function will be passed two Gtk.RecentInfo structs and sort_data; sort_func should return a positive integer if the first item comes before the second, zero if the two items are equal and a negative integer if the first item comes after the second.

    Parameters

    Returns void

Interfaces

ConstructorProps
Interface