FMoveCursor

Argument to the [ITextEditorWidget::Move()](API\Runtime\Engine\Kismet\EMoveComponentAction__Type); it decouples performing cursor movement and text highlighting actions from event handling.

Windows
MacOS
Linux

References

Module

Slate

Header

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

Include

#include "Widgets/Text/ISlateEditableTextWidget.h"

Syntax

class FMoveCursor

Remarks

Argument to the ITextEditorWidget::Move(); it decouples performing cursor movement and text highlighting actions from event handling. FMoveCursor describes how the cursor can be moved via keyboard, mouse, and other mechanisms in the future.

Constructors

No constructors are accessible with public or protected access.

Functions

Name Description

Public function Static

FMoveCursor

 

Cardinal

(
    ECursorMoveGranularity Granularity,
    FIntPoint Direction,
    ECursorAction Action
)

Creates a MoveCursor action that describes moving by a single character in any of the cardinal directions.

Public function Const

ECursorActio...

 

GetAction()

Public function Const

float

 

GetGeometryScale()

Geometry Scale at the time of the event that caused this action

Public function Const

ECursorMoveG...

 

GetGranularity()

Move one character at a time, or one word?

Public function Const

FVector2D

 

GetLocalPosition()

Which position in the widget where the user touched when using ScreenPosition mode.

Public function Const

FIntPoint

 

GetMoveDirection()

When using directional movement (i.e. Character or Word granularity; not screen position, which way to move.)

Public function Const

ECursorMoveM...

 

GetMoveMethod()

Public function Const

bool

 

IsHorizontalMovement()

Is the cursor moving left/right; Only valid for word and character movement methods.

Public function Const

bool

 

IsVerticalMovement()

Is the cursor moving up/down; Only valid for word and character movement methods.

Public function Static

FMoveCursor

 

ViaScreenPointer

(
    FVector2D LocalPosition,
    float GeometryScale,
    ECursorAction Action
)

Creates a MoveCursor action that describes moving the text cursor by selecting an arbitrary coordinate on the screen.

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