FSlateUser

Slate's representation of an individual input-providing user.

Windows
MacOS
Linux

Inheritance Hierarchy

TSharedFromThis

FSlateUser

References

Module

Slate

Header

/Engine/Source/Runtime/Slate/Public/Framework/Application/SlateUser.h

Include

#include "Framework/Application/SlateUser.h"

Syntax

class FSlateUser : public TSharedFromThis< FSlateUser >

Remarks

Slate's representation of an individual input-providing user. As new input sources are connected, new SlateUsers are created.

Constructors

No constructors are accessible with public or protected access.

Destructors

Name Description

Public function Virtual

~FSlateUser()

Functions

Name Description

Public function

void

 

CancelDragDrop()

Public function

void

 

ClearFocus

(
    EFocusCause ReasonFocusIsChanging
)

Public function

void

 

CloseTooltip()

Protected function Static

TSharedRef< ...

 

Create

(
    int32 InUserIndex,
    TSharedPtr< ICursor > InCursor
)

Protected function

FWidgetPath

 

DetectDrag

(
    const FPointerEvent& PointerEvent,
    float DragTriggerDistance
)

Public function Const

bool

 

DoesWidgetHaveAnyCapture

(
    TSharedPtr< const SWidget > Widget
)

Public function Const

bool

 

DoesWidgetHaveCapture

(
    TSharedPtr< const SWidget > Widget,
    uint32 PointerIndex
)

Public function Const

bool

 

DoesWidgetHaveCursorCapture

(
    TSharedPtr< const SWidget > Widget
)

Protected function

void

 

DrawCursor

(
    const TSharedRef< SWindow >& Windo...,
    FSlateWindowElementList& WindowEle...,
    int32& MaxLayerId
)

Protected function

void

 

DrawWindowlessDragDropContent

(
    const TSharedRef< SWindow >& Windo...,
    FSlateWindowElementList& WindowEle...,
    int32& MaxLayerId
)

Protected function

void

 

FinishFrame()

Public function

FWidgetPath

 

GetCaptorPath

(
    uint32 PointerIndex,
    FWeakWidgetPath::EInterruptedPathHa...,
    const FPointerEvent* PointerEv...
)

Public function

TArray< FWid...

 

GetCaptorPaths()

Public function Const

TArray< TSha...

 

GetCaptorWidgets()

Protected function Const

TSharedPtr< ...

 

GetCursor()

Public function Const

TSharedPtr< ...

 

GetCursorCaptor()

Public function

FWidgetPath

 

GetCursorCaptorPath

(
    FWeakWidgetPath::EInterruptedPathHa...,
    const FPointerEvent* PointerEv...
)

Public function Const

FVector2D

 

GetCursorPosition()

Public function Const

TSharedPtr< ...

 

GetDragDropContent()

Public function Const

TSharedPtr< ...

 

GetFocusedWidget()

Protected function Const

TSharedRef< ...

 

GetFocusPath()

Protected function Const

int32

 

GetFocusVersion()

Public function Const

const FGestu...

 

GetGestureDetector()

Protected function

FGestureDete...

 

GetGestureDetector()

Public function Const

FWeakWidgetP...

 

GetLastWidgetsUnderCursor()

Public function Const

FWeakWidgetP...

 

GetLastWidgetsUnderPointer

(
    uint32 PointerIndex
)

Public function Const

TSharedPtr< ...

 

GetPointerCaptor

(
    uint32 PointerIndex
)

Public function Const

FVector2D

 

GetPointerPosition

(
    uint32 PointerIndex
)

Public function Const

FVector2D

 

GetPreviousCursorPosition()

Public function Const

FVector2D

 

GetPreviousPointerPosition

(
    uint32 PointerIndex
)

Protected function Const

TSharedPtr< ...

 

GetTooltip()

Public function Const

int32

 

GetUserIndex()

Public function Const

TSharedPtr< ...

 

GetUserNavigationConfig()

Public function Const

FWeakWidgetP...

 

GetWeakCapturePath

(
    uint32 PointerIndex
)

Public function Const

FWeakWidgetP...

 

GetWeakCursorCapturePath()

Protected function Const

const FWeakW...

 

GetWeakFocusPath()

Public function Const

const TMap< ...

 

GetWidgetsUnderPointerLastEventByIndex()

Public function Const

bool

 

HasAnyCapture()

Public function Const

bool

 

HasCapture

(
    uint32 PointerIndex
)

Public function Const

bool

 

HasCursorCapture()

Public function Const

TOptional< E...

 

HasFocus

(
    TSharedPtr< const SWidget > Widget
)

Returns the cause for which the provided widget was focused, or nothing if the given widget is not the current focus target.

Public function Const

bool

 

HasFocusedDescendants

(
    TSharedRef< const SWidget > Widget
)

Returns true if the given widget is in the focus path, but is not the focused widget itself.

Protected function Const

bool

 

HasValidFocusPath()

Protected function

void

 

IncrementFocusVersion()

Protected function Const

bool

 

IsDetectingDrag

(
    uint32 PointerIndex
)

Public function Const

bool

 

IsDragDropping()

Public function Const

bool

 

IsDragDroppingAffected

(
    const FPointerEvent& InPointerEven...
)

Protected function Const

bool

 

IsTouchPointerActive

(
    int32 TouchPointerIndex
)

Public function Const

bool

 

IsVirtualUser()

Public function Const

bool

 

IsWidgetDirectlyUnderAnyPointer

(
    TSharedPtr< const SWidget > Widget
)

Public function Const

bool

 

IsWidgetDirectlyUnderCursor

(
    TSharedPtr< const SWidget > Widget
)

Public function Const

bool

 

IsWidgetDirectlyUnderPointer

(
    TSharedPtr< const SWidget > Widget,
    uint32 PointerIndex
)

Public function Const

bool

 

IsWidgetInFocusPath

(
    TSharedPtr< const SWidget > Widget
)

Returns true if the given widget is anywhere in the focus path, including the focused widget itself.

Public function Const

bool

 

IsWidgetUnderAnyPointer

(
    TSharedPtr< const SWidget > Widget
)

Public function Const

bool

 

IsWidgetUnderCursor

(
    TSharedPtr< const SWidget > Widget
)

Public function Const

bool

 

IsWidgetUnderPointer

(
    TSharedPtr< const SWidget > Widget,
    uint32 PointerIndex
)

Protected function Const

bool

 

IsWindowHousingInteractiveTooltip

(
    const TSharedRef< const SWindow >&...
)

Protected function

void

 

LockCursor

(
    const TSharedRef< SWidget >& Widge...
)

Protected function

void

 

NotifyPointerMoveBegin

(
    const FPointerEvent& PointerEvent
)

Protected function

void

 

NotifyPointerMoveComplete

(
    const FPointerEvent& PointerEvent,
    const FWidgetPath& WidgetsUnderPoi...
)

Protected function

void

 

NotifyPointerReleased

(
    const FPointerEvent& PointerEvent,
    const FWidgetPath& WidgetsUnderCur...,
    TSharedPtr< FDragDropOperation > Dr...,
    bool bWasHandled
)

Protected function

void

 

NotifyTouchStarted

(
    const FPointerEvent& TouchEvent
)

Protected function

void

 

NotifyWindowDestroyed

(
    TSharedRef< SWindow > DestroyedWind...
)

Protected function

void

 

OverrideCursor

(
    const TSharedPtr< ICursor > InCurso...
)

Protected function

void

 

ProcessCursorReply

(
    const FCursorReply& CursorReply
)

Protected function

void

 

QueryCursor()

Protected function

void

 

QueueSyntheticCursorMove()

Public function

void

 

ReleaseAllCapture()

Public function

void

 

ReleaseCapture

(
    uint32 PointerIndex
)

Public function

void

 

ReleaseCursorCapture()

Protected function

void

 

RequestCursorQuery()

Protected function

void

 

ResetDragDetection()

Protected function

void

 

ResetDragDropContent()

Protected function

void

 

ResetTooltipWindow()

Public function

bool

 

SetCursorCaptor

(
    TSharedRef< const SWidget > Widget,
    const FWidgetPath& EventPath
)

Public function

void

 

SetCursorPosition

(
    int32 PosX,
    int32 PosY
)

Public function

void

 

SetCursorPosition

(
    const FVector2D& NewCursorPos
)

Public function

void

 

SetCursorVisibility

(
    bool bDrawCursor
)

Protected function

void

 

SetDragDropContent

(
    TSharedRef< FDragDropOperation > In...
)

Public function

bool

 

SetFocus

(
    const TSharedRef< SWidget >& Widge...,
    EFocusCause ReasonFocusIsChanging
)

Protected function

void

 

SetFocusPath

(
    const FWidgetPath& NewFocusPath,
    EFocusCause InFocusCause,
    bool bInShowFocus
)

Public function

bool

 

SetPointerCaptor

(
    uint32 PointerIndex,
    TSharedRef< const SWidget > Widget,
    const FWidgetPath& EventPath
)

Public function

void

 

SetPointerPosition

(
    uint32 PointerIndex,
    const FVector2D& NewPointerPos
)

Public function

void

 

SetPointerPosition

(
    uint32 PointerIndex,
    int32 PosX,
    int32 PosY
)

Public function

void

 

SetUserNavigationConfig

(
    TSharedPtr< FNavigationConfig > InN...
)

Public function Const

bool

 

ShouldShowFocus

(
    TSharedPtr< const SWidget > Widget
)

Public function

void

 

ShowTooltip

(
    const TSharedRef< IToolTip >& InTo...,
    const FVector2D& InSpawnLocation
)

Protected function

void

 

StartDragDetection

(
    const FWidgetPath& PathToWidget,
    int32 PointerIndex,
    FKey DragButton,
    FVector2D StartLocation
)

Protected function

bool

 

SynthesizeCursorMoveIfNeeded()

Protected function

void

 

UnlockCursor()

Protected function

void

 

UpdateCursor()

Protected function

void

 

UpdatePointerPosition

(
    const FPointerEvent& PointerEvent
)

Protected function

void

 

UpdateTooltip

(
    const FMenuStack& MenuStack,
    bool bCanSpawnNewTooltip
)

Enums

Name

Description

Private enum

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