TextIter.forwardToLineEnd

Moves the iterator to point to the paragraph delimiter characters.

The possible characters are either a newline, a carriage return, a carriage return/newline in sequence, or the Unicode paragraph separator character.

If the iterator is already at the paragraph delimiter characters, moves to the paragraph delimiter characters for the next line. If @iter is on the last line in the buffer, which does not end in paragraph delimiters, moves to the end iterator (end of the last line), and returns %FALSE.

class TextIter
bool
forwardToLineEnd
()

Return Value

Type: bool

%TRUE if we moved and the new location is not the end iterator

Meta