docs: Move the GRemoteActionGroup SECTION

Move it to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
This commit is contained in:
Philip Withnall 2023-11-02 16:21:51 +00:00
parent bfa5d99305
commit 8c3e0aa406

View File

@ -27,43 +27,33 @@
#include "gaction.h"
/**
* SECTION:gremoteactiongroup
* @title: GRemoteActionGroup
* @short_description: A GActionGroup that interacts with other processes
* @include: gio/gio.h
* GRemoteActionGroup:
*
* The GRemoteActionGroup interface is implemented by #GActionGroup
* The `GRemoteActionGroup` interface is implemented by [iface@Gio.ActionGroup]
* 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
* methods on [iface@Gio.ActionGroup] used to activate actions:
* [method@Gio.ActionGroup.activate_action] and
* [method@Gio.ActionGroup.change_action_state]. These variants allow a
* platform data [struct@GLib.Variant] to be specified: a dictionary providing
* context for the action invocation (for example: timestamps, startup
* notification IDs, etc).
*
* #GDBusActionGroup implements #GRemoteActionGroup. This provides a
* [class@Gio.DBusActionGroup] 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
* Additionally, [method@Gio.DBusConnection.export_action_group] will check if
* the exported [iface@Gio.ActionGroup] 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
**/
/**
* GRemoteActionGroup:
*
* #GRemoteActionGroup is an opaque data structure and can only be accessed
* using the following functions.
**/
/**
* GRemoteActionGroupInterface:
* @activate_action_full: the virtual function pointer for g_remote_action_group_activate_action_full()