1 /* ATK - Accessibility Toolkit
2 * Copyright 2001 Sun Microsystems Inc.
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.
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.
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.
20 #ifndef __ATK_ACTION_H__
21 #define __ATK_ACTION_H__
23 #include <atk/atkobject.h>
27 #endif /* __cplusplus */
30 * The interface AtkAction should be supported by any object that can
31 * perform one or more actions. The interface provides the standard
32 * mechanism for an assistive technology to determine what those actions
33 * are as well as tell the object to perform them. Any object that can
34 * be manipulated should support this interface.
38 #define ATK_TYPE_ACTION (atk_action_get_type ())
39 #define ATK_IS_ACTION(obj) G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_ACTION)
40 #define ATK_ACTION(obj) G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_ACTION, AtkAction)
41 #define ATK_ACTION_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_ACTION, AtkActionIface))
43 #ifndef _TYPEDEF_ATK_ACTION_
44 #define _TYPEDEF_ATK_ACTION_
45 typedef struct _AtkAction AtkAction;
47 typedef struct _AtkActionIface AtkActionIface;
49 struct _AtkActionIface
51 GTypeInterface parent;
53 gboolean (*do_action) (AtkAction *action,
55 gint (*get_n_actions) (AtkAction *action);
56 G_CONST_RETURN gchar* (*get_description) (AtkAction *action,
58 G_CONST_RETURN gchar* (*get_name) (AtkAction *action,
60 G_CONST_RETURN gchar* (*get_keybinding) (AtkAction *action,
62 gboolean (*set_description) (AtkAction *action,
65 G_CONST_RETURN gchar* (*get_localized_name)(AtkAction *action,
70 GType atk_action_get_type (void);
73 * These are the function which would be called by an application with
74 * the argument being a AtkObject object cast to (AtkAction).
76 * The function will just check that * the corresponding
77 * function pointer is not NULL and will call it.
79 * The "real" implementation of the function for accessible will be
80 * provided in a support library
83 gboolean atk_action_do_action (AtkAction *action,
85 gint atk_action_get_n_actions (AtkAction *action);
86 G_CONST_RETURN gchar* atk_action_get_description (AtkAction *action,
88 G_CONST_RETURN gchar* atk_action_get_name (AtkAction *action,
90 G_CONST_RETURN gchar* atk_action_get_keybinding (AtkAction *action,
92 gboolean atk_action_set_description (AtkAction *action,
98 G_CONST_RETURN gchar* atk_action_get_localized_name (AtkAction *action,
102 * Additional GObject properties exported by AtkAction:
103 * "accessible_action"
104 * (an accessible action, or the list of actions, has changed)
109 #endif /* __cplusplus */
112 #endif /* __ATK_ACTION_H__ */