Method

AtspiTextget_bounded_ranges

Declaration [src]

GArray*
atspi_text_get_bounded_ranges (
  AtspiText* obj,
  gint x,
  gint y,
  gint width,
  gint height,
  AtspiCoordType type,
  AtspiTextClipType clipTypeX,
  AtspiTextClipType clipTypeY,
  GError** error
)

Description [src]

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

Parameters

x gint
 

The ‘starting’ x coordinate of the bounding box.

y gint
 

The ‘starting’ y coordinate of the bounding box.

width gint
 

The x extent of the bounding box.

height gint
 

The y extent of the bounding box.

type AtspiCoordType
 

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

clipTypeX AtspiTextClipType
 

An AtspiTextClipType indicating how to treat characters that intersect the bounding box’s x extents.

clipTypeY AtspiTextClipType
 

An AtspiTextClipType indicating how to treat characters that intersect the bounding box’s y extents.

error GError **
  The return location for a GError*, or NULL.

Return value

Returns: An array of None
 

A null-terminated list of pointers to AtspiTextRange structs detailing the bounded text.

 The caller of the method takes ownership of the data, and is responsible for freeing it.