Rect GetCursorRect( TextCursor cursor )

robot_2Generated
code_blocksInput

Description

The GetCursorRect method retrieves the rectangular area occupied by a specified text cursor within the TextEdit widget. This is useful for determining the position and size of the cursor in the text editor, which can be used for rendering or interaction purposes.

Usage

To use the GetCursorRect method, you need to have an instance of TextEdit and a valid TextCursor object. Pass the TextCursor to the method to get the corresponding Rect that represents the cursor's position and size.

Example

// Assuming 'textEdit' is an instance of Editor.TextEdit
// and 'cursor' is an instance of Editor.TextCursor

Sandbox.Rect cursorRect = textEdit.GetCursorRect(cursor);

// Now you can use 'cursorRect' to get the position and size of the cursor
float x = cursorRect.Left;
float y = cursorRect.Top;
float width = cursorRect.Width;
float height = cursorRect.Height;