REBOL Programming/offset-to-caret

From Wikibooks, open books for an open world
< REBOL Programming
Jump to: navigation, search

USAGE:[edit]

OFFSET-TO-CARET face offset 

DESCRIPTION:[edit]

Returns the offset in the face's text corresponding to the offset pair.

OFFSET-TO-CARET is a native value.

ARGUMENTS:[edit]

  • face -- The face containing the text. (Type: object)
  • offset -- The XY offset relative to the face. (Type: pair)

SOURCE CODE[edit]

offset-to-caret: native[
    {Returns the offset in the face's text corresponding to the offset pair.} 
    face [object!] "The face containing the text." 
    offset [pair!] "The XY offset relative to the face."
]