1/*
2 * Copyright © 2010 Codethink Limited
3 *
4 * SPDX-License-Identifier: LGPL-2.1-or-later
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General
17 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
18 *
19 * Authors: Ryan Lortie <desrt@desrt.ca>
20 */
21
22#ifndef __G_ACTION_H__
23#define __G_ACTION_H__
24
25#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
26#error "Only <gio/gio.h> can be included directly."
27#endif
28
29#include <gio/giotypes.h>
30
31G_BEGIN_DECLS
32
33#define G_TYPE_ACTION (g_action_get_type ())
34#define G_ACTION(inst) (G_TYPE_CHECK_INSTANCE_CAST ((inst), \
35 G_TYPE_ACTION, GAction))
36#define G_IS_ACTION(inst) (G_TYPE_CHECK_INSTANCE_TYPE ((inst), G_TYPE_ACTION))
37#define G_ACTION_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), \
38 G_TYPE_ACTION, GActionInterface))
39
40typedef struct _GActionInterface GActionInterface;
41
42struct _GActionInterface
43{
44 GTypeInterface g_iface;
45
46 /* virtual functions */
47 const gchar * (* get_name) (GAction *action);
48 const GVariantType * (* get_parameter_type) (GAction *action);
49 const GVariantType * (* get_state_type) (GAction *action);
50 GVariant * (* get_state_hint) (GAction *action);
51
52 gboolean (* get_enabled) (GAction *action);
53 GVariant * (* get_state) (GAction *action);
54
55 void (* change_state) (GAction *action,
56 GVariant *value);
57 void (* activate) (GAction *action,
58 GVariant *parameter);
59};
60
61GIO_AVAILABLE_IN_2_30
62GType g_action_get_type (void) G_GNUC_CONST;
63
64GIO_AVAILABLE_IN_ALL
65const gchar * g_action_get_name (GAction *action);
66GIO_AVAILABLE_IN_ALL
67const GVariantType * g_action_get_parameter_type (GAction *action);
68GIO_AVAILABLE_IN_ALL
69const GVariantType * g_action_get_state_type (GAction *action);
70GIO_AVAILABLE_IN_ALL
71GVariant * g_action_get_state_hint (GAction *action);
72
73GIO_AVAILABLE_IN_ALL
74gboolean g_action_get_enabled (GAction *action);
75GIO_AVAILABLE_IN_ALL
76GVariant * g_action_get_state (GAction *action);
77
78GIO_AVAILABLE_IN_ALL
79void g_action_change_state (GAction *action,
80 GVariant *value);
81GIO_AVAILABLE_IN_ALL
82void g_action_activate (GAction *action,
83 GVariant *parameter);
84
85GIO_AVAILABLE_IN_2_28
86gboolean g_action_name_is_valid (const gchar *action_name);
87
88GIO_AVAILABLE_IN_2_38
89gboolean g_action_parse_detailed_name (const gchar *detailed_name,
90 gchar **action_name,
91 GVariant **target_value,
92 GError **error);
93
94GIO_AVAILABLE_IN_2_38
95gchar * g_action_print_detailed_name (const gchar *action_name,
96 GVariant *target_value);
97
98G_END_DECLS
99
100#endif /* __G_ACTION_H__ */
101