Gjsify LogoGjsify Logo

A #GtkRecentAction represents a list of recently used files, which can be shown by widgets such as #GtkRecentChooserDialog or #GtkRecentChooserMenu.

To construct a submenu showing recently used files, use a #GtkRecentAction as the action for a <menuitem>. To construct a menu toolbutton showing the recently used files in the popup menu, use a #GtkRecentAction as the action for a <toolitem> element.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Properties

action_group: Gtk.ActionGroup

The GtkActionGroup this GtkAction is associated with, or NULL (for internal use).

always_show_image: boolean

If %TRUE, the action's menu item proxies will ignore the #GtkSettings:gtk-menu-images setting and always show their image, if available.

Use this property if the menu item would be useless or hard to use without their image.

The #GtkRecentFilter object to be used when displaying the recently used resources.

g_type_instance: TypeInstance
gicon: Gio.Icon

The #GIcon displayed in the #GtkAction.

Note that the stock icon is preferred, if the #GtkAction:stock-id property holds the id of an existing stock icon.

This is an appearance property and thus only applies if #GtkActivatable:use-action-appearance is %TRUE.

hide_if_empty: boolean

When TRUE, empty menu proxies for this action are hidden.

icon_name: string

The name of the icon from the icon theme.

Note that the stock icon is preferred, if the #GtkAction:stock-id property holds the id of an existing stock icon, and the #GIcon is preferred if the #GtkAction:gicon property is set.

This is an appearance property and thus only applies if #GtkActivatable:use-action-appearance is %TRUE.

is_important: boolean

Whether the action is considered important. When TRUE, toolitem proxies for this action show text in GTK_TOOLBAR_BOTH_HORIZ mode.

label: string

The label used for menu items and buttons that activate this action. If the label is %NULL, GTK+ uses the stock label specified via the stock-id property.

This is an appearance property and thus only applies if #GtkActivatable:use-action-appearance is %TRUE.

limit: number

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

local_only: boolean

Whether this #GtkRecentChooser should display only local (file:) resources.

name: string

A unique name for the action.

object: GObject.Object
parent_instance: Gtk.Action
recent_manager: Gtk.RecentManager

The #GtkRecentManager instance used by the #GtkRecentChooser to display the list of recently used resources.

select_multiple: boolean

Allow the user to select multiple resources.

sensitive: boolean

Whether the action is enabled.

short_label: string

A shorter label that may be used on toolbar buttons.

This is an appearance property and thus only applies if #GtkActivatable:use-action-appearance is %TRUE.

show_icons: boolean

Whether this #GtkRecentChooser should display an icon near the item.

show_not_found: boolean

Whether this #GtkRecentChooser 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).

show_numbers: boolean

Whether the items should be displayed with a number.

show_private: boolean
show_tips: boolean

Whether this #GtkRecentChooser should display a tooltip containing the full path of the recently used resources.

sort_type: Gtk.RecentSortType

Sorting order to be used when displaying the recently used resources.

stock_id: string

The stock icon displayed in widgets representing this action.

This is an appearance property and thus only applies if #GtkActivatable:use-action-appearance is %TRUE.

tooltip: string

A tooltip for this action.

visible: boolean

Whether the action is visible.

visible_horizontal: boolean

Whether the toolbar item is visible when the toolbar is in a horizontal orientation.

visible_overflown: boolean

When %TRUE, toolitem proxies for this action are represented in the toolbar overflow menu.

visible_vertical: boolean

Whether the toolbar item is visible when the toolbar is in a vertical orientation.

name: string

Methods

  • activate(): void
  • Emits the “activate” signal on the specified action, if it isn't insensitive. This gets called by the proxy widgets when they get activated.

    It can also be used to manually activate an action.

    Returns void

  • 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

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

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

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transform_to: TClosure<any, any>

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

    • transform_from: TClosure<any, any>

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

    Returns Binding

  • block_activate(): void
  • Disable activation signals from the action

    This is needed when updating the state of your proxy #GtkActivatable widget could result in calling gtk_action_activate(), this is a convenience function to avoid recursing in those cases (updating toggle state for instance).

    Returns void

  • connect_accelerator(): void
  • Installs the accelerator for action if action has an accel path and group. See gtk_action_set_accel_path() and gtk_action_set_accel_group()

    Since multiple proxies may independently trigger the installation of the accelerator, the action counts the number of times this function has been called and doesn’t remove the accelerator until gtk_action_disconnect_accelerator() has been called as many times.

    Returns void

  • Constructs a child of buildable with the name name.

    #GtkBuilder calls this function if a “constructor” has been specified in the UI definition.

    Parameters

    • builder: Gtk.Builder

      #GtkBuilder used to construct this object

    • name: string

      name of child to construct

    Returns GObject.Object

  • This function is intended for use by action implementations to create icons displayed in the proxy widgets.

    Parameters

    • icon_size: number

      the size of the icon (#GtkIconSize) that should be created.

    Returns Gtk.Widget

  • This is similar to gtk_buildable_parser_finished() but is called once for each custom tag handled by the buildable.

    Parameters

    • builder: Gtk.Builder

      a #GtkBuilder

    • child: GObject.Object

      child object or %NULL for non-child tags

    • tagname: string

      the name of the tag

    • data: object

      user data created in custom_tag_start

    Returns void

  • This is called at the end of each custom element handled by the buildable.

    Parameters

    • builder: Gtk.Builder

      #GtkBuilder used to construct this object

    • child: GObject.Object

      child object or %NULL for non-child tags

    • tagname: string

      name of tag

    • data: object

      user data that will be passed in to parser functions

    Returns void

  • disconnect(id: number): void
  • disconnect_accelerator(): void
  • emit(sigName: "notify::show-numbers", ...args: any[]): void
  • emit(sigName: "notify::action-group", ...args: any[]): void
  • emit(sigName: "notify::always-show-image", ...args: any[]): void
  • emit(sigName: "notify::gicon", ...args: any[]): void
  • emit(sigName: "notify::hide-if-empty", ...args: any[]): void
  • emit(sigName: "notify::icon-name", ...args: any[]): void
  • emit(sigName: "notify::is-important", ...args: any[]): void
  • emit(sigName: "notify::label", ...args: any[]): void
  • emit(sigName: "notify::name", ...args: any[]): void
  • emit(sigName: "notify::sensitive", ...args: any[]): void
  • emit(sigName: "notify::short-label", ...args: any[]): void
  • emit(sigName: "notify::stock-id", ...args: any[]): void
  • emit(sigName: "notify::tooltip", ...args: any[]): void
  • emit(sigName: "notify::visible", ...args: any[]): void
  • emit(sigName: "notify::visible-horizontal", ...args: any[]): void
  • emit(sigName: "notify::visible-overflown", ...args: any[]): void
  • emit(sigName: "notify::visible-vertical", ...args: any[]): void
  • emit(sigName: "notify::filter", ...args: any[]): void
  • emit(sigName: "notify::limit", ...args: any[]): void
  • emit(sigName: "notify::local-only", ...args: any[]): void
  • emit(sigName: "notify::recent-manager", ...args: any[]): void
  • emit(sigName: "notify::select-multiple", ...args: any[]): void
  • emit(sigName: "notify::show-icons", ...args: any[]): void
  • emit(sigName: "notify::show-not-found", ...args: any[]): void
  • emit(sigName: "notify::show-private", ...args: any[]): void
  • emit(sigName: "notify::show-tips", ...args: any[]): void
  • emit(sigName: "notify::sort-type", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • force_floating(): 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

  • freeze_notify(): 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

  • get_accel_path(): string
  • get_always_show_image(): boolean
  • get_current_uri(): string
  • get_data(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

  • get_icon_name(): string
  • get_is_important(): boolean
  • get_label(): string
  • get_limit(): number
  • get_local_only(): boolean
  • get_name(): string
  • get_property(property_name?: 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 property_name: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • get_qdata(quark: number): object
  • get_select_multiple(): boolean
  • get_sensitive(): boolean
  • Returns whether the action itself is sensitive. Note that this doesn’t necessarily mean effective sensitivity. See gtk_action_is_sensitive() for that.

    Returns boolean

  • get_short_label(): string
  • get_show_icons(): boolean
  • get_show_not_found(): boolean
  • get_show_numbers(): boolean
  • get_show_private(): boolean
  • get_show_tips(): boolean
  • get_stock_id(): string
  • get_tooltip(): string
  • get_uris(): string[]
  • 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[]

  • get_visible(): boolean
  • Returns whether the action itself is visible. Note that this doesn’t necessarily mean effective visibility. See gtk_action_is_sensitive() for that.

    Returns boolean

  • get_visible_horizontal(): boolean
  • get_visible_vertical(): 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

  • is_floating(): boolean
  • is_sensitive(): boolean
  • is_visible(): boolean
  • notify(property_name: 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

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

      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

  • Called when the builder finishes the parsing of a [GtkBuilder UI definition][BUILDER-UI]. Note that this will be called once for each time gtk_builder_add_from_file() or gtk_builder_add_from_string() is called on a builder.

    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

  • 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

  • run_dispose(): 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

  • select_all(): void
  • select_uri(uri: string): boolean
  • set_accel_path(accel_path: string): void
  • Sets the accel path for this action. All proxy widgets associated with the action will have this accel path, so that their accelerators are consistent.

    Note that accel_path string will be stored in a #GQuark. Therefore, if you pass a static string, you can save some memory by interning it first with g_intern_static_string().

    Parameters

    • accel_path: string

      the accelerator path

    Returns void

  • set_always_show_image(always_show: boolean): void
  • Sets whether action's menu item proxies will ignore the #GtkSettings:gtk-menu-images setting and always show their image, if available.

    Use this if the menu item would be useless or hard to use without their image.

    Parameters

    • always_show: boolean

      %TRUE if menuitem proxies should always show their image

    Returns void

  • set_buildable_property(builder: Gtk.Builder, name: string, value: any): void
  • set_current_uri(uri: string): boolean
  • set_data(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

  • set_icon_name(icon_name: string): void
  • set_is_important(is_important: boolean): void
  • Sets whether the action is important, this attribute is used primarily by toolbar items to decide whether to show a label or not.

    Parameters

    • is_important: boolean

      %TRUE to make the action important

    Returns void

  • set_label(label: string): void
  • set_limit(limit: number): void
  • 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

  • set_local_only(local_only: boolean): 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

  • set_name(name: string): void
  • set_property(property_name: string, value?: any): void
  • set_select_multiple(select_multiple: boolean): void
  • set_sensitive(sensitive: boolean): void
  • Sets the :sensitive property of the action to sensitive. Note that this doesn’t necessarily mean effective sensitivity. See gtk_action_is_sensitive() for that.

    Parameters

    • sensitive: boolean

      %TRUE to make the action sensitive

    Returns void

  • set_short_label(short_label: string): void
  • set_show_icons(show_icons: boolean): void
  • set_show_not_found(show_not_found: boolean): 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

  • set_show_numbers(show_numbers: boolean): void
  • Sets whether a number should be added to the items shown by the widgets representing action. The numbers are shown to provide a unique character for a mnemonic to be used inside the menu item's label. Only the first ten items get a number to avoid clashes.

    Parameters

    • show_numbers: boolean

      %TRUE if the shown items should be numbered

    Returns void

  • set_show_private(show_private: boolean): void
  • set_show_tips(show_tips: boolean): void
  • Sets whether to show a tooltips containing the full path of each recently used resource in a #GtkRecentChooser 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 #GtkRecentInfo 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

  • set_stock_id(stock_id: string): void
  • set_tooltip(tooltip: string): void
  • set_visible(visible: boolean): void
  • Sets the :visible property of the action to visible. Note that this doesn’t necessarily mean effective visibility. See gtk_action_is_visible() for that.

    Parameters

    • visible: boolean

      %TRUE to make the action visible

    Returns void

  • set_visible_horizontal(visible_horizontal: boolean): void
  • set_visible_vertical(visible_vertical: boolean): void
  • steal_data(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

  • steal_qdata(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

  • thaw_notify(): 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

  • unblock_activate(): 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

  • unselect_all(): void
  • unselect_uri(uri: string): void
  • vfunc_activate(): void
  • Emits the “activate” signal on the specified action, if it isn't insensitive. This gets called by the proxy widgets when they get activated.

    It can also be used to manually activate an action.

    virtual

    Returns void

  • vfunc_constructed(): void
  • This is similar to gtk_buildable_parser_finished() but is called once for each custom tag handled by the buildable.

    virtual

    Parameters

    • builder: Gtk.Builder

      a #GtkBuilder

    • child: GObject.Object

      child object or %NULL for non-child tags

    • tagname: string

      the name of the tag

    • data: object

      user data created in custom_tag_start

    Returns void

  • This is called at the end of each custom element handled by the buildable.

    virtual

    Parameters

    • builder: Gtk.Builder

      #GtkBuilder used to construct this object

    • child: GObject.Object

      child object or %NULL for non-child tags

    • tagname: string

      name of tag

    • data: object

      user data that will be passed in to parser functions

    Returns void

  • vfunc_disconnect_proxy(proxy: Gtk.Widget): void
  • vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void
  • vfunc_dispose(): void
  • vfunc_finalize(): void
  • vfunc_get_current_uri(): string
  • vfunc_get_name(): string
  • Gets the name of the buildable object.

    #GtkBuilder sets the name based on the [GtkBuilder UI definition][BUILDER-UI] used to construct the buildable.

    virtual

    Returns string

  • vfunc_get_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • vfunc_item_activated(): 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.

    virtual

    Parameters

    Returns void

  • Called when the builder finishes the parsing of a [GtkBuilder UI definition][BUILDER-UI]. Note that this will be called once for each time gtk_builder_add_from_file() or gtk_builder_add_from_string() is called on a builder.

    virtual

    Parameters

    Returns void

  • vfunc_select_all(): void
  • vfunc_select_uri(uri: string): boolean
  • vfunc_selection_changed(): void
  • vfunc_set_buildable_property(builder: Gtk.Builder, name: string, value: any): void
  • vfunc_set_current_uri(uri: string): boolean
  • vfunc_set_name(name: string): void
  • vfunc_set_property(property_id: number, value?: any, pspec?: ParamSpec): 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 #GtkRecentInfo 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.

    virtual

    Parameters

    Returns void

  • vfunc_unselect_all(): void
  • vfunc_unselect_uri(uri: string): void
  • watch_closure(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

  • compat_control(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

    • g_iface: TypeInterface

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

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

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

    • g_iface: TypeInterface

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

    Returns ParamSpec[]

  • new(name: string, label: string, tooltip: string, stock_id: string): Gtk.RecentAction
  • Creates a new #GtkRecentAction object. To add the action to a #GtkActionGroup and set the accelerator for the action, call gtk_action_group_add_action_with_accel().

    Parameters

    • name: string

      a unique name for the action

    • label: string

      the label displayed in menu items and on buttons, or %NULL

    • tooltip: string

      a tooltip for the action, or %NULL

    • stock_id: string

      the stock icon to display in widgets representing the action, or %NULL

    Returns Gtk.RecentAction

  • Creates a new #GtkRecentAction object. To add the action to a #GtkActionGroup and set the accelerator for the action, call gtk_action_group_add_action_with_accel().

    Parameters

    • name: string

      a unique name for the action

    • label: string

      the label displayed in menu items and on buttons, or %NULL

    • tooltip: string

      a tooltip for the action, or %NULL

    • stock_id: string

      the stock icon to display in widgets representing the action, or %NULL

    • manager: Gtk.RecentManager

      a #GtkRecentManager, or %NULL for using the default #GtkRecentManager

    Returns Gtk.RecentAction

  • 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

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