1 /*
2  * This file is part of gtkD.
3  *
4  * gtkD is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License
6  * as published by the Free Software Foundation; either version 3
7  * of the License, or (at your option) any later version, with
8  * some exceptions, please read the COPYING file.
9  *
10  * gtkD is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with gtkD; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
18  */
19 
20 // generated automatically - do not change
21 // find conversion definition on APILookup.txt
22 // implement new conversion functionalities on the wrap.utils pakage
23 
24 
25 module gio.RemoteActionGroupIF;
26 
27 private import glib.Str;
28 private import glib.Variant;
29 private import gtkc.gio;
30 public  import gtkc.giotypes;
31 
32 
33 /**
34  * The GRemoteActionGroup interface is implemented by #GActionGroup
35  * instances that either transmit action invocations to other processes
36  * or receive action invocations in the local process from other
37  * processes.
38  * 
39  * The interface has `_full` variants of the two
40  * methods on #GActionGroup used to activate actions:
41  * g_action_group_activate_action() and
42  * g_action_group_change_action_state(). These variants allow a
43  * "platform data" #GVariant to be specified: a dictionary providing
44  * context for the action invocation (for example: timestamps, startup
45  * notification IDs, etc).
46  * 
47  * #GDBusActionGroup implements #GRemoteActionGroup.  This provides a
48  * mechanism to send platform data for action invocations over D-Bus.
49  * 
50  * Additionally, g_dbus_connection_export_action_group() will check if
51  * the exported #GActionGroup implements #GRemoteActionGroup and use the
52  * `_full` variants of the calls if available.  This
53  * provides a mechanism by which to receive platform data for action
54  * invocations that arrive by way of D-Bus.
55  */
56 public interface RemoteActionGroupIF{
57 	/** Get the main Gtk struct */
58 	public GRemoteActionGroup* getRemoteActionGroupStruct(bool transferOwnership = false);
59 
60 	/** the main Gtk struct as a void* */
61 	protected void* getStruct();
62 
63 
64 	/**
65 	 * Activates the remote action.
66 	 *
67 	 * This is the same as g_action_group_activate_action() except that it
68 	 * allows for provision of "platform data" to be sent along with the
69 	 * activation request.  This typically contains details such as the user
70 	 * interaction timestamp or startup notification information.
71 	 *
72 	 * @platform_data must be non-%NULL and must have the type
73 	 * %G_VARIANT_TYPE_VARDICT.  If it is floating, it will be consumed.
74 	 *
75 	 * Params:
76 	 *     actionName = the name of the action to activate
77 	 *     parameter = the optional parameter to the activation
78 	 *     platformData = the platform data to send
79 	 *
80 	 * Since: 2.32
81 	 */
82 	public void activateActionFull(string actionName, Variant parameter, Variant platformData);
83 
84 	/**
85 	 * Changes the state of a remote action.
86 	 *
87 	 * This is the same as g_action_group_change_action_state() except that
88 	 * it allows for provision of "platform data" to be sent along with the
89 	 * state change request.  This typically contains details such as the
90 	 * user interaction timestamp or startup notification information.
91 	 *
92 	 * @platform_data must be non-%NULL and must have the type
93 	 * %G_VARIANT_TYPE_VARDICT.  If it is floating, it will be consumed.
94 	 *
95 	 * Params:
96 	 *     actionName = the name of the action to change the state of
97 	 *     value = the new requested value for the state
98 	 *     platformData = the platform data to send
99 	 *
100 	 * Since: 2.32
101 	 */
102 	public void changeActionStateFull(string actionName, Variant value, Variant platformData);
103 }