FMoveCursor | Unreal Engine 5.7 Documentation

API > API/Runtime > API/Runtime/Slate

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.


Name	FMoveCursor
Type	class
Header File	/Engine/Source/Runtime/Slate/Public/Widgets/Text/ISlateEditableTextWidget.h
Include Path	#include "Widgets/Text/ISlateEditableTextWidget.h"

Syntax

class FMoveCursor

Constructors

Name	Remarks	Include Path	Unreal Specifiers
FMoveCursor ( ECursorMoveGranularity InGranularity, ECursorMoveMethod InMethod, FVector2D InDirectionOrPosition, float InGeometryScale, ECursorAction InAction )		Widgets/Text/ISlateEditableTextWidget.h

Variables

Protected

Name	Type	Include Path
Action	ECursorAction	Widgets/Text/ISlateEditableTextWidget.h
DirectionOrPosition	FVector2f	Widgets/Text/ISlateEditableTextWidget.h
GeometryScale	float	Widgets/Text/ISlateEditableTextWidget.h
Granularity	ECursorMoveGranularity	Widgets/Text/ISlateEditableTextWidget.h
Method	ECursorMoveMethod	Widgets/Text/ISlateEditableTextWidget.h

Functions

Public

Name	Remarks	Include Path
ECursorAction GetAction ()		Widgets/Text/ISlateEditableTextWidget.h
float GetGeometryScale()	Geometry Scale at the time of the event that caused this action	Widgets/Text/ISlateEditableTextWidget.h
ECursorMoveGranularity GetGranularity()	Move one character at a time, or one word?	Widgets/Text/ISlateEditableTextWidget.h
FVector2D GetLocalPosition()	Which position in the widget where the user touched when using ScreenPosition mode.	Widgets/Text/ISlateEditableTextWidget.h
FIntPoint GetMoveDirection()	When using directional movement (i.e. Character or Word granularity; not screen position, which way to move.)	Widgets/Text/ISlateEditableTextWidget.h
ECursorMoveMethod GetMoveMethod ()		Widgets/Text/ISlateEditableTextWidget.h
bool IsHorizontalMovement()	Is the cursor moving left/right; Only valid for word and character movement methods.	Widgets/Text/ISlateEditableTextWidget.h
bool IsVerticalMovement()	Is the cursor moving up/down; Only valid for word and character movement methods.	Widgets/Text/ISlateEditableTextWidget.h

Static

Name	Remarks	Include Path	Unreal Specifiers
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.	Widgets/Text/ISlateEditableTextWidget.h
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.	Widgets/Text/ISlateEditableTextWidget.h

Navigation