struct AtkObject

struct AtkObject;

The AtkObject structure should not be accessed directly.

enum AtkRole

typedef enum
{
  ATK_ROLE_INVALID = 0, 
  ATK_ROLE_ACCEL_LABEL,
  ATK_ROLE_ALERT,
  ATK_ROLE_ANIMATION,
  ATK_ROLE_ARROW,
  ATK_ROLE_CALENDAR,
  ATK_ROLE_CANVAS,
  ATK_ROLE_CHECK_BOX,
  ATK_ROLE_CHECK_MENU_ITEM,
  ATK_ROLE_COLOR_CHOOSER,
  ATK_ROLE_COLUMN_HEADER,
  ATK_ROLE_COMBO_BOX,
  ATK_ROLE_DATE_EDITOR,
  ATK_ROLE_DESKTOP_ICON,
  ATK_ROLE_DESKTOP_FRAME,
  ATK_ROLE_DIAL,
  ATK_ROLE_DIALOG,
  ATK_ROLE_DIRECTORY_PANE,
  ATK_ROLE_DRAWING_AREA,
  ATK_ROLE_FILE_CHOOSER,
  ATK_ROLE_FILLER,
  ATK_ROLE_FONT_CHOOSER,
  ATK_ROLE_FRAME,
  ATK_ROLE_GLASS_PANE,
  ATK_ROLE_HTML_CONTAINER,
  ATK_ROLE_ICON,
  ATK_ROLE_IMAGE,
  ATK_ROLE_INTERNAL_FRAME,
  ATK_ROLE_LABEL,
  ATK_ROLE_LAYERED_PANE,
  ATK_ROLE_LIST,
  ATK_ROLE_LIST_ITEM,
  ATK_ROLE_MENU,
  ATK_ROLE_MENU_BAR,
  ATK_ROLE_MENU_ITEM,
  ATK_ROLE_OPTION_PANE,
  ATK_ROLE_PAGE_TAB,
  ATK_ROLE_PAGE_TAB_LIST,
  ATK_ROLE_PANEL,
  ATK_ROLE_PASSWORD_TEXT,
  ATK_ROLE_POPUP_MENU,
  ATK_ROLE_PROGRESS_BAR,
  ATK_ROLE_PUSH_BUTTON,
  ATK_ROLE_RADIO_BUTTON,
  ATK_ROLE_RADIO_MENU_ITEM,
  ATK_ROLE_ROOT_PANE,
  ATK_ROLE_ROW_HEADER,
  ATK_ROLE_SCROLL_BAR,
  ATK_ROLE_SCROLL_PANE,
  ATK_ROLE_SEPARATOR,
  ATK_ROLE_SLIDER,
  ATK_ROLE_SPLIT_PANE,
  ATK_ROLE_SPIN_BUTTON,
  ATK_ROLE_STATUSBAR,
  ATK_ROLE_TABLE,
  ATK_ROLE_TABLE_CELL,
  ATK_ROLE_TABLE_COLUMN_HEADER,
  ATK_ROLE_TABLE_ROW_HEADER,
  ATK_ROLE_TEAR_OFF_MENU_ITEM,
  ATK_ROLE_TERMINAL,
  ATK_ROLE_TEXT,
  ATK_ROLE_TOGGLE_BUTTON,
  ATK_ROLE_TOOL_BAR,
  ATK_ROLE_TOOL_TIP,
  ATK_ROLE_TREE,
  ATK_ROLE_TREE_TABLE,
  ATK_ROLE_UNKNOWN,
  ATK_ROLE_VIEWPORT,
  ATK_ROLE_WINDOW,
  ATK_ROLE_HEADER,
  ATK_ROLE_FOOTER,
  ATK_ROLE_PARAGRAPH,
  ATK_ROLE_RULER,
  ATK_ROLE_APPLICATION,
  ATK_ROLE_AUTOCOMPLETE,
  ATK_ROLE_EDITBAR,
  ATK_ROLE_EMBEDDED,
  ATK_ROLE_LAST_DEFINED
} AtkRole;

Describes the role of an object

These are the built-in enumerated roles that UI components can have in ATK. Other roles may be added at runtime, so an AtkRole >= ATK_ROLE_LAST_DEFINED is not necessarily an error.

atk_role_register ()

AtkRole     atk_role_register               (const gchar *name);

Registers the role specified by name.

enum AtkLayer

typedef enum
{
  ATK_LAYER_INVALID,
  ATK_LAYER_BACKGROUND,
  ATK_LAYER_CANVAS,
  ATK_LAYER_WIDGET,
  ATK_LAYER_MDI,
  ATK_LAYER_POPUP,
  ATK_LAYER_OVERLAY,
  ATK_LAYER_WINDOW
} AtkLayer;

Describes the layer of a component

These enumerated "layer values" are used when determining which UI rendering layer a component is drawn into, which can help in making determinations of when components occlude one another.

struct AtkImplementor

struct AtkImplementor;

The AtkImplementor structure does not contain any fields.

struct AtkPropertyValues

struct AtkPropertyValues {

  const gchar  *property_name;
  GValue old_value;
  GValue new_value;
};

The Atk PropertyValue structure is used when notifying a change in property. Currently, the only property for which old_value is used is accessible-state; for instance if there is a focus change the property change handler will be called for the object which lost the focus with the old_value containing the AtkState value corresponding to focused and the property change handler will be called for the object which received the focus with the new_value containing the AtkState value corresponding to focused.

AtkFunction ()

gboolean    (*AtkFunction)                  (gpointer data);

An AtkFunction is a function definition used for padding which has been added to class and interface structures to allow for expansion in the future.

AtkPropertyChangeHandler ()

void        (*AtkPropertyChangeHandler)     (AtkObject*,
                                             AtkPropertyValues*);

An AtkPropertyChangeHandler is a function which is executed when an AtkObject's property changes value. It is specified in a call to atk_object_connect_property_change_handler().

atk_implementor_ref_accessible ()

AtkObject*  atk_implementor_ref_accessible  (AtkImplementor *implementor);

Gets a reference to an object's AtkObject implementation, if the object implements AtkObjectIface

atk_object_get_name ()

G_CONST_RETURN gchar* atk_object_get_name   (AtkObject *accessible);

Gets the accessible name of the accessible.

atk_object_get_description ()

G_CONST_RETURN gchar* atk_object_get_description
                                            (AtkObject *accessible);

Gets the accessible description of the accessible.

atk_object_get_parent ()

AtkObject*  atk_object_get_parent           (AtkObject *accessible);

Gets the accessible parent of the accessible.

atk_object_get_n_accessible_children ()

gint        atk_object_get_n_accessible_children
                                            (AtkObject *accessible);

Gets the number of accessible children of the accessible.

atk_object_ref_accessible_child ()

AtkObject*  atk_object_ref_accessible_child (AtkObject *accessible,
                                             gint i);

Gets a reference to the specified accessible child of the object. The accessible children are 0-based so the first accessible child is at index 0, the second at index 1 and so on.

atk_object_ref_relation_set ()

AtkRelationSet* atk_object_ref_relation_set (AtkObject *accessible);

Gets the AtkRelationSet associated with the object.

atk_object_get_layer ()

AtkLayer    atk_object_get_layer            (AtkObject *accessible);

Gets the layer of the accessible.

atk_object_get_mdi_zorder ()

gint        atk_object_get_mdi_zorder       (AtkObject *accessible);

Gets the zorder of the accessible. The value G_MININT will be returned if the layer of the accessible is not ATK_LAYER_MDI.

atk_object_get_role ()

AtkRole     atk_object_get_role             (AtkObject *accessible);

Gets the role of the accessible.

atk_object_ref_state_set ()

AtkStateSet* atk_object_ref_state_set       (AtkObject *accessible);

Gets a reference to the state set of the accessible; the caller must unreference it when it is no longer needed.

atk_object_get_index_in_parent ()

gint        atk_object_get_index_in_parent  (AtkObject *accessible);

Gets the 0-based index of this accessible in its parent; returns -1 if the accessible does not have an accessible parent.

atk_object_set_name ()

void        atk_object_set_name             (AtkObject *accessible,
                                             const gchar *name);

Sets the accessible name of the accessible.

atk_object_set_description ()

void        atk_object_set_description      (AtkObject *accessible,
                                             const gchar *description);

Sets the accessible description of the accessible.

atk_object_set_parent ()

void        atk_object_set_parent           (AtkObject *accessible,
                                             AtkObject *parent);

Sets the accessible parent of the accessible.

atk_object_set_role ()

void        atk_object_set_role             (AtkObject *accessible,
                                             AtkRole role);

Sets the role of the accessible.

atk_object_connect_property_change_handler ()

guint       atk_object_connect_property_change_handler
                                            (AtkObject *accessible,
                                             AtkPropertyChangeHandler *handler);

Specifies a function to be called when a property changes value.

atk_object_remove_property_change_handler ()

void        atk_object_remove_property_change_handler
                                            (AtkObject *accessible,
                                             guint handler_id);

Removes a property change handler.

atk_object_notify_state_change ()

void        atk_object_notify_state_change  (AtkObject *accessible,
                                             AtkState state,
                                             gboolean value);

Emits a state-change signal for the specified state.

atk_object_initialize ()

void        atk_object_initialize           (AtkObject *accessible,
                                             gpointer data);

This function is called when implementing subclasses of AtkObject. It does initialization required for the new object. It is intended that this function should called only in the ..._new() functions used to create an instance of a subclass of AtkObject

atk_object_add_relationship ()

gboolean    atk_object_add_relationship     (AtkObject *object,
                                             AtkRelationType relationship,
                                             AtkObject *target);

Adds a relationship of the specified type with the specified target.

atk_object_remove_relationship ()

gboolean    atk_object_remove_relationship  (AtkObject *object,
                                             AtkRelationType relationship,
                                             AtkObject *target);

Removes a relationship of the specified type with the specified target.

atk_role_get_name ()

G_CONST_RETURN gchar* atk_role_get_name     (AtkRole role);

Gets the description string describing the AtkRole role.

atk_role_get_localized_name ()

G_CONST_RETURN gchar* atk_role_get_localized_name
                                            (AtkRole role);

Gets the localized description string describing the AtkRole role.

atk_role_for_name ()

AtkRole     atk_role_for_name               (const gchar *name);

Get the AtkRole type corresponding to a rolew name.

The "active-descendant-changed" signal

void        user_function                  (AtkObject *atkobject,
                                            gpointer arg1,
                                            gpointer user_data);

The "active-descendant-changed" signal is emitted by an object which has the state ATK_STATE_MANAGES_DESCENDANTS when the focus object in the object changes. For instance, a table will emit the signal when the cell in the table which has focus changes.

The "children-changed" signal

void        user_function                  (AtkObject *atkobject,
                                            guint arg1,
                                            gpointer arg2,
                                            gpointer user_data);

The signal "children-changed" is emitted when a child is added or removed form an object. It supports two details: "add" and "remove"

The "focus-event" signal

void        user_function                  (AtkObject *atkobject,
                                            gboolean arg1,
                                            gpointer user_data);

The signal "focus-event" is emitted when an object gains or loses focus.

The "property-change" signal

void        user_function                  (AtkObject *atkobject,
                                            gpointer arg1,
                                            gpointer user_data);

The signal "property-change" is emitted when an object's property value changes. The detail identifies the name of the property whose value has changed.

The "state-change" signal

void        user_function                  (AtkObject *atkobject,
                                            gchar *arg1,
                                            gboolean arg2,
                                            gpointer user_data);

The "state-change" signal is emitted when an object's state changes. The detail value identifies the state type which has changed.

The "visible-data-changed" signal

void        user_function                  (AtkObject *atkobject,
                                            gpointer user_data);

The "visible-data-changed" signal is emitted when the visual appearance of the object changed.