gio.RemoteActionGroupIF 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  * Conversion parameters:
26  * inFile  = GRemoteActionGroup.html
27  * outPack = gio
28  * outFile = RemoteActionGroupIF
29  * strct   = GRemoteActionGroup
30  * realStrct=
31  * ctorStrct=
32  * clss    = RemoteActionGroupT
33  * interf  = RemoteActionGroupIF
34  * class Code: No
35  * interface Code: No
36  * template for:
37  * extend  = 
38  * implements:
39  * prefixes:
40  * 	- g_remote_action_group_
41  * omit structs:
42  * omit prefixes:
43  * omit code:
44  * omit signals:
45  * imports:
46  * 	- glib.Str
47  * 	- glib.Variant
48  * structWrap:
49  * 	- GVariant* -> Variant
50  * module aliases:
51  * local aliases:
52  * overrides:
53  */
54 
55 module gio.RemoteActionGroupIF;
56 
57 public  import gtkc.giotypes;
58 
59 private import gtkc.gio;
60 private import glib.ConstructionException;
61 private import gobject.ObjectG;
62 
63 private import glib.Str;
64 private import glib.Variant;
65 
66 
67 
68 /**
69  * The GRemoteActionGroup interface is implemented by GActionGroup
70  * instances that either transmit action invocations to other processes
71  * or receive action invocations in the local process from other
72  * processes.
73  *
74  * The interface has _full variants of the two
75  * methods on GActionGroup used to activate actions:
76  * g_action_group_activate_action() and
77  * g_action_group_change_action_state(). These variants allow a
78  * "platform data" GVariant to be specified: a dictionary providing
79  * context for the action invocation (for example: timestamps, startup
80  * notification IDs, etc).
81  *
82  * GDBusActionGroup implements GRemoteActionGroup. This provides a
83  * mechanism to send platform data for action invocations over D-Bus.
84  *
85  * Additionally, g_dbus_connection_export_action_group() will check if
86  * the exported GActionGroup implements GRemoteActionGroup and use the
87  * _full variants of the calls if available. This
88  * provides a mechanism by which to receive platform data for action
89  * invocations that arrive by way of D-Bus.
90  */
91 public interface RemoteActionGroupIF
92 {
93 	
94 	
95 	/** Get the main Gtk struct */
96 	public GRemoteActionGroup* getRemoteActionGroupTStruct();
97 	
98 	/** the main Gtk struct as a void* */
99 	protected void* getStruct();
100 	
101 	
102 	/**
103 	 */
104 	
105 	/**
106 	 * Activates the remote action.
107 	 * This is the same as g_action_group_activate_action() except that it
108 	 * allows for provision of "platform data" to be sent along with the
109 	 * activation request. This typically contains details such as the user
110 	 * interaction timestamp or startup notification information.
111 	 * platform_data must be non-NULL and must have the type
112 	 * G_VARIANT_TYPE_VARDICT. If it is floating, it will be consumed.
113 	 * Since 2.32
114 	 * Params:
115 	 * actionName = the name of the action to activate
116 	 * parameter = the optional parameter to the activation. [allow-none]
117 	 * platformData = the platform data to send
118 	 */
119 	public void activateActionFull(string actionName, Variant parameter, Variant platformData);
120 	
121 	/**
122 	 * Changes the state of a remote action.
123 	 * This is the same as g_action_group_change_action_state() except that
124 	 * it allows for provision of "platform data" to be sent along with the
125 	 * state change request. This typically contains details such as the
126 	 * user interaction timestamp or startup notification information.
127 	 * platform_data must be non-NULL and must have the type
128 	 * G_VARIANT_TYPE_VARDICT. If it is floating, it will be consumed.
129 	 * Since 2.32
130 	 * Params:
131 	 * actionName = the name of the action to change the state of
132 	 * value = the new requested value for the state
133 	 * platformData = the platform data to send
134 	 */
135 	public void changeActionStateFull(string actionName, Variant value, Variant platformData);
136 }