* 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
* AtkKeySnoopFunc:
* @event: an AtkKeyEventStruct containing information about the key event for which
* notification is being given.
- * @func_data: a block of data which will be passed to the event listener, on notification.
+ * @user_data: a block of data which will be passed to the event listener, on notification.
*
* An #AtkKeySnoopFunc is a type of callback which is called whenever a key event occurs,
* if registered via atk_add_key_event_listener. It allows for pre-emptive
* see atk_add_key_event_listener.
**/
typedef gint (*AtkKeySnoopFunc) (AtkKeyEventStruct *event,
- gpointer func_data);
+ gpointer user_data);
/**
* AtkKeyEventStruct:
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;
gpointer data);
void (* remove_key_event_listener) (guint listener_id);
AtkObject* (* get_root) (void);
- G_CONST_RETURN gchar* (* get_toolkit_name) (void);
- G_CONST_RETURN gchar* (* get_toolkit_version) (void);
+ 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;
-/*
- * Adds the specified function to the list of functions to be called
- * when an object receives focus.
- */
+ATK_DEPRECATED_IN_2_10
guint atk_add_focus_tracker (AtkEventListener focus_tracker);
-
-/*
- * Removes the specified focus tracker from the list of function
- * to be called when any object receives focus
- */
+ATK_DEPRECATED_IN_2_10
void atk_remove_focus_tracker (guint tracker_id);
-
-/*
- * atk_focus_tracker_init:
- * @init: An #AtkEventListenerInit function to be called
- * prior to any focus-tracking requests.
- *
- * Specifies the function to be called for focus tracker initialization.
- * removal. This function should be called by an implementation of the
- * ATK interface if any specific work needs to be done to enable
- * focus tracking.
- */
+ATK_DEPRECATED_IN_2_10
void atk_focus_tracker_init (AtkEventListenerInit init);
-
-/*
- * Cause the focus tracker functions which have been specified to be
- * executed for the object.
- */
+ATK_DEPRECATED_IN_2_10
void atk_focus_tracker_notify (AtkObject *object);
-
-/*
- * Adds the specified function to the list of functions to be called
- * when an event of type event_type occurs.
- */
+ATK_AVAILABLE_IN_ALL
guint atk_add_global_event_listener (GSignalEmissionHook listener,
const gchar *event_type);
-
-/*
- * Removes the specified event listener
- */
+ATK_AVAILABLE_IN_ALL
void atk_remove_global_event_listener (guint listener_id);
-
-/*
- * Adds the specified function to the list of functions to be called
- * when an keyboard event occurs.
- */
+ATK_AVAILABLE_IN_ALL
guint atk_add_key_event_listener (AtkKeySnoopFunc listener, gpointer data);
-
-/*
- * Removes the specified event listener
- */
+ATK_AVAILABLE_IN_ALL
void atk_remove_key_event_listener (guint listener_id);
-/*
- * Returns the root accessible container for the current application.
- */
+ATK_AVAILABLE_IN_ALL
AtkObject* atk_get_root(void);
-
+ATK_AVAILABLE_IN_ALL
AtkObject* atk_get_focus_object (void);
-/*
- * Returns name string for the GUI toolkit.
- */
-G_CONST_RETURN gchar *atk_get_toolkit_name (void);
-
-/*
- * Returns version string for the GUI toolkit.
- */
-G_CONST_RETURN gchar *atk_get_toolkit_version (void);
-
-/*
- * Gets the current version of ATK
- */
-G_CONST_RETURN gchar *atk_get_version (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 --- */
/* convenience macros for atk type implementations, which for a type GtkGadgetAccessible will:
type_name##_class_init ((TypeName##Class*) klass); \
} \
\
+ATK_AVAILABLE_IN_ALL \
GType \
type_name##_get_type (void) \
{ \
projects / platform / upstream / atk.git / blobdiff