gio.RemoteActionGroupT source code

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.RemoteActionGroupT;
26 
27 public  import glib.Str;
28 public  import glib.Variant;
29 public  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 template RemoteActionGroupT(TStruct)
57 {
58 	/** Get the main Gtk struct */
59 	public GRemoteActionGroup* getRemoteActionGroupStruct()
60 	{
61 		return cast(GRemoteActionGroup*)getStruct();
62 	}
63 
64 
65 	/**
66 	 * Activates the remote action.
67 	 *
68 	 * This is the same as g_action_group_activate_action() except that it
69 	 * allows for provision of "platform data" to be sent along with the
70 	 * activation request.  This typically contains details such as the user
71 	 * interaction timestamp or startup notification information.
72 	 *
73 	 * @platform_data must be non-%NULL and must have the type
74 	 * %G_VARIANT_TYPE_VARDICT.  If it is floating, it will be consumed.
75 	 *
76 	 * Params:
77 	 *     actionName = the name of the action to activate
78 	 *     parameter = the optional parameter to the activation
79 	 *     platformData = the platform data to send
80 	 *
81 	 * Since: 2.32
82 	 */
83 	public void activateActionFull(string actionName, Variant parameter, Variant platformData)
84 	{
85 		g_remote_action_group_activate_action_full(getRemoteActionGroupStruct(), Str.toStringz(actionName), (parameter is null) ? null : parameter.getVariantStruct(), (platformData is null) ? null : platformData.getVariantStruct());
86 	}
87 
88 	/**
89 	 * Changes the state of a remote action.
90 	 *
91 	 * This is the same as g_action_group_change_action_state() except that
92 	 * it allows for provision of "platform data" to be sent along with the
93 	 * state change request.  This typically contains details such as the
94 	 * user interaction timestamp or startup notification information.
95 	 *
96 	 * @platform_data must be non-%NULL and must have the type
97 	 * %G_VARIANT_TYPE_VARDICT.  If it is floating, it will be consumed.
98 	 *
99 	 * Params:
100 	 *     actionName = the name of the action to change the state of
101 	 *     value = the new requested value for the state
102 	 *     platformData = the platform data to send
103 	 *
104 	 * Since: 2.32
105 	 */
106 	public void changeActionStateFull(string actionName, Variant value, Variant platformData)
107 	{
108 		g_remote_action_group_change_action_state_full(getRemoteActionGroupStruct(), Str.toStringz(actionName), (value is null) ? null : value.getVariantStruct(), (platformData is null) ? null : platformData.getVariantStruct());
109 	}
110 }