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_UTIL_H__
21 #define __ATK_UTIL_H__
23 #include <atk/atkobject.h>
27 #endif /* __cplusplus */
29 #define ATK_TYPE_UTIL (atk_util_get_type ())
30 #define ATK_IS_UTIL(obj) G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_UTIL)
31 #define ATK_UTIL(obj) G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_UTIL, AtkUtil)
32 #define ATK_UTIL_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_UTIL, AtkUtilClass))
33 #define ATK_IS_UTIL_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_UTIL))
34 #define ATK_UTIL_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_UTIL, AtkUtilClass))
37 #ifndef _TYPEDEF_ATK_UTIL_
38 #define _TYPEDEF_ATK_UTIL_
39 typedef struct _AtkUtil AtkUtil;
40 typedef struct _AtkUtilClass AtkUtilClass;
44 * A focus tracker is a function which is called when an object
47 typedef void (*AtkEventListener) (AtkObject*);
48 typedef void (*AtkEventListenerInit) (void);
58 guint (* add_global_event_listener) (AtkEventListener listener,
60 void (* remove_global_event_listener) (guint listener_id);
61 AtkObject* (* get_root) (void);
62 gchar* (* get_toolkit_name) (void);
63 gchar* (* get_toolkit_version) (void);
65 GType atk_util_get_type (void);
69 *@ATK_XY_SCREEN: specifies xy coordinates relative to the screen
70 *@ATK_XY_WINDOW: specifies xy coordinates relative to the widgets
73 *Specifies how xy coordinates are to be interpreted
81 * Adds the specified function to the list of functions to be called
82 * when an object receives focus.
84 guint atk_add_focus_tracker (AtkEventListener focus_tracker);
87 * Removes the specified focus tracker from the list of function
88 * to be called when any object receives focus
90 void atk_remove_focus_tracker (guint tracker_id);
93 * Specifies the function to be called for focus tracker initialization.
94 * removal. This function should be called by an implementation of the
95 * ATK interface if any specific work needs to be done to enable
98 void atk_focus_tracker_init (AtkEventListenerInit add_function);
101 * Cause the focus tracker functions which have been specified to be
103 * executed for the object.
105 void atk_focus_tracker_notify (AtkObject *object);
108 * Adds the specified function to the list of functions to be called
109 * when an event of type event_type occurs.
111 guint atk_add_global_event_listener (AtkEventListener listener, gchar* event_type);
114 * Removes the specified event listener
116 void atk_remove_global_event_listener (guint listener_id);
119 * Returns the root accessible container for the current application.
121 AtkObject* atk_get_root(void);
124 * Returns name string for the GUI toolkit.
126 gchar* atk_get_toolkit_name(void);
129 * Returns version string for the GUI toolkit.
131 gchar* atk_get_toolkit_version(void);
135 #endif /* __cplusplus */
138 #endif /* __ATK_UTIL_H__ */