Name
pglyphstring:XToIndex -- convert from x offset to character position
Synopsis
index, trailing = pglyphstring:XToIndex(text$, analysis, x_pos)
Function
Convert from x offset to character position.

Character positions are computed by dividing up each cluster into equal portions. In scripts where positioning within a cluster is not allowed (such as Thai), the returned value may not be a valid cursor position; the caller must combine the result with the logical attributes for the text to compute the valid cursor position.

Inputs
text$
the text for the run
analysis
the analysis information return from itemize; this must be a Pango analysis object
x_pos
the x offset (in Pango units)
Results
index
calculated byte index within text$
trailing
boolean indicating whether the user clicked on the leading or trailing edge of the character

Show TOC