1/* GTK - The GIMP Toolkit
2 * Copyright (C) 2008 Tristan Van Berkom <tristan.van.berkom@gmail.com>
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
8 *
9 * This library 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 GNU
12 * Library General Public License for more details.
13 *
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
18 */
19
20#ifndef __GTK_ACTIVATABLE_H__
21#define __GTK_ACTIVATABLE_H__
22
23#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
24#error "Only <gtk/gtk.h> can be included directly."
25#endif
26
27#include <gtk/gtkaction.h>
28#include <gtk/gtktypeutils.h>
29
30G_BEGIN_DECLS
31
32#define GTK_TYPE_ACTIVATABLE (gtk_activatable_get_type ())
33#define GTK_ACTIVATABLE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_ACTIVATABLE, GtkActivatable))
34#define GTK_ACTIVATABLE_CLASS(obj) (G_TYPE_CHECK_CLASS_CAST ((obj), GTK_TYPE_ACTIVATABLE, GtkActivatableIface))
35#define GTK_IS_ACTIVATABLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_ACTIVATABLE))
36#define GTK_ACTIVATABLE_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GTK_TYPE_ACTIVATABLE, GtkActivatableIface))
37
38
39typedef struct _GtkActivatable GtkActivatable; /* Dummy typedef */
40typedef struct _GtkActivatableIface GtkActivatableIface;
41
42
43/**
44 * GtkActivatableIface:
45 * @update: Called to update the activatable when its related action's properties change.
46 * You must check the #GtkActivatable:use-action-appearance property only apply action
47 * properties that are meant to effect the appearance accordingly.
48 * @sync_action_properties: Called to update the activatable completely, this is called internally when
49 * #GtkActivatable::related-action property is set or unset and by the implementor when
50 * #GtkActivatable::use-action-appearance changes.<note><para>This method can be called
51 * with a %NULL action at times</para></note>
52 *
53 * Since: 2.16
54 */
55
56struct _GtkActivatableIface
57{
58 GTypeInterface g_iface;
59
60 /* virtual table */
61 void (* update) (GtkActivatable *activatable,
62 GtkAction *action,
63 const gchar *property_name);
64 void (* sync_action_properties) (GtkActivatable *activatable,
65 GtkAction *action);
66};
67
68
69GType gtk_activatable_get_type (void) G_GNUC_CONST;
70
71void gtk_activatable_sync_action_properties (GtkActivatable *activatable,
72 GtkAction *action);
73
74void gtk_activatable_set_related_action (GtkActivatable *activatable,
75 GtkAction *action);
76GtkAction *gtk_activatable_get_related_action (GtkActivatable *activatable);
77
78void gtk_activatable_set_use_action_appearance (GtkActivatable *activatable,
79 gboolean use_appearance);
80gboolean gtk_activatable_get_use_action_appearance (GtkActivatable *activatable);
81
82/* For use in activatable implementations */
83void gtk_activatable_do_set_related_action (GtkActivatable *activatable,
84 GtkAction *action);
85
86G_END_DECLS
87
88#endif /* __GTK_ACTIVATABLE_H__ */
89