SlateEditableTextTypes::FCursorInfo Class Reference

#include <SlateEditableTextTypes.h>

Public Member Functions
	FCursorInfo ()
FTextLocation	GetCursorLocation () const
ECursorAlignment	GetCursorAlignment () const
TextBiDi::ETextDirection	GetCursorTextDirection () const
FTextLocation	GetCursorInteractionLocation () const
double	GetLastCursorInteractionTime () const
SLATE_API void	UpdateLastCursorInteractionTime ()
SLATE_API void	SetCursorLocationAndCalculateAlignment (const FTextLayout &InTextLayout, const FTextLocation &InCursorPosition)
SLATE_API void	SetCursorLocationAndAlignment (const FTextLayout &InTextLayout, const FTextLocation &InCursorPosition, const ECursorAlignment InCursorAlignment)
SLATE_API FCursorInfo	CreateUndo () const
SLATE_API void	RestoreFromUndo (const FCursorInfo &UndoData)

Detailed Description

Store the information about the current cursor position

Constructor & Destructor Documentation

FCursorInfo()

SlateEditableTextTypes::FCursorInfo::FCursorInfo ( )

inline

Member Function Documentation

CreateUndo()

FCursorInfo SlateEditableTextTypes::FCursorInfo::CreateUndo

(

)

const

Create an undo for this cursor data

GetCursorAlignment()

ECursorAlignment SlateEditableTextTypes::FCursorInfo::GetCursorAlignment ( ) const

inline

Get the alignment of the cursor

GetCursorInteractionLocation()

FTextLocation SlateEditableTextTypes::FCursorInfo::GetCursorInteractionLocation ( ) const

inline

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

GetCursorLocation()

FTextLocation SlateEditableTextTypes::FCursorInfo::GetCursorLocation ( ) const

inline

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

GetCursorTextDirection()

TextBiDi::ETextDirection SlateEditableTextTypes::FCursorInfo::GetCursorTextDirection ( ) const

inline

Get the direction of the text under the cursor

GetLastCursorInteractionTime()

double SlateEditableTextTypes::FCursorInfo::GetLastCursorInteractionTime ( ) const

inline

RestoreFromUndo()

void SlateEditableTextTypes::FCursorInfo::RestoreFromUndo

(

const FCursorInfo &

UndoData

)

Restore this cursor data from an undo

SetCursorLocationAndAlignment()

void SlateEditableTextTypes::FCursorInfo::SetCursorLocationAndAlignment	(	const FTextLayout &	InTextLayout,
		const FTextLocation &	InCursorPosition,
		const ECursorAlignment	InCursorAlignment
	)

Set the literal position and alignment of the cursor

SetCursorLocationAndCalculateAlignment()

void SlateEditableTextTypes::FCursorInfo::SetCursorLocationAndCalculateAlignment	(	const FTextLayout &	InTextLayout,
		const FTextLocation &	InCursorPosition
	)

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

UpdateLastCursorInteractionTime()

void SlateEditableTextTypes::FCursorInfo::UpdateLastCursorInteractionTime

(

)

Update the last cursor interaction time to now

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Slate/Public/Widgets/Text/SlateEditableTextTypes.h
• Engine/Source/Runtime/Slate/Private/Widgets/Text/SlateEditableTextTypes.cpp