Catlike Coding
Unity Code Documentation
Public Member Functions | Public Attributes | List of all members
CatlikeCoding.TextBox.TextBoxCursorInfo Struct Reference

Information about how to place a cursor in a text box. More...

Public Member Functions

override string ToString ()
 Return a string representation of a CatlikeCoding.TextBox.TextBoxCursorInfo. More...
 

Public Attributes

float horizontalOffset
 Horizontal offset of the cursor along the line it sits on. More...
 
int index
 Text index that the cursor refers to. More...
 
int lineIndex
 Index of the line that the cursor sits on. More...
 
int unstyledIndex
 Unstyled text index corresponding to the regular text index that the cursor refers to. More...
 

Detailed Description

Information about how to place a cursor in a text box.

Member Function Documentation

override string CatlikeCoding.TextBox.TextBoxCursorInfo.ToString ( )

Return a string representation of a CatlikeCoding.TextBox.TextBoxCursorInfo.

Useful for debugging.

Returns
A string containing all labeled cursor info data.

Member Data Documentation

float CatlikeCoding.TextBox.TextBoxCursorInfo.horizontalOffset

Horizontal offset of the cursor along the line it sits on.

int CatlikeCoding.TextBox.TextBoxCursorInfo.index

Text index that the cursor refers to.

The assumption is that the cursor is positioned in front of this character. Insertion and deletion happens at this index. A backspace operation would delete the previous character, not the one at this index.

It is possible that the index is equal to the text length, which means that the cursor is placed after the last character.

int CatlikeCoding.TextBox.TextBoxCursorInfo.lineIndex

Index of the line that the cursor sits on.

int CatlikeCoding.TextBox.TextBoxCursorInfo.unstyledIndex

Unstyled text index corresponding to the regular text index that the cursor refers to.