Name
playout:XYToIndex -- convert fro XY to byte index
Synopsis
inside, index, trailing = playout:XYToIndex(x, y)
Function
Converts from X and Y position within a layout to the byte index to the character at that logical position.

If the Y position is not inside the layout, the closest position is chosen (the position will be clamped inside the layout). If the X position is not within the layout, then the start or the end of the line is chosen as described for playoutline:XToIndex(). If either the X or Y positions were not inside the layout, then the function returns FALSE; on an exact hit, it returns True.

This function returns True if the coordinates were inside text, False otherwise

Inputs
x
the X offset (in Pango units) from the left edge of the layout
y
the Y offset (in Pango units) from the top edge of the layout
Results
inside
True if the coordinates were inside text, False otherwise
index
calculated byte index
trailing
integer indicating where in the grapheme the user clicked; it will either be zero, or the number of characters in the grapheme; 0 represents the leading edge of the grapheme

Show TOC