Gjsify LogoGjsify Logo

The GRemoteActionGroup interface is implemented by #GActionGroup instances that either transmit action invocations to other processes or receive action invocations in the local process from other processes.

The interface has _full variants of the two methods on #GActionGroup used to activate actions: g_action_group_activate_action() and g_action_group_change_action_state(). These variants allow a "platform data" #GVariant to be specified: a dictionary providing context for the action invocation (for example: timestamps, startup notification IDs, etc).

#GDBusActionGroup implements #GRemoteActionGroup. This provides a mechanism to send platform data for action invocations over D-Bus.

Additionally, g_dbus_connection_export_action_group() will check if the exported #GActionGroup implements #GRemoteActionGroup and use the _full variants of the calls if available. This provides a mechanism by which to receive platform data for action invocations that arrive by way of D-Bus.

interface

Hierarchy

Index

Constructors

Properties

g_type_instance: TypeInstance
name: string

Methods

  • action_added(action_name: string): void
  • Emits the #GActionGroup::action-added signal on action_group.

    This function should only be called by #GActionGroup implementations.

    Parameters

    • action_name: string

      the name of an action in the group

    Returns void

  • action_enabled_changed(action_name: string, enabled: boolean): void
  • Emits the #GActionGroup::action-enabled-changed signal on action_group.

    This function should only be called by #GActionGroup implementations.

    Parameters

    • action_name: string

      the name of an action in the group

    • enabled: boolean

      whether or not the action is now enabled

    Returns void

  • action_removed(action_name: string): void
  • Emits the #GActionGroup::action-removed signal on action_group.

    This function should only be called by #GActionGroup implementations.

    Parameters

    • action_name: string

      the name of an action in the group

    Returns void

  • action_state_changed(action_name: string, state: GLib.Variant): void
  • Emits the #GActionGroup::action-state-changed signal on action_group.

    This function should only be called by #GActionGroup implementations.

    Parameters

    • action_name: string

      the name of an action in the group

    • state: GLib.Variant

      the new state of the named action

    Returns void

  • activate_action(action_name: string, parameter: GLib.Variant): void
  • Activate the named action within action_group.

    If the action is expecting a parameter, then the correct type of parameter must be given as parameter. If the action is expecting no parameters then parameter must be %NULL. See g_action_group_get_action_parameter_type().

    If the #GActionGroup implementation supports asynchronous remote activation over D-Bus, this call may return before the relevant D-Bus traffic has been sent, or any replies have been received. In order to block on such asynchronous activation calls, g_dbus_connection_flush() should be called prior to the code, which depends on the result of the action activation. Without flushing the D-Bus connection, there is no guarantee that the action would have been activated.

    The following code which runs in a remote app instance, shows an example of a "quit" action being activated on the primary app instance over D-Bus. Here g_dbus_connection_flush() is called before exit(). Without g_dbus_connection_flush(), the "quit" action may fail to be activated on the primary instance.

    // call "quit" action on primary instance
    g_action_group_activate_action (G_ACTION_GROUP (app), "quit", NULL);

    // make sure the action is activated now
    g_dbus_connection_flush (...);

    g_debug ("application has been terminated. exiting.");

    exit (0);

    Parameters

    • action_name: string

      the name of the action to activate

    • parameter: GLib.Variant

      parameters to the activation

    Returns void

  • Activates the remote action.

    This is the same as g_action_group_activate_action() except that it allows for provision of "platform data" to be sent along with the activation request. This typically contains details such as the user interaction timestamp or startup notification information.

    platform_data must be non-%NULL and must have the type %G_VARIANT_TYPE_VARDICT. If it is floating, it will be consumed.

    Parameters

    • action_name: string

      the name of the action to activate

    • parameter: GLib.Variant

      the optional parameter to the activation

    • platform_data: GLib.Variant

      the platform data to send

    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

  • change_action_state(action_name: string, value: GLib.Variant): void
  • Request for the state of the named action within action_group to be changed to value.

    The action must be stateful and value must be of the correct type. See g_action_group_get_action_state_type().

    This call merely requests a change. The action may refuse to change its state or may change its state to something other than value. See g_action_group_get_action_state_hint().

    If the value GVariant is floating, it is consumed.

    Parameters

    • action_name: string

      the name of the action to request the change on

    • value: GLib.Variant

      the new state

    Returns void

  • Changes the state of a remote action.

    This is the same as g_action_group_change_action_state() except that it allows for provision of "platform data" to be sent along with the state change request. This typically contains details such as the user interaction timestamp or startup notification information.

    platform_data must be non-%NULL and must have the type %G_VARIANT_TYPE_VARDICT. If it is floating, it will be consumed.

    Parameters

    • action_name: string

      the name of the action to change the state of

    • value: GLib.Variant

      the new requested value for the state

    • platform_data: GLib.Variant

      the platform data to send

    Returns void

  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • connect_after(sigName: string, callback: ((...args: any[]) => void)): number
  • disconnect(id: number): 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_action_enabled(action_name: string): boolean
  • Checks if the named action within action_group is currently enabled.

    An action must be enabled in order to be activated or in order to have its state changed from outside callers.

    Parameters

    • action_name: string

      the name of the action to query

    Returns boolean

  • get_action_parameter_type(action_name: string): VariantType
  • Queries the type of the parameter that must be given when activating the named action within action_group.

    When activating the action using g_action_group_activate_action(), the #GVariant given to that function must be of the type returned by this function.

    In the case that this function returns %NULL, you must not give any #GVariant, but %NULL instead.

    The parameter type of a particular action will never change but it is possible for an action to be removed and for a new action to be added with the same name but a different parameter type.

    Parameters

    • action_name: string

      the name of the action to query

    Returns VariantType

  • Queries the current state of the named action within action_group.

    If the action is not stateful then %NULL will be returned. If the action is stateful then the type of the return value is the type given by g_action_group_get_action_state_type().

    The return value (if non-%NULL) should be freed with g_variant_unref() when it is no longer required.

    Parameters

    • action_name: string

      the name of the action to query

    Returns GLib.Variant

  • get_action_state_hint(action_name: string): GLib.Variant
  • Requests a hint about the valid range of values for the state of the named action within action_group.

    If %NULL is returned it either means that the action is not stateful or that there is no hint about the valid range of values for the state of the action.

    If a #GVariant array is returned then each item in the array is a possible value for the state. If a #GVariant pair (ie: two-tuple) is returned then the tuple specifies the inclusive lower and upper bound of valid values for the state.

    In any case, the information is merely a hint. It may be possible to have a state value outside of the hinted range and setting a value within the range may fail.

    The return value (if non-%NULL) should be freed with g_variant_unref() when it is no longer required.

    Parameters

    • action_name: string

      the name of the action to query

    Returns GLib.Variant

  • get_action_state_type(action_name: string): VariantType
  • Queries the type of the state of the named action within action_group.

    If the action is stateful then this function returns the #GVariantType of the state. All calls to g_action_group_change_action_state() must give a #GVariant of this type and g_action_group_get_action_state() will return a #GVariant of the same type.

    If the action is not stateful then this function will return %NULL. In that case, g_action_group_get_action_state() will return %NULL and you must not call g_action_group_change_action_state().

    The state type of a particular action will never change but it is possible for an action to be removed and for a new action to be added with the same name but a different state type.

    Parameters

    • action_name: string

      the name of the action to query

    Returns VariantType

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

  • has_action(action_name: string): boolean
  • is_floating(): boolean
  • list_actions(): string[]
  • 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

  • Queries all aspects of the named action within an action_group.

    This function acquires the information available from g_action_group_has_action(), g_action_group_get_action_enabled(), g_action_group_get_action_parameter_type(), g_action_group_get_action_state_type(), g_action_group_get_action_state_hint() and g_action_group_get_action_state() with a single function call.

    This provides two main benefits.

    The first is the improvement in efficiency that comes with not having to perform repeated lookups of the action in order to discover different things about it. The second is that implementing #GActionGroup can now be done by only overriding this one virtual function.

    The interface provides a default implementation of this function that calls the individual functions, as required, to fetch the information. The interface also provides default implementations of those functions that call this function. All implementations, therefore, must override either this function or all of the others.

    If the action exists, %TRUE is returned and any of the requested fields (as indicated by having a non-%NULL reference passed in) are filled. If the action doesn't exist, %FALSE is returned and the fields may or may not have been modified.

    Parameters

    • action_name: string

      the name of an action in the group

    Returns [boolean, boolean, VariantType, VariantType, GLib.Variant, GLib.Variant]

  • 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

  • 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_property(property_name: string, value?: any): 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

  • 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

  • vfunc_action_added(action_name: string): void
  • Emits the #GActionGroup::action-added signal on action_group.

    This function should only be called by #GActionGroup implementations.

    virtual

    Parameters

    • action_name: string

      the name of an action in the group

    Returns void

  • vfunc_action_enabled_changed(action_name: string, enabled: boolean): void
  • Emits the #GActionGroup::action-enabled-changed signal on action_group.

    This function should only be called by #GActionGroup implementations.

    virtual

    Parameters

    • action_name: string

      the name of an action in the group

    • enabled: boolean

      whether or not the action is now enabled

    Returns void

  • vfunc_action_removed(action_name: string): void
  • Emits the #GActionGroup::action-removed signal on action_group.

    This function should only be called by #GActionGroup implementations.

    virtual

    Parameters

    • action_name: string

      the name of an action in the group

    Returns void

  • vfunc_action_state_changed(action_name: string, state: GLib.Variant): void
  • vfunc_activate_action(action_name: string, parameter: GLib.Variant): void
  • Activate the named action within action_group.

    If the action is expecting a parameter, then the correct type of parameter must be given as parameter. If the action is expecting no parameters then parameter must be %NULL. See g_action_group_get_action_parameter_type().

    If the #GActionGroup implementation supports asynchronous remote activation over D-Bus, this call may return before the relevant D-Bus traffic has been sent, or any replies have been received. In order to block on such asynchronous activation calls, g_dbus_connection_flush() should be called prior to the code, which depends on the result of the action activation. Without flushing the D-Bus connection, there is no guarantee that the action would have been activated.

    The following code which runs in a remote app instance, shows an example of a "quit" action being activated on the primary app instance over D-Bus. Here g_dbus_connection_flush() is called before exit(). Without g_dbus_connection_flush(), the "quit" action may fail to be activated on the primary instance.

    // call "quit" action on primary instance
    g_action_group_activate_action (G_ACTION_GROUP (app), "quit", NULL);

    // make sure the action is activated now
    g_dbus_connection_flush (...);

    g_debug ("application has been terminated. exiting.");

    exit (0);
    virtual

    Parameters

    • action_name: string

      the name of the action to activate

    • parameter: GLib.Variant

      parameters to the activation

    Returns void

  • Activates the remote action.

    This is the same as g_action_group_activate_action() except that it allows for provision of "platform data" to be sent along with the activation request. This typically contains details such as the user interaction timestamp or startup notification information.

    platform_data must be non-%NULL and must have the type %G_VARIANT_TYPE_VARDICT. If it is floating, it will be consumed.

    virtual

    Parameters

    • action_name: string

      the name of the action to activate

    • parameter: GLib.Variant

      the optional parameter to the activation

    • platform_data: GLib.Variant

      the platform data to send

    Returns void

  • vfunc_change_action_state(action_name: string, value: GLib.Variant): void
  • Request for the state of the named action within action_group to be changed to value.

    The action must be stateful and value must be of the correct type. See g_action_group_get_action_state_type().

    This call merely requests a change. The action may refuse to change its state or may change its state to something other than value. See g_action_group_get_action_state_hint().

    If the value GVariant is floating, it is consumed.

    virtual

    Parameters

    • action_name: string

      the name of the action to request the change on

    • value: GLib.Variant

      the new state

    Returns void

  • Changes the state of a remote action.

    This is the same as g_action_group_change_action_state() except that it allows for provision of "platform data" to be sent along with the state change request. This typically contains details such as the user interaction timestamp or startup notification information.

    platform_data must be non-%NULL and must have the type %G_VARIANT_TYPE_VARDICT. If it is floating, it will be consumed.

    virtual

    Parameters

    • action_name: string

      the name of the action to change the state of

    • value: GLib.Variant

      the new requested value for the state

    • platform_data: GLib.Variant

      the platform data to send

    Returns void

  • vfunc_constructed(): void
  • vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void
  • vfunc_dispose(): void
  • vfunc_finalize(): void
  • vfunc_get_action_enabled(action_name: string): boolean
  • Checks if the named action within action_group is currently enabled.

    An action must be enabled in order to be activated or in order to have its state changed from outside callers.

    virtual

    Parameters

    • action_name: string

      the name of the action to query

    Returns boolean

  • vfunc_get_action_parameter_type(action_name: string): VariantType
  • Queries the type of the parameter that must be given when activating the named action within action_group.

    When activating the action using g_action_group_activate_action(), the #GVariant given to that function must be of the type returned by this function.

    In the case that this function returns %NULL, you must not give any #GVariant, but %NULL instead.

    The parameter type of a particular action will never change but it is possible for an action to be removed and for a new action to be added with the same name but a different parameter type.

    virtual

    Parameters

    • action_name: string

      the name of the action to query

    Returns VariantType

  • vfunc_get_action_state(action_name: string): GLib.Variant
  • Queries the current state of the named action within action_group.

    If the action is not stateful then %NULL will be returned. If the action is stateful then the type of the return value is the type given by g_action_group_get_action_state_type().

    The return value (if non-%NULL) should be freed with g_variant_unref() when it is no longer required.

    virtual

    Parameters

    • action_name: string

      the name of the action to query

    Returns GLib.Variant

  • vfunc_get_action_state_hint(action_name: string): GLib.Variant
  • Requests a hint about the valid range of values for the state of the named action within action_group.

    If %NULL is returned it either means that the action is not stateful or that there is no hint about the valid range of values for the state of the action.

    If a #GVariant array is returned then each item in the array is a possible value for the state. If a #GVariant pair (ie: two-tuple) is returned then the tuple specifies the inclusive lower and upper bound of valid values for the state.

    In any case, the information is merely a hint. It may be possible to have a state value outside of the hinted range and setting a value within the range may fail.

    The return value (if non-%NULL) should be freed with g_variant_unref() when it is no longer required.

    virtual

    Parameters

    • action_name: string

      the name of the action to query

    Returns GLib.Variant

  • vfunc_get_action_state_type(action_name: string): VariantType
  • Queries the type of the state of the named action within action_group.

    If the action is stateful then this function returns the #GVariantType of the state. All calls to g_action_group_change_action_state() must give a #GVariant of this type and g_action_group_get_action_state() will return a #GVariant of the same type.

    If the action is not stateful then this function will return %NULL. In that case, g_action_group_get_action_state() will return %NULL and you must not call g_action_group_change_action_state().

    The state type of a particular action will never change but it is possible for an action to be removed and for a new action to be added with the same name but a different state type.

    virtual

    Parameters

    • action_name: string

      the name of the action to query

    Returns VariantType

  • vfunc_get_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • vfunc_has_action(action_name: string): boolean
  • vfunc_list_actions(): string[]
  • 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

  • Queries all aspects of the named action within an action_group.

    This function acquires the information available from g_action_group_has_action(), g_action_group_get_action_enabled(), g_action_group_get_action_parameter_type(), g_action_group_get_action_state_type(), g_action_group_get_action_state_hint() and g_action_group_get_action_state() with a single function call.

    This provides two main benefits.

    The first is the improvement in efficiency that comes with not having to perform repeated lookups of the action in order to discover different things about it. The second is that implementing #GActionGroup can now be done by only overriding this one virtual function.

    The interface provides a default implementation of this function that calls the individual functions, as required, to fetch the information. The interface also provides default implementations of those functions that call this function. All implementations, therefore, must override either this function or all of the others.

    If the action exists, %TRUE is returned and any of the requested fields (as indicated by having a non-%NULL reference passed in) are filled. If the action doesn't exist, %FALSE is returned and the fields may or may not have been modified.

    virtual

    Parameters

    • action_name: string

      the name of an action in the group

    Returns [boolean, boolean, VariantType, VariantType, GLib.Variant, GLib.Variant]

  • vfunc_set_property(property_id: number, value?: any, pspec?: ParamSpec): 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[]

  • 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