AtkUtil

Name

AtkUtil -- general purpose utility class

Synopsis



enum        AtkCoordType;
guint       atk_add_focus_tracker           (AtkEventListener focus_tracker);
void        atk_remove_focus_tracker        (guint tracker_id);
void        atk_focus_tracker_init          (AtkEventListenerInit add_function);
void        atk_focus_tracker_notify        (AtkObject *object);
guint       atk_add_global_event_listener   (GSignalEmissionHook listener,
                                             gchar *event_type);
void        atk_remove_global_event_listener
                                            (guint listener_id);
AtkObject*  atk_get_root                    (void);
gchar*      atk_get_toolkit_name            (void);
gchar*      atk_get_toolkit_version         (void);

Description

The AtkUtility interface provides general purpose utility functions.

Details

enum AtkCoordType

typedef enum {
  ATK_XY_SCREEN,
  ATK_XY_WINDOW
}AtkCoordType;

Specifies how xy coordinates are to be interpreted. Used by functions such as atk_component_get_position() and atk_text_get_character_extents()

ATK_XY_SCREEN specifies xy coordinates relative to the screen
ATK_XY_WINDOW specifies xy coordinates relative to the widgets top-level window


atk_add_focus_tracker ()

guint       atk_add_focus_tracker           (AtkEventListener focus_tracker);

Adds the specified function to the list of functions to be called when an object receives focus.

focus_tracker : Function to be added to the list of functions to be called when an object receives focus.
Returns : added focus tracker id, or 0 on failure.


atk_remove_focus_tracker ()

void        atk_remove_focus_tracker        (guint tracker_id);

Removes the specified focus tracker from the list of functions to be called when any object receives focus.

tracker_id : the id of the focus tracker to remove


atk_focus_tracker_init ()

void        atk_focus_tracker_init          (AtkEventListenerInit add_function);

Specifies the function to be called for focus tracker initialization. This function should be called by an implementation of the ATK interface if any specific work needs to be done to enable focus tracking.

add_function : Function to be called for focus tracker initialization


atk_focus_tracker_notify ()

void        atk_focus_tracker_notify        (AtkObject *object);

Cause the focus tracker functions which have been specified to be executed for the object.

object : an AtkObject


atk_add_global_event_listener ()

guint       atk_add_global_event_listener   (GSignalEmissionHook listener,
                                             gchar *event_type);

Adds the specified function to the list of functions to be called when an event of type event_type occurs.

listener : the listener to notify
event_type : the type of event for which notification is requested
Returns : added event listener id, or 0 on failure.


atk_remove_global_event_listener ()

void        atk_remove_global_event_listener
                                            (guint listener_id);

Removes the specified event listener

listener_id : the id of the event listener to remove


atk_get_root ()

AtkObject*  atk_get_root                    (void);

Gets the root accessible container for the current application.

Returns : the root accessible container for the current application


atk_get_toolkit_name ()

gchar*      atk_get_toolkit_name            (void);

Gets name string for the GUI toolkit implementing ATK for this application.

Returns : name string for the GUI toolkit implementing ATK for this application


atk_get_toolkit_version ()

gchar*      atk_get_toolkit_version         (void);

Gets version string for the GUI toolkit implementing ATK for this application.

Returns : version string for the GUI toolkit implementing ATK for this application