A component that turns a Widget into a single or multiple text input box. Based on the TextBoxType specified the textbox input can be restricted to only handle letters or numbers.

See Also

Widget, Texture, Font

Static Variables

Name	Description
`widget`	Parent Widget where the TextBox component is defined.
Declaration Widget *widget
`font`	Reference to the Font to use when drawing the TextBox.
Declaration Font *font
`textbuffer`	Total amount of characters currently cached.
Declaration unsigned int length
`size`	Size of the string in pixels based on the current Font used by the TextBox.
Declaration ivec2 size

Variables

Name	Description
`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
`margin`	Specify the margin to use when drawing the TextBox.
Declaration guide margin
`centered`	Determine if the string of the TextBox should be centered.
Declaration bool centered
`read_only`	Enable or disable the text input to be read-only.
Declaration bool read_only
`max_char`	Maximum of characters allowed to input.
Declaration unsigned int max_char
`string`	Current text set for the TextBox.
Declaration char *string

Functions

Name	Description
`SetTextBuffer`	Helper that return the Label alignment size in pixels taking in consideration if its margin and centered state.
Declaration ivec2 GetAlignment( void )
`InsertChar`	Insert a character at the current selection.
Declaration bool InsertChar( unsigned char ascii ) Parameters `ascii`: ASCII number to insert. Return Value `true` if the character have been inserted properly; else return `false` (in the event the character is invalid or the TextBox is read-only).
`InsertString`	Insert a string of text at the current TextBuffer selection.
Declaration bool InsertString( const char s ) Parameters* `s`: The string to insert. Return Value `true` if the string have been inserted properly; else return `false` if the TextBuffer is read-only.
`GetCharIndex`	Retrieve the nearest character index at a position specified in window space.
Declaration int GetCharIndex( const ivec2 v ) Parameters `v`: Hit position. Return Value `-1` if the point provided is outside of the TextBox; else return the nearest characted index in proximity of the hit point.
`GetCharPosition`	Retrieve the 2D coordinates of a specific character.
Declaration ivec2 GetCharPosition( unsigned int char_index ) Parameters `char_index`: Specify the character index to retrieve the position for. Return Value A zeroed vector if the character index does not exists; else return its 2D coordinates.
`GetSelectedString`	Retrieve the current selected string in the TextBuffer.
Declaration const char GetSelectedString( void ) Return Value* `nil` if no string is selected; else return the selected string.
`AdjustScroll`	Adjust the TextBox scroll based on its associated TextBuffer selection.
Declaration void AdjustScroll( void )
`SetValue`	Helper that converts a value to a string.
Declaration void SetValue( float value ) Parameters `value`: Value to convert to string.
`GetValue`	Helper that conver the current TextBox string back to a floating point number.
Declaration float GetValue( void )

TextBoxType

Constant value that defines the sub-type of the TextBox. Based on this type the TextBox insertion methods will be affected.

kAscii: Only allow letters.
kNumeric: Only allow numbers.
kAlphaNumeric: Allow only a combination of letters and numbers.
kVariable: Only allow characters that can be used to form a variable name.