Gets the text that you need to draw, guaranteeing each call to your delegate will:
* Have a contiguous slice into text
* Have exactly one style (which may be null, meaning use all your default values. Be sure you draw with the same font you passed as the default font to TextLayouter.)
* Be a linear block of text that fits in a single rectangular segment
* A segment will be as large a block of text as the implementation can do, but it may be as short as a single char.
* The segment may be a special escape sequence. FIXME explain how to check this.
Return false from your delegate to stop iterating through the text.
Please note that the caretPosition can be Rectangle.init, indicating it is not present in this segment. If it is not that, it will be the bounding box of the glyph.
You can use the startFrom parameter to skip ahead. The intended use case for this is to start from a scrolling position in the box; the first segment given will include this point. FIXME: maybe it should just go ahead and do a bounding box. Note that the segments may extend outside the point; it is just meant that it will include that and try to trim the rest.
The segment may include all forms of whitespace, including newlines, tab characters, etc. Generally, a tab character will be in its own segment and \n will appear at the end of a segment. You will probably want to stripRight each segment depending on your drawing functions.
Gets the text that you need to draw, guaranteeing each call to your delegate will:
* Have a contiguous slice into text * Have exactly one style (which may be null, meaning use all your default values. Be sure you draw with the same font you passed as the default font to TextLayouter.) * Be a linear block of text that fits in a single rectangular segment * A segment will be as large a block of text as the implementation can do, but it may be as short as a single char. * The segment may be a special escape sequence. FIXME explain how to check this.
Return false from your delegate to stop iterating through the text.
Please note that the caretPosition can be Rectangle.init, indicating it is not present in this segment. If it is not that, it will be the bounding box of the glyph.
You can use the startFrom parameter to skip ahead. The intended use case for this is to start from a scrolling position in the box; the first segment given will include this point. FIXME: maybe it should just go ahead and do a bounding box. Note that the segments may extend outside the point; it is just meant that it will include that and try to trim the rest.
The segment may include all forms of whitespace, including newlines, tab characters, etc. Generally, a tab character will be in its own segment and \n will appear at the end of a segment. You will probably want to stripRight each segment depending on your drawing functions.