atk/atkutil.h

   1 /* ATK -  Accessibility Toolkit
   2  * Copyright 2001 Sun Microsystems Inc.
   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 __ATK_UTIL_H__
  21 #define __ATK_UTIL_H__
  22
  23 #include <atk/atkobject.h>
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif /* __cplusplus */
  28
  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))
  35
  36
  37 #ifndef _TYPEDEF_ATK_UTIL_
  38 #define _TYPEDEF_ATK_UTIL_
  39 typedef struct _AtkUtil      AtkUtil;
  40 typedef struct _AtkUtilClass AtkUtilClass;
  41 typedef struct _AtkKeyEventStruct AtkKeyEventStruct;
  42 #endif
  43
  44 /*
  45  * A focus tracker is a function which is called when an object
  46  * receives focus.
  47  */
  48 typedef void  (*AtkEventListener) (AtkObject*);
  49 typedef void  (*AtkEventListenerInit) (void);
  50 typedef gint  (*AtkKeySnoopFunc)  (AtkKeyEventStruct *event,
  51                                    gpointer func_data);
  52
  53 struct _AtkKeyEventStruct {
  54   gint type;
  55   guint state;
  56   guint keyval;
  57   gint length;
  58   gchar *string;
  59   guint16 keycode;
  60   guint32 timestamp;
  61 };
  62
  63 typedef enum
  64 {
  65   ATK_KEY_EVENT_PRESS,
  66   ATK_KEY_EVENT_RELEASE,
  67   ATK_KEY_EVENT_LAST_DEFINED
  68 } AtkKeyEventType;
  69
  70 struct _AtkUtil
  71 {
  72   GObject parent;
  73 };
  74
  75 struct _AtkUtilClass
  76 {
  77    GObjectClass parent;
  78    guint        (* add_global_event_listener)    (GSignalEmissionHook listener,
  79                                                   const gchar        *event_type);
  80    void         (* remove_global_event_listener) (guint               listener_id);
  81    guint        (* add_key_event_listener)       (AtkKeySnoopFunc     listener,
  82                                                   gpointer data);
  83    void         (* remove_key_event_listener)    (guint               listener_id);
  84    AtkObject*   (* get_root)                     (void);
  85    G_CONST_RETURN gchar* (* get_toolkit_name)    (void);
  86    G_CONST_RETURN gchar* (* get_toolkit_version) (void);
  87 };
  88 GType atk_util_get_type (void);
  89
  90 /**
  91  *AtkCoordType:
  92  *@ATK_XY_SCREEN: specifies xy coordinates relative to the screen
  93  *@ATK_XY_WINDOW: specifies xy coordinates relative to the widgets
  94  * top-level window
  95  *
  96  *Specifies how xy coordinates are to be interpreted. Used by functions such
  97  *as atk_component_get_position() and atk_text_get_character_extents()
  98  **/
  99 typedef enum {
 100   ATK_XY_SCREEN,
 101   ATK_XY_WINDOW
 102 }AtkCoordType;
 103
 104 /*
 105  * Adds the specified function to the list of functions to be called
 106  * when an object receives focus.
 107  */
 108 guint    atk_add_focus_tracker     (AtkEventListener      focus_tracker);
 109
 110 /*
 111  * Removes the specified focus tracker from the list of function
 112  * to be called when any object receives focus
 113  */
 114 void     atk_remove_focus_tracker  (guint                tracker_id);
 115
 116 /*
 117  * Specifies the function to be called for focus tracker initialization.
 118  * removal. This function should be called by an implementation of the
 119  * ATK interface if any specific work needs to be done to enable
 120  * focus tracking.
 121  */
 122 void     atk_focus_tracker_init    (AtkEventListenerInit  add_function);
 123
 124 /*
 125  * Cause the focus tracker functions which have been specified to be
 126 F
 127  * executed for the object.
 128  */
 129 void     atk_focus_tracker_notify  (AtkObject            *object);
 130
 131 /*
 132  * Adds the specified function to the list of functions to be called
 133  * when an event of type event_type occurs.
 134  */
 135 guint   atk_add_global_event_listener (GSignalEmissionHook listener,
 136                                        const gchar        *event_type);
 137
 138 /*
 139  * Removes the specified event listener
 140  */
 141 void    atk_remove_global_event_listener (guint listener_id);
 142
 143 /*
 144  * Adds the specified function to the list of functions to be called
 145  * when an keyboard event occurs.
 146  */
 147 guint   atk_add_key_event_listener (AtkKeySnoopFunc listener, gpointer data);
 148
 149 /*
 150  * Removes the specified event listener
 151  */
 152 void    atk_remove_key_event_listener (guint listener_id);
 153
 154 /*
 155  * Returns the root accessible container for the current application.
 156  */
 157 AtkObject* atk_get_root(void);
 158
 159 /*
 160  * Returns name string for the GUI toolkit.
 161  */
 162 G_CONST_RETURN gchar *atk_get_toolkit_name (void);
 163
 164 /*
 165  * Returns version string for the GUI toolkit.
 166  */
 167 G_CONST_RETURN gchar *atk_get_toolkit_version (void);
 168
 169 #ifdef __cplusplus
 170 }
 171 #endif /* __cplusplus */
 172
 173
 174 #endif /* __ATK_UTIL_H__ */