ATK Library Reference Manual | |||
---|---|---|---|
<<< Previous Page | Home | Up | Next Page >>> |
"accessible-name" gchararray : Read / Write "accessible-description" gchararray : Read / Write "accessible-parent" AtkObject : Read / Write "accessible-value" gdouble : Read / Write "accessible-role" gint : Read / Write "accessible-component-layer" gint : Read "accessible-component-mdi-zorder" gint : Read "accessible-table-caption" gchararray : Read / Write "accessible-table-column-description" gchararray : Read / Write "accessible-table-column-header" AtkObject : Read / Write "accessible-table-row-description" gchararray : Read / Write "accessible-table-row-header" AtkObject : Read / Write "accessible-table-summary" AtkObject : Read / Write |
"active-descendant-changed" void user_function (AtkObject *atkobject, gpointer arg1, gpointer user_data); "children-changed" void user_function (AtkObject *atkobject, guint arg1, gpointer arg2, gpointer user_data); "focus-event" void user_function (AtkObject *atkobject, gboolean arg1, gpointer user_data); "property-change" void user_function (AtkObject *atkobject, gpointer arg1, gpointer user_data); "state-change" void user_function (AtkObject *atkobject, gchar *arg1, gboolean arg2, gpointer user_data); "visible-data-changed" void user_function (AtkObject *atkobject, gpointer user_data); |
This class is the primary class for accessibility support via the Accessibility ToolKit (ATK). Objects which are instances of AtkObject (or instances of AtkObject-derived types) are queried for properties which relate basic (and generic) properties of a UI component such as name and description. Instances of AtkObject may also be queried as to whether they implement other ATK interfaces (e.g. AtkAction, AtkComponent, etc.), as appropriate to the role which a given UI component plays in a user interface.
All UI components in an application which provide useful information or services to the user must provide corresponding AtkObject instances on request (in GTK+, for instance, usually on a call to #gtk_widget_get_accessible()), either via ATK support built into the toolkit for the widget class or ancestor class, or in the case of custom widgets, if the inherited AtkObject implementation is insufficient, via instances of a new AtkObject subclass.
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_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.
Invalid role
A label which represents an accelerator
An object which is an alert to the user
An object which is an animated image
An arrow in one of the four cardinal directions
An object that displays a calendar and allows the user to select a date
An object that can be drawn into and is used to trap events
A choice that can be checked or unchecked and provides a separate indicator for the current state
A menu item with a check box
A specialized dialog that lets the user choose a color
The header for a column of data
A list of choices the user can select from
An object whose purpose is to allow a user to edit a date
An inconifed internal frame within a DESKTOP_PANE
A pane that supports internal frames and iconified versions of those internal frames
An object whose purpose is to allow a user to set a value
A top level window with title bar and a border
A pane that allows the user to navigate through and select the contents of a directory
An object used for drawing custom user interface elements
A specialized dialog that lets the user choose a file
A object that fills up space in a user interface
A specialized dialog that lets the user choose a font
A top level window with a title bar, border, menubar, etc.
A pane that is guaranteed to be painted on top of all panes beneath it
A document container for HTML, whose children represent the document content
A small fixed size picture, typically used to decorate components
An object whose primary purpose is to display an image
A frame-like object that is clipped by a desktop pane
An object used to present an icon or short string in an interface
A specialized pane that allows its children to be drawn in layers, providing a form of stacking order
An object that presents a list of objects to the user and allows the user to select one or more of them
An object that represents an element of a list
An object usually found inside a menu bar that contains a list of actions the user can choose from
An object usually drawn at the top of the primary dialog box of an application that contains a list of menus the user can choose from
An object usually contained in a menu that presents an action the user can choose
A specialized pane whose primary use is inside a DIALOG
An object that is a child of a page tab list
An object that presents a series of panels (or page tabs), one at a time, through some mechanism provided by the object
A generic container that is often used to group objects
A text object uses for passwords, or other places where the text content is not shown visibly to the user
A temporary window that is usually used to offer the user a list of choices, and then hides when the user selects one of those choices
An object used to indicate how much of a task has been completed
An object the user can manipulate to tell the application to do something
A specialized check box that will cause other radio buttons in the same group to become unchecked when this one is checked
A check menu item which belongs to a group. At each instant exactly one of the radio menu items from a group is selected
A specialized pane that has a glass pane and a layered pane as its children
The header for a row of data
An object usually used to allow a user to incrementally view a large amount of data.
An object that allows a user to incrementally view a large amount of information
An object usually contained in a menu to provide a visible and logical separation of the contents in a menu
An object that allows the user to select from a bounded range
A specialized panel that presents two other panels at the same time
An object used to get an integer or floating point number from the user
An object which reports messages of minor importance to the user
An object used to represent information in terms of rows and columns
A cell in a table
The header for a column of a table
The header for a row of a table
A menu item used to tear off and reattach its menu
An object that represents an accessible terminal
An object that presents text to the user
A specialized push button that can be checked or unchecked, but does not provide a separate indicator for the current state
A bar or palette usually composed of push buttons or toggle buttons
An object that provides information about another object
An object used to represent hierarchical information to the user
An object capable of expanding and collapsing rows as well as showing multiple columns of data
The object contains some Accessible information, but its role is not known
An object usually used in a scroll pane
A top level window with no title or border.
An object that serves as a document header.
An object that serves as a document footer.
An object which is contains a paragraph of text content.
An object which describes margins and tab stops, etc. for text objects which it controls (should have CONTROLLER_FOR relation to such).
not a valid role, used for finding end of enumeration
AtkRole atk_role_register (const gchar *name); |
Registers the role specified by name.
a character string describing the new role.
an AtkRole for the new role.
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.
The object does not have a layer
This layer is reserved for the desktop background
This layer is used for Canvas components
This layer is normally used for components
This layer is used for layered components
This layer is used for popup components, such as menus
This layer is reserved for future use.
This layer is used for toplevel windows.
struct AtkImplementor; |
The AtkImplementor structure does not contain any fields.
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.
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.
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().
AtkObject* atk_implementor_ref_accessible (AtkImplementor *implementor); |
Gets a reference to an object's AtkObject implementation, if the object implements AtkObjectIface
The GObject instance which should implement AtkImplementorIface if a non-null return value is required.
a reference to an object's AtkObject implementation
G_CONST_RETURN gchar* atk_object_get_name (AtkObject *accessible); |
Gets the accessible name of the accessible.
an AtkObject
a character string representing the accessible name of the object.
G_CONST_RETURN gchar* atk_object_get_description (AtkObject *accessible); |
Gets the accessible description of the accessible.
an AtkObject
a character string representing the accessible description of the accessible.
AtkObject* atk_object_get_parent (AtkObject *accessible); |
Gets the accessible parent of the accessible.
an AtkObject
a AtkObject representing the accessible parent of the accessible
gint atk_object_get_n_accessible_children (AtkObject *accessible); |
Gets the number of accessible children of the accessible.
an AtkObject
an integer representing the number of accessible children of the accessible.
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.
an AtkObject
a gint representing the position of the child, starting from 0
an AtkObject representing the specified accessible child of the accessible.
AtkRelationSet* atk_object_ref_relation_set (AtkObject *accessible); |
Gets the AtkRelationSet associated with the object.
an AtkObject
an AtkRelationSet representing the relation set of the object.
AtkLayer atk_object_get_layer (AtkObject *accessible); |
Gets the layer of the accessible. DEPRECATED: use atk_component_get_layer instead!
an AtkObject
an AtkLayer which is the layer of the accessible
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. DEPRECATED: use atk_component_get_mdi_zorder instead!
an AtkObject
a gint which is the zorder of the accessible, i.e. the depth at which the component is shown in relation to other components in the same container.
AtkRole atk_object_get_role (AtkObject *accessible); |
Gets the role of the accessible.
an AtkObject
an AtkRole which is the role of the accessible
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.
an AtkObject
a reference to an AtkStateSet which is the state set of the accessible
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.
an AtkObject
an integer which is the index of the accessible in its parent
void atk_object_set_name (AtkObject *accessible, const gchar *name); |
Sets the accessible name of the accessible.
an AtkObject
a character string to be set as the accessible name
void atk_object_set_description (AtkObject *accessible, const gchar *description); |
Sets the accessible description of the accessible.
an AtkObject
a character string to be set as the accessible description
void atk_object_set_parent (AtkObject *accessible, AtkObject *parent); |
Sets the accessible parent of the accessible.
an AtkObject
an AtkObject to be set as the accessible parent
void atk_object_set_role (AtkObject *accessible, AtkRole role); |
Sets the role of the accessible.
an AtkObject
an AtkRole to be set as the role
guint atk_object_connect_property_change_handler (AtkObject *accessible, AtkPropertyChangeHandler *handler); |
Specifies a function to be called when a property changes value.
an AtkObject
a function to be called when a property changes its value
a guint which is the handler id used in atk_object_remove_property_change_handler()
void atk_object_remove_property_change_handler (AtkObject *accessible, guint handler_id); |
Removes a property change handler.
an AtkObject
a guint which identifies the handler to be removed.
void atk_object_notify_state_change (AtkObject *accessible, AtkState state, gboolean value); |
Emits a state-change signal for the specified state.
an AtkObject
an AtkState whose state is changed
a gboolean which indicates whether the state is being set on or off
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
a gpointer which identifies the object for which the AtkObject was created.
gboolean atk_object_add_relationship (AtkObject *object, AtkRelationType relationship, AtkObject *target); |
Adds a relationship of the specified type with the specified target.
The AtkObject to which an AtkRelation is to be added.
The AtkRelationType of the relation
The AtkObject which is to be the target of the relation.
TRUE if the relationship is added.
gboolean atk_object_remove_relationship (AtkObject *object, AtkRelationType relationship, AtkObject *target); |
Removes a relationship of the specified type with the specified target.
The AtkObject from which an AtkRelation is to be removed.
The AtkRelationType of the relation
The AtkObject which is the target of the relation to be removed.
TRUE if the relationship is removed.
G_CONST_RETURN gchar* atk_role_get_name (AtkRole role); |
Gets the description string describing the AtkRole role.
The AtkRole whose name is required
the string describing the AtkRole
G_CONST_RETURN gchar* atk_role_get_localized_name (AtkRole role); |
Gets the localized description string describing the AtkRole role.
The AtkRole whose localized name is required
the localized string describing the AtkRole
AtkRole atk_role_for_name (const gchar *name); |
Get the AtkRole type corresponding to a rolew name.
a string which is the (non-localized) name of an ATK role.
the AtkRole enumerated type corresponding to the specified name, or ATK_ROLE_INVALID if no matching role is found.
Object instance's name formatted for assistive technology access.
Description of an object, formatted for assistive technology access.
Is used to notify that the parent has changed .
Is used to notify that the value has changed .
The accessible role of this object .
The accessible layer of this object .
The accessible MDI value of this object .
Is used to notify that the table caption has changed .
Is used to notify that the table columnscription has changed .
Is used to notify that the table column header has changed .
Is used to notify that the table row description has changed .
Is used to notify that the table row header has changed .
Is used to notify that the table summary has changed .
void user_function (AtkObject *atkobject, gpointer arg1, gpointer user_data); |
the object which received the signal.
user data set when the signal handler was connected.
void user_function (AtkObject *atkobject, guint arg1, gpointer arg2, gpointer user_data); |
The children_changed signal supports two details, "add" and "remove" which indicate whether a child was added or removed
the object which received the signal.
The index of the added or removed child
The child which was added or removed
user data set when the signal handler was connected.
void user_function (AtkObject *atkobject, gboolean arg1, gpointer user_data); |
the object which received the signal.
A boolean value which indicates whether or not the focus event is is or out.
user data set when the signal handler was connected.
void user_function (AtkObject *atkobject, gpointer arg1, gpointer user_data); |
This signal support a detail which identifies the property which has changed.
the object which received the signal.
The new value of the property which changed.
user data set when the signal handler was connected.
void user_function (AtkObject *atkobject, gchar *arg1, gboolean arg2, gpointer user_data); |
This signal support, which may be any of the accessible state types.
the object which received the signal.
The name of the state which has changed
A boolean which indicates whether the state has been set or unset.
user data set when the signal handler was connected.