FCursorInfo

Store the information about the current cursor position

Windows
MacOS
Linux

References

Module

Slate

Header

/Engine/Source/Runtime/Slate/Public/Widgets/Text/SlateEditableTextTypes.h

Include

#include "Widgets/Text/SlateEditableTextTypes.h"

Syntax

class FCursorInfo

Remarks

Store the information about the current cursor position

Constructors

Name Description

Public function

FCursorInfo()

Functions

Name Description

Public function Const

FCursorInfo

 

CreateUndo()

Create an undo for this cursor data

Public function Const

ECursorAlign...

 

GetCursorAlignment()

Get the alignment of the cursor

Public function Const

FTextLocatio...

 

GetCursorInteractionLocation()

Get the interaction position of the cursor (where to insert, delete, etc, text from/to)

Public function Const

FTextLocatio...

 

GetCursorLocation()

Get the literal position of the cursor (note: this may not be the correct place to insert text to, use GetCursorInteractionLocation for that)

Public function Const

TextBiDi::ET...

 

GetCursorTextDirection()

Get the direction of the text under the cursor

Public function Const

double

 

GetLastCursorInteractionTime()

Public function

void

 

RestoreFromUndo

(
    const FCursorInfo& UndoData
)

Restore this cursor data from an undo

Public function

void

 

SetCursorLocationAndAlignment

(
    const FTextLayout& InTextLayout,
    const FTextLocation& InCursorPosit...,
    const ECursorAlignment InCursorAlig...
)

Set the literal position and alignment of the cursor

Public function

void

 

SetCursorLocationAndCalculateAlignment

(
    const FTextLayout& InTextLayout,
    const FTextLocation& InCursorPosit...
)

Set the position of the cursor, and then work out the correct alignment based on the current text layout

Public function

void

 

UpdateLastCursorInteractionTime()

Update the last cursor interaction time to now

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss