A programming interface that provides supports large Stream of text. The API below included history management, syntax and color highlights and more...

See Also

Widget, TextArea, Stream

Static Variables

Name	Description
`line_count`	Total amount of lines.
Declaration unsigned int line_count
`size`	Size of the string in pixels based on the current Font used by the TextArea connected to the active TextBuffer.
Declaration ivec2 size
`history_index`	Current history buffer index.
Declaration unsigned int history_index
`history_count`	Total available amount of history buffer.
Declaration unsigned int history_count
`stream`	Reference to the Stream associated to the active TextBuffer.
Declaration Stream *stream

Variables

Name	Description
`read_only`	Specify wether or not the TextBuffer is read only.
Declaration bool read_only
`scroll`	Current scroll position on the `X` and `Y` axis.
Declaration ivec2 scroll
`selection`	The current text selection represented by the character index where the selection begin (`X` component) and the end index (`Y` component).
Declaration ivec2 selection
`selection_offset`	The previous `X` position of the selection; usefull when moving from line to line to keep the selection aligned.
Declaration unsigned int selection_offset

Functions

Name	Description
`SetTextBuffer`	Retrieve the line index for a specific character.
Declaration int GetLine( unsigned int char_index ) Parameters `char_index`: Index of the character to retrieve the line for. Return Value `-1` if the character index is invalid; else return the line number where it is located.
`Undo`	Undo the last input step.
Declaration bool Undo( void ) Return Value `true` the operation was successfull; `false` if no history buffer is available.
`Redo`	Redo the last input step.
Declaration bool Redo( void ) Return Value `true` the operation was successfull; `false` if no history buffer is available.
`ClearHistory`	Clear all available history.
Declaration void ClearHistory( void )
`GetCharPosition`	Add a syntax highlight.
Declaration void AddHighlight( unsigned int start_index, unsigned int end_index, const vec3 color ) Parameters `start_index`: Specify the starting character index. `end_index`: Specify the ending character index. `color`: Color to use to draw the character(s).
`HaveHighlight`	Helper the retrieve wether or not the current TextBuffer contains highlights for a specific color.
Declaration bool HaveHighlight( const vec3 color ) Parameters `color`: Color to test. Return Value `true` if the current TextBuffer contains highlight(s) that uses the color received in parameter; else return `false`.
`HaveHighlightAt`	Test if there is a highlight available for specific character range.
Declaration bool HaveHighlightAt( unsigned int start_index, unsigned int end_index, const vec3 color ) Parameters `start_index`: Starting character index. `end_index`: Ending character index. `color`: The color to evaluate for availability. Return Value `true` if a highlight is located within the range specified; `false` if no highlight is present of if either of the index provided are invalid.
`RemoveHighlight`	Remove all highlights that are using a specific color.
Declaration bool RemoveHighlight( const vec3 color ) Parameters `color`: Color used by the highlights to remove. Return Value `false` if no highlights were removed; else return `true`.
`RemoveHighlightAt`	Remove all highlights of a specific color located within a specific character index range.
Declaration bool RemoveHighlightAt( unsigned int start_index, unsigned int end_index, const vec3 color ) Parameters `start_index`: Starting character index. `end_index`: Ending character index. `color`: Color used by the highlights to remove. Return Value `false` if no highlights were removed; else return `true`.
`ClearHighlights`	Remove all highlights.
Declaration void ClearHighlights( void )
`ClearSyntaxHighlights`	Remove all builtin syntax highlights.
Declaration void ClearSyntaxHighlights( void )
`OrderSelection`	Reorder the active selection to insure that the start and end position does not overlap each other.
Declaration ivec2 OrderSelection( void ) Return Value The ordered selection character index.