source: appstream-generator/build/girepo/gio/RemoteActionGroupIF.d @ 4841

Last change on this file since 4841 was 4841, checked in by Juanma, 2 years ago

Initial release

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