![]() | ![]() | ![]() | AT-SPI C Bindings Reference Manual | ![]() |
---|
enum AccessibleCoordType; enum AccessibleComponentLayer; void AccessibleComponent_ref (AccessibleComponent *obj); void AccessibleComponent_unref (AccessibleComponent *obj); SPIBoolean 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); AccessibleComponentLayer AccessibleComponent_getLayer (AccessibleComponent *obj); short AccessibleComponent_getMDIZOrder (AccessibleComponent *obj); SPIBoolean AccessibleComponent_grabFocus (AccessibleComponent *obj);
typedef enum { SPI_COORD_TYPE_SCREEN, SPI_COORD_TYPE_WINDOW } AccessibleCoordType;
typedef enum { SPI_LAYER_INVALID, SPI_LAYER_BACKGROUND, SPI_LAYER_CANVAS, SPI_LAYER_WIDGET, SPI_LAYER_MDI, SPI_LAYER_POPUP, SPI_LAYER_OVERLAY, SPI_LAYER_WINDOW, SPI_LAYER_LAST_DEFINED } AccessibleComponentLayer;
The layer cannot be determined or is somehow undefined.
Component belongs to the destop background.
Component is a canvas backdrop or drawing area.
Component is a 'normal' widget.
Component is drawn in the MDI layer and may have valid Z-information relative to other MDI-layer components.
Component is in the popup layer, above other widgets and MDI components.
Component is in the overlay plane - this value is reserved for future use.
Component is in the window layer and have valid Z-information relative to other window-layer components.
Used to determine the last valid value in the enum, should not be encountered.
void AccessibleComponent_ref (AccessibleComponent *obj);
Increment the reference count for an AccessibleComponent.
a pointer to an object implementing AccessibleComponent on which to operate.
void AccessibleComponent_unref (AccessibleComponent *obj);
Decrement the reference count for an AccessibleComponent.
a pointer to the object implementing AccessibleComponent on which to operate.
SPIBoolean AccessibleComponent_contains (AccessibleComponent *obj, long int x, long int y, AccessibleCoordType ctype);
Query whether a given AccessibleComponent contains a particular point.
a pointer to the AccessibleComponent to query.
a long specifying the x coordinate in question.
a long specifying the y coordinate in question.
the desired coordinate system of the point (x, y) (e.g. CSPI_COORD_TYPE_WINDOW, CSPI_COORD_TYPE_SCREEN).
a TRUE if the specified component contains the point (x, y), otherwise FALSE.
Accessible* AccessibleComponent_getAccessibleAtPoint (AccessibleComponent *obj, long int x, long int y, AccessibleCoordType ctype);
Get the accessible child at a given coordinate within an AccessibleComponent.
a pointer to the AccessibleComponent to query.
a long specifying the x coordinate of the point in question.
a long specifying the y coordinate of the point in question.
the coordinate system of the point (x, y) (e.g. CSPI_COORD_TYPE_WINDOW, CSPI_COORD_TYPE_SCREEN).
a pointer to an Accessible child of the specified component which contains the point (x, y), or NULL of no child contains the point.
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.
a pointer to the AccessibleComponent to query.
a pointer to a long into which the minimum x coordinate will be returned.
a pointer to a long into which the minimum y coordinate will be returned.
a pointer to a long into which the x extents (width) will be returned.
a pointer to a long into which the y extents (height) will be returned.
the desired coordinate system into which to return the results, (e.g. CSPI_COORD_TYPE_WINDOW, CSPI_COORD_TYPE_SCREEN).
void AccessibleComponent_getPosition (AccessibleComponent *obj, long int *x, long int *y, AccessibleCoordType ctype);
Get the minimum x and y coordinates of the specified AccessibleComponent.
a pointer to the AccessibleComponent to query.
a pointer to a long into which the minimum x coordinate will be returned.
a pointer to a long into which the minimum y coordinate will be returned.
the desired coordinate system into which to return the results, (e.g. CSPI_COORD_TYPE_WINDOW, CSPI_COORD_TYPE_SCREEN).
void AccessibleComponent_getSize (AccessibleComponent *obj, long int *width, long int *height);
Get the size of the specified AccessibleComponent.
a pointer to the AccessibleComponent to query.
a pointer to a long into which the x extents (width) will be returned.
a pointer to a long into which the y extents (height) will be returned.
AccessibleComponentLayer AccessibleComponent_getLayer (AccessibleComponent *obj);
Query which layer the component is painted into, to help determine its visibility in terms of stacking order.
a pointer to the AccessibleComponent to query.
the AccessibleComponentLayer into which this component is painted.
short AccessibleComponent_getMDIZOrder (AccessibleComponent *obj);
Query the z stacking order of a component which is in the MDI or window layer. (Bigger z-order numbers mean nearer the top)
a pointer to the AccessibleComponent to query.
a short integer indicating the stacking order of the component in the MDI layer, or -1 if the component is not in the MDI layer.
<<< AccessibleAction Interface | AccessibleEditableText Interface >>> |