get_bounded_ranges


Description:

public Array<TextRange> get_bounded_ranges (int x, int y, int width, int height, CoordType type, TextClipType clipTypeX, TextClipType clipTypeY) throws Error

Gets the ranges of text from an Text object which lie within the bounds defined by ( x, y) and (x+width, y+height).

Parameters:

this

a pointer to the Text object on which to operate.

x

the 'starting' x coordinate of the bounding box.

y

the 'starting' y coordinate of the bounding box.

width

the x extent of the bounding box.

height

the y extent of the bounding box.

type

an AccessibleCoordType indicating the coordinate system to use for the returned values.

clipTypeX

an TextClipType indicating how to treat characters that intersect the bounding box's x extents.

clipTypeY

an TextClipType indicating how to treat characters that intersect the bounding box's y extents.

Returns:

a null-terminated list of pointers to TextRange structs detailing the bounded text.