RemoteActionGroup

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.

Since

2.32

Inheritors

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
open override val gioActionGroupPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
abstract val gioRemoteActionGroupPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

Link copied to clipboard
open fun actionAdded(actionName: String)

Emits the #GActionGroup::action-added signal on @action_group.

Link copied to clipboard
open fun actionEnabledChanged(actionName: String, enabled: Boolean)

Emits the #GActionGroup::action-enabled-changed signal on @action_group.

Link copied to clipboard
open fun actionRemoved(actionName: String)

Emits the #GActionGroup::action-removed signal on @action_group.

Link copied to clipboard
open fun actionStateChanged(actionName: String, state: <Error class: unknown class>)

Emits the #GActionGroup::action-state-changed signal on @action_group.

Link copied to clipboard
open fun activateAction_(actionName: String, parameter: <Error class: unknown class>? = null)

Activate the named action within @action_group.

Link copied to clipboard
open fun activateActionFull(actionName: String, parameter: <Error class: unknown class>? = null, platformData: <Error class: unknown class>)

Activates the remote action.

Link copied to clipboard
open fun changeActionState(actionName: String, value: <Error class: unknown class>)

Request for the state of the named action within @action_group to be changed to @value.

Link copied to clipboard
open fun changeActionStateFull(actionName: String, value: <Error class: unknown class>, platformData: <Error class: unknown class>)

Changes the state of a remote action.

Link copied to clipboard
open fun connectActionAdded(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (actionName: String) -> Unit): <Error class: unknown class>

Signals that a new action was just added to the group. This signal is emitted after the action has been added and is now visible.

Link copied to clipboard
open fun connectActionEnabledChanged(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (actionName: String, enabled: Boolean) -> Unit): <Error class: unknown class>

Signals that the enabled status of the named action has changed.

Link copied to clipboard
open fun connectActionRemoved(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (actionName: String) -> Unit): <Error class: unknown class>

Signals that an action is just about to be removed from the group. This signal is emitted before the action is removed, so the action is still visible and can be queried from the signal handler.

Link copied to clipboard
open fun connectActionStateChanged(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (actionName: String, <Error class: unknown class>) -> Unit): <Error class: unknown class>

Signals that the state of the named action has changed.

Link copied to clipboard
open fun getActionEnabled(actionName: String): Boolean

Checks if the named action within @action_group is currently enabled.

Link copied to clipboard
open fun getActionParameterType(actionName: String): <Error class: unknown class>?

Queries the type of the parameter that must be given when activating the named action within @action_group.

Link copied to clipboard
open fun getActionState(actionName: String): <Error class: unknown class>?

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

Link copied to clipboard
open fun getActionStateHint(actionName: String): <Error class: unknown class>?

Requests a hint about the valid range of values for the state of the named action within @action_group.

Link copied to clipboard
open fun getActionStateType(actionName: String): <Error class: unknown class>?

Queries the type of the state of the named action within

Link copied to clipboard
open fun hasAction(actionName: String): Boolean

Checks if the named action exists within @action_group.

Link copied to clipboard
open fun listActions(): List<String>

Lists the actions contained within @action_group.