UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FMoveCursor Class Reference

#include <ISlateEditableTextWidget.h>

Public Member Functions

ECursorMoveMethod GetMoveMethod () const
 
bool IsVerticalMovement () const
 
bool IsHorizontalMovement () const
 
ECursorAction GetAction () const
 
FIntPoint GetMoveDirection () const
 
FVector2D GetLocalPosition () const
 
ECursorMoveGranularity GetGranularity () const
 
float GetGeometryScale () const
 

Static Public Member Functions

static FMoveCursor Cardinal (ECursorMoveGranularity Granularity, FIntPoint Direction, ECursorAction Action)
 
static FMoveCursor ViaScreenPointer (FVector2D LocalPosition, float GeometryScale, ECursorAction Action)
 

Detailed Description

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.

Member Function Documentation

◆ Cardinal()

FMoveCursor FMoveCursor::Cardinal ( ECursorMoveGranularity  Granularity,
FIntPoint  Direction,
ECursorAction  Action 
)
static

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

Parameters
GranularityMove one character at a time, or on word boundaries (e.g. Ctrl is held down, or double-click mouse+drag)
DirectionAxis-aligned unit vector along which to move. e.g. Move right: (0,1) or Move Up: (-1, 0)
ActionJust move or also select text?

◆ GetAction()

ECursorAction FMoveCursor::GetAction ( ) const
See also
ECursorAction

◆ GetGeometryScale()

float FMoveCursor::GetGeometryScale ( ) const

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

◆ GetGranularity()

ECursorMoveGranularity FMoveCursor::GetGranularity ( ) const

Move one character at a time, or one word?

◆ GetLocalPosition()

FVector2D FMoveCursor::GetLocalPosition ( ) const

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

◆ GetMoveDirection()

FIntPoint FMoveCursor::GetMoveDirection ( ) const

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

◆ GetMoveMethod()

ECursorMoveMethod FMoveCursor::GetMoveMethod ( ) const

◆ IsHorizontalMovement()

bool FMoveCursor::IsHorizontalMovement ( ) const

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

◆ IsVerticalMovement()

bool FMoveCursor::IsVerticalMovement ( ) const

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

◆ ViaScreenPointer()

FMoveCursor FMoveCursor::ViaScreenPointer ( FVector2D  LocalPosition,
float  GeometryScale,
ECursorAction  Action 
)
static

Creates a MoveCursor action that describes moving the text cursor by selecting an arbitrary coordinate on the screen. e.g. User user touches a touch device screen or uses the mouse to point at text.

Parameters
LocalPositionPosition in the text widget where the user wants to move the cursor by pointing
GeometryScaleDPI Scale of the widget geometry.
ActionJust move or also select text?

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