|
|
|
ATK - Accessibility Toolkit | |
|---|---|---|---|---|
AtkComponentAtkComponent — The ATK interface provided by UI components which occupy a physical area on the screen. |
AtkComponent;
guint atk_component_add_focus_handler (AtkComponent *component,
AtkFocusHandler handler);
gboolean atk_component_contains (AtkComponent *component,
gint x,
gint y,
AtkCoordType coord_type);
void atk_component_get_extents (AtkComponent *component,
gint *x,
gint *y,
gint *width,
gint *height,
AtkCoordType coord_type);
AtkLayer atk_component_get_layer (AtkComponent *component);
gint atk_component_get_mdi_zorder (AtkComponent *component);
void atk_component_get_position (AtkComponent *component,
gint *x,
gint *y,
AtkCoordType coord_type);
void atk_component_get_size (AtkComponent *component,
gint *width,
gint *height);
gboolean atk_component_grab_focus (AtkComponent *component);
AtkObject* atk_component_ref_accessible_at_point
(AtkComponent *component,
gint x,
gint y,
AtkCoordType coord_type);
void atk_component_remove_focus_handler (AtkComponent *component,
guint handler_id);
gboolean atk_component_set_extents (AtkComponent *component,
gint x,
gint y,
gint width,
gint height,
AtkCoordType coord_type);
gboolean atk_component_set_position (AtkComponent *component,
gint x,
gint y,
AtkCoordType coord_type);
gboolean atk_component_set_size (AtkComponent *component,
gint width,
gint height);
gdouble atk_component_get_alpha (AtkComponent *component);
AtkComponent should be implemented by most if not all UI elements with an actual on-screen presence, i.e. components which can be said to have a screen-coordinate bounding box. Virtually all widgets will need to have AtkComponent implementations provided for their corresponding AtkObject class. In short, only UI elements which are *not* GUI elements will omit this ATK interface.
A possible exception might be textual information with a transparent background, in which case text glyph bounding box information is provided by AtkText.
typedef struct _AtkComponent AtkComponent;
The AtkComponent structure does not contain any fields.
guint atk_component_add_focus_handler (AtkComponent *component, AtkFocusHandler handler);
Add the specified handler to the set of functions to be called when this object receives focus events (in or out). If the handler is already added it is not added again
|
The AtkComponent to attach the handler to
|
|
The AtkFocusHandler to be attached to component
|
Returns : |
a handler id which can be used in atk_component_remove_focus_handler or zero if the handler was already added. |
gboolean atk_component_contains (AtkComponent *component, gint x, gint y, AtkCoordType coord_type);
Checks whether the specified point is within the extent of the component.
|
the AtkComponent |
|
x coordinate |
|
y coordinate |
|
specifies whether the coordinates are relative to the screen or to the components top level window |
Returns : |
TRUE or FALSE indicating whether the specified point is within
the extent of the component or not
|
void atk_component_get_extents (AtkComponent *component, gint *x, gint *y, gint *width, gint *height, AtkCoordType coord_type);
Gets the rectangle which gives the extent of the component.
|
an AtkComponent |
|
address of gint to put x coordinate |
|
address of gint to put y coordinate |
|
address of gint to put width |
|
address of gint to put height |
|
specifies whether the coordinates are relative to the screen or to the components top level window |
AtkLayer atk_component_get_layer (AtkComponent *component);
Gets the layer of the component.
|
an AtkComponent |
Returns : |
an AtkLayer which is the layer of the component |
gint atk_component_get_mdi_zorder (AtkComponent *component);
Gets the zorder of the component. The value G_MININT will be returned if the layer of the component is not ATK_LAYER_MDI or ATK_LAYER_WINDOW.
|
an AtkComponent |
Returns : |
a gint which is the zorder of the component, i.e. the depth at which the component is shown in relation to other components in the same container. |
void atk_component_get_position (AtkComponent *component, gint *x, gint *y, AtkCoordType coord_type);
Gets the position of component in the form of
a point specifying component's top-left corner.
|
an AtkComponent |
|
address of gint to put x coordinate position |
|
address of gint to put y coordinate position |
|
specifies whether the coordinates are relative to the screen or to the components top level window |
void atk_component_get_size (AtkComponent *component, gint *width, gint *height);
Gets the size of the component in terms of width and height.
|
an AtkComponent |
|
address of gint to put width of component
|
|
address of gint to put height of component
|
gboolean atk_component_grab_focus (AtkComponent *component);
Grabs focus for this component.
|
an AtkComponent |
Returns : |
TRUE if successful, FALSE otherwise.
|
AtkObject* atk_component_ref_accessible_at_point (AtkComponent *component, gint x, gint y, AtkCoordType coord_type);
Gets a reference to the accessible child, if one exists, at the
coordinate point specified by x and y.
|
the AtkComponent |
|
x coordinate |
|
y coordinate |
|
specifies whether the coordinates are relative to the screen or to the components top level window |
Returns : |
a reference to the accessible child, if one exists |
void atk_component_remove_focus_handler (AtkComponent *component, guint handler_id);
Remove the handler specified by handler_id from the list of
functions to be executed when this object receives focus events
(in or out).
|
the AtkComponent to remove the focus handler from |
|
the handler id of the focus handler to be removed
from component
|
gboolean atk_component_set_extents (AtkComponent *component, gint x, gint y, gint width, gint height, AtkCoordType coord_type);
Sets the extents of component.
|
an AtkComponent |
|
x coordinate |
|
y coordinate |
|
width to set for component
|
|
height to set for component
|
|
specifies whether the coordinates are relative to the screen or to the components top level window |
Returns : |
TRUE or FALSE whether the extents were set or not
|
gboolean atk_component_set_position (AtkComponent *component, gint x, gint y, AtkCoordType coord_type);
Sets the postition of component.
|
an AtkComponent |
|
x coordinate |
|
y coordinate |
|
specifies whether the coordinates are relative to the screen or to the components top level window |
Returns : |
TRUE or FALSE whether or not the position was set or not
|
gboolean atk_component_set_size (AtkComponent *component, gint width, gint height);
Set the size of the component in terms of width and height.
|
an AtkComponent |
|
width to set for component
|
|
height to set for component
|
Returns : |
TRUE or FALSE whether the size was set or not
|
gdouble atk_component_get_alpha (AtkComponent *component);
Returns the alpha value (i.e. the opacity) for this
component, on a scale from 0 (fully transparent) to 1.0
(fully opaque).
|
an AtkComponent |
Returns : |
An alpha value from 0 to 1.0, inclusive. |
Since ATK 1.12
"bounds-changed" signalvoid user_function (AtkComponent *atkcomponent, AtkRectangle *arg1, gpointer user_data) : Run Last
The 'bounds-changed" signal is emitted when the bposition or size of the a component changes.
|
the object which received the signal. |
|
The AtkRectangle giving the new position and size. |
|
user data set when the signal handler was connected. |