2.30.0

[platform/upstream/atk.git] / atk / atkutil.h

diff --git a/atk/atkutil.h b/atk/atkutil.h
old mode 100755 (executable)
new mode 100644 (file)
index 420d83e..2bac963
--- a/atk/atkutil.h
+++ b/atk/atkutil.h
@@ -17,13 +17,13 @@
  * Boston, MA 02111-1307, USA.
  */
 
+#ifndef __ATK_UTIL_H__
+#define __ATK_UTIL_H__
+
 #if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined (__ATK_H_INSIDE__) && !defined (ATK_COMPILATION)
 #error "Only <atk/atk.h> can be included directly."
 #endif
 
-#ifndef __ATK_UTIL_H__
-#define __ATK_UTIL_H__
-
 #include <atk/atkobject.h>
 
 G_BEGIN_DECLS
@@ -137,6 +137,26 @@ struct _AtkUtil
   GObject parent;
 };
 
+/**
+ * AtkUtilClass:
+ * @add_global_event_listener: adds the specified function to the list
+ *  of functions to be called when an ATK event occurs. ATK
+ *  implementors are discouraged from reimplementing this method.
+ * @remove_global_event_listener: removes the specified function to
+ *  the list of functions to be called when an ATK event occurs. ATK
+ *  implementors are discouraged from reimplementing this method.
+ * @add_key_event_listener: adds the specified function to the list of
+ *  functions to be called when a key event occurs.
+ * @remove_key_event_listener: remove the specified function to the
+ *  list of functions to be called when a key event occurs.
+ * @get_root: gets the root accessible container for the current
+ *  application.
+ * @get_toolkit_name: gets name string for the GUI toolkit
+ *  implementing ATK for this application.
+ * @get_toolkit_version: gets version string for the GUI toolkit
+ *  implementing ATK for this application.
+ *
+ */
 struct _AtkUtilClass
 {
    GObjectClass parent;
@@ -150,41 +170,54 @@ struct _AtkUtilClass
    const gchar* (* get_toolkit_name)             (void);
    const gchar* (* get_toolkit_version)          (void);
 };
+ATK_AVAILABLE_IN_ALL
 GType atk_util_get_type (void);
 
 /**
  *AtkCoordType:
  *@ATK_XY_SCREEN: specifies xy coordinates relative to the screen
- *@ATK_XY_WINDOW: specifies xy coordinates relative to the widget's 
+ *@ATK_XY_WINDOW: specifies xy coordinates relative to the widget's
  * top-level window
+ *@ATK_XY_PARENT: specifies xy coordinates relative to the widget's
+ * immediate parent. Since: 2.30
  *
  *Specifies how xy coordinates are to be interpreted. Used by functions such
  *as atk_component_get_position() and atk_text_get_character_extents() 
  **/
 typedef enum {
   ATK_XY_SCREEN,
-  ATK_XY_WINDOW
+  ATK_XY_WINDOW,
+  ATK_XY_PARENT
 }AtkCoordType;
 
-G_DEPRECATED
+ATK_DEPRECATED_IN_2_10
 guint    atk_add_focus_tracker     (AtkEventListener      focus_tracker);
-G_DEPRECATED
+ATK_DEPRECATED_IN_2_10
 void     atk_remove_focus_tracker  (guint                tracker_id);
-G_DEPRECATED
+ATK_DEPRECATED_IN_2_10
 void     atk_focus_tracker_init    (AtkEventListenerInit  init);
-G_DEPRECATED
+ATK_DEPRECATED_IN_2_10
 void     atk_focus_tracker_notify  (AtkObject            *object);
+ATK_AVAILABLE_IN_ALL
 guint  atk_add_global_event_listener (GSignalEmissionHook listener,
                                       const gchar        *event_type);
+ATK_AVAILABLE_IN_ALL
 void   atk_remove_global_event_listener (guint listener_id);
+ATK_AVAILABLE_IN_ALL
 guint  atk_add_key_event_listener (AtkKeySnoopFunc listener, gpointer data);
+ATK_AVAILABLE_IN_ALL
 void   atk_remove_key_event_listener (guint listener_id);
 
+ATK_AVAILABLE_IN_ALL
 AtkObject* atk_get_root(void);
+ATK_AVAILABLE_IN_ALL
 AtkObject* atk_get_focus_object (void);
 
+ATK_AVAILABLE_IN_ALL
 const gchar *atk_get_toolkit_name (void);
+ATK_AVAILABLE_IN_ALL
 const gchar *atk_get_toolkit_version (void);
+ATK_AVAILABLE_IN_ALL
 const gchar *atk_get_version (void);
 
 /* --- GType boilerplate --- */
@@ -285,6 +318,7 @@ static void     type_name##_class_intern_init (gpointer klass) \
   type_name##_class_init ((TypeName##Class*) klass); \
 } \
 \
+ATK_AVAILABLE_IN_ALL \
 GType \
 type_name##_get_type (void) \
 { \