AccessibleComponent Interface

Name

AccessibleComponent Interface -- 

Synopsis



enum        AccessibleCoordType;
int         AccessibleComponent_ref         (AccessibleComponent *obj);
int         AccessibleComponent_unref       (AccessibleComponent *obj);
boolean     AccessibleComponent_contains    (AccessibleComponent *obj,
                                             long int x,
                                             long int y,
                                             AccessibleCoordType ctype);
Accessible* AccessibleComponent_getAccessibleAtPoint
                                            (AccessibleComponent *obj,
                                             long int x,
                                             long int y,
                                             AccessibleCoordType ctype);
void        AccessibleComponent_getExtents  (AccessibleComponent *obj,
                                             long int *x,
                                             long int *y,
                                             long int *width,
                                             long int *height,
                                             AccessibleCoordType ctype);
void        AccessibleComponent_getPosition (AccessibleComponent *obj,
                                             long int *x,
                                             long int *y,
                                             AccessibleCoordType ctype);
void        AccessibleComponent_getSize     (AccessibleComponent *obj,
                                             long int *width,
                                             long int *height);
void        AccessibleComponent_grabFocus   (AccessibleComponent *obj);

Description

Details

enum AccessibleCoordType

typedef enum {
  SPI_COORD_TYPE_SCREEN,
  SPI_COORD_TYPE_WINDOW
} AccessibleCoordType;


AccessibleComponent_ref ()

int         AccessibleComponent_ref         (AccessibleComponent *obj);

Increment the reference count for an AccessibleComponent.

obj : a pointer to an object implementing AccessibleComponent on which to operate.
Returns : (no return code implemented yet).


AccessibleComponent_unref ()

int         AccessibleComponent_unref       (AccessibleComponent *obj);

Decrement the reference count for an AccessibleComponent.

obj : a pointer to the object implementing AccessibleComponent on which to operate.
Returns : (no return code implemented yet).


AccessibleComponent_contains ()

boolean     AccessibleComponent_contains    (AccessibleComponent *obj,
                                             long int x,
                                             long int y,
                                             AccessibleCoordType ctype);

Query whether a given AccessibleComponent contains a particular point.

obj : a pointer to the AccessibleComponent to query.
x : a long specifying the x coordinate in question.
y : a long specifying the y coordinate in question.
ctype : the desired coordinate system of the point (x, y) (e.g. SPI_COORD_TYPE_WINDOW, SPI_COORD_TYPE_SCREEN).
Returns : a TRUE if the specified component contains the point (x, y), otherwise FALSE.


AccessibleComponent_getAccessibleAtPoint ()

Accessible* AccessibleComponent_getAccessibleAtPoint
                                            (AccessibleComponent *obj,
                                             long int x,
                                             long int y,
                                             AccessibleCoordType ctype);

Get the accessible child at a given coordinate within an AccessibleComponent.

obj : a pointer to the AccessibleComponent to query.
x : a long specifying the x coordinate of the point in question.
y : a long specifying the y coordinate of the point in question.
ctype : the coordinate system of the point (x, y) (e.g. SPI_COORD_TYPE_WINDOW, SPI_COORD_TYPE_SCREEN).
Returns : a pointer to an Accessible child of the specified component which contains the point (x, y), or NULL of no child contains the point.


AccessibleComponent_getExtents ()

void        AccessibleComponent_getExtents  (AccessibleComponent *obj,
                                             long int *x,
                                             long int *y,
                                             long int *width,
                                             long int *height,
                                             AccessibleCoordType ctype);

Get the bounding box of the specified AccessibleComponent.

obj : a pointer to the AccessibleComponent to query.
x : a pointer to a long into which the minimum x coordinate will be returned.
y : a pointer to a long into which the minimum y coordinate will be returned.
width : a pointer to a long into which the x extents (width) will be returned.
height : a pointer to a long into which the y extents (height) will be returned.
ctype : the desired coordinate system into which to return the results, (e.g. SPI_COORD_TYPE_WINDOW, SPI_COORD_TYPE_SCREEN).


AccessibleComponent_getPosition ()

void        AccessibleComponent_getPosition (AccessibleComponent *obj,
                                             long int *x,
                                             long int *y,
                                             AccessibleCoordType ctype);

Get the minimum x and y coordinates of the specified AccessibleComponent.

obj : a pointer to the AccessibleComponent to query.
x : a pointer to a long into which the minimum x coordinate will be returned.
y : a pointer to a long into which the minimum y coordinate will be returned.
ctype : the desired coordinate system into which to return the results, (e.g. SPI_COORD_TYPE_WINDOW, SPI_COORD_TYPE_SCREEN).


AccessibleComponent_getSize ()

void        AccessibleComponent_getSize     (AccessibleComponent *obj,
                                             long int *width,
                                             long int *height);

Get the size of the specified AccessibleComponent.

obj : a pointer to the AccessibleComponent to query.
width : a pointer to a long into which the x extents (width) will be returned.
height : a pointer to a long into which the y extents (height) will be returned.


AccessibleComponent_grabFocus ()

void        AccessibleComponent_grabFocus   (AccessibleComponent *obj);

Attempt to set the keyboard input focus to the specified AccessibleComponent.

obj : a pointer to the AccessibleComponent on which to operate.