summaryrefslogtreecommitdiff
path: root/gio/src/remoteactiongroup.hg
diff options
context:
space:
mode:
authorJosé Alburquerque <jaalburqu@svn.gnome.org>2012-02-24 00:25:26 -0500
committerJosé Alburquerque <jaalburqu@svn.gnome.org>2012-02-24 00:34:45 -0500
commitf97840c840fc99507f6e91123f88456a3900b589 (patch)
treeb21daa02e57965276299c6d1aca5102544487483 /gio/src/remoteactiongroup.hg
parent55c1a9cd689d17df4656845e95074ee75788c2af (diff)
downloadglibmm-f97840c840fc99507f6e91123f88456a3900b589.tar.gz
giomm: Add class docs to recently added Application related classes.
* gio/src/actionmap.hg: * gio/src/dbusactiongroup.hg: * gio/src/dbusmenumodel.hg: * gio/src/menuattributeiter.hg: * gio/src/menulinkiter.hg: * gio/src/remoteactiongroup.hg:
Diffstat (limited to 'gio/src/remoteactiongroup.hg')
-rw-r--r--gio/src/remoteactiongroup.hg21
1 files changed, 20 insertions, 1 deletions
diff --git a/gio/src/remoteactiongroup.hg b/gio/src/remoteactiongroup.hg
index 13a3b733..4dda8aff 100644
--- a/gio/src/remoteactiongroup.hg
+++ b/gio/src/remoteactiongroup.hg
@@ -30,7 +30,26 @@ typedef struct _GRemoteActionGroupInterface GRemoteActionGroupInterface;
namespace Gio
{
-/** TODO (When the C API docs is available).
+/** RemoteActionGroup - a ActionGroup that interacts with other processes.
+ * The RemoteActionGroup interface is implemented by ActionGroup instances that
+ * either transmit action invocations to other processes or receive action
+ * invocations in the local process from other processes.
+ *
+ * The interface has variants of the two methods on ActionGroup used to
+ * activate actions: Gio::ActionGroup::activate_action() and
+ * Gio::ActionGroup::change_action_state(). These variants allow a "platform
+ * data" Glib::VariantBase to be specified: a dictionary providing context for
+ * the action invocation (for example: timestamps, startup notification IDs,
+ * etc).
+ *
+ * Gio::DBus::ActionGroup implements RemoteActionGroup. This provides a
+ * mechanism to send platform data for action invocations over D-Bus.
+ *
+ * Additionally, Gio::DBus::Connection::export_action_group() will check if the
+ * exported ActionGroup implements RemoteActionGroup and use the 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.
+ * @newin{2,32}
*/
class RemoteActionGroup : public Glib::Interface
{