text_buffer<-scan

Did you know ...

Search Documentation:

text_buffer<-scan

text_buffer <-scan: from=int, unit={character,word,line,sentence,paragraph,term}, times=[int], return=[{start,end}] -> index=int

Scan over a number of textual units. This function is used by class editor to determine the range of operations like editor->forward_word, editor->transpose_terms, etc. Arguments:

from Index to start scanning

unit Unit to scan for

times Number of units to skip (<0: backwards)

return start: start of unit, end: end of unit

For example,

get(TextBuffer, scan, 200, word, 2, start, Index)

will scan two words from index 200 and return the start of the 2nd word.

The definitions of the units is determined by the associated text_buffer<-syntax.

from	Index to start scanning
unit	Unit to scan for
times	Number of units to skip (<0: backwards)
return	start: start of unit, end: end of unit