1. Epic GamesDeveloper
  3. FSlateUser

FSlateUser

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

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Framework > API/Runtime/Slate/Framework/Application

Inheritance Hierarchy

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

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void  
Public function void

ClearFocus ( EFocusCause ReasonFocusIsChanging
)

  
Public function void  
Protected function Static TSharedRef< FSlateUser >

Create ( FPlatformUserId InPlatformUserId,
TSharedPtr< ICursor > InCursor
)

  
Protected function Static TSharedRef< FSlateUser >

Create ( int32 InUserIndex,
TSharedPtr< ICursor > InCursor
)

  
Protected function FWidgetPath

DetectDrag ( const FPointerEvent& PointerEvent,
float DragTriggerDistance
)

  
Public function Const bool  
Public function Const bool

DoesWidgetHaveCapture ( TSharedPtr< const SWidget > Widget,
uint32 PointerIndex
)

  
Public function Const bool  
Protected function void

DrawCursor ( const TSharedRef< SWindow >& WindowToDraw,
FSlateWindowElementList& WindowElementList,
int32& MaxLayerId
)

  
Protected function void

DrawWindowlessDragDropContent ( const TSharedRef< SWindow >& WindowToDraw,
FSlateWindowElementList& WindowElementList,
int32& MaxLayerId
)

  
Protected function void  
Public function FWidgetPath

GetCaptorPath ( uint32 PointerIndex,
FWeakWidgetPath::EInterruptedPathHandling::Type InterruptedPathHandling,
const FPointerEvent* PointerEvent
)

  
Public function TArray< FWidgetPath >  
Public function Const TArray< TSharedRef< SWidget > >  
Protected function Const TSharedPtr< ICursor >  
Public function Const TSharedPtr< SWidget >  
Public function FWidgetPath

GetCursorCaptorPath ( FWeakWidgetPath::EInterruptedPathHandling::Type InterruptedPathHandling,
const FPointerEvent* PointerEvent
)

  
Public function Const UE::Slate::FDeprecateVector2DResult  
Public function Const TSharedPtr< FDragDropOperation >  
Public function Const TSharedPtr< SWidget >  
Protected function Const TSharedRef< FWidgetPath >  
Protected function Const int32  
Protected function FGestureDetector &  
Public function Const const FGestureDetector &  
Public function Const FWeakWidgetPath  
Public function Const FWeakWidgetPath

GetLastWidgetsUnderPointer ( uint32 PointerIndex
)

  
Public function Const FPlatformUserId  
Public function Const TSharedPtr< SWidget >

GetPointerCaptor ( uint32 PointerIndex
)

  
Public function Const UE::Slate::FDeprecateVector2DResult

GetPointerPosition ( uint32 PointerIndex
)

  
Public function Const UE::Slate::FDeprecateVector2DResult  
Public function Const UE::Slate::FDeprecateVector2DResult

GetPreviousPointerPosition ( uint32 PointerIndex
)

  
Public function Const int32  
Public function Const TSharedPtr< FNavigationConfig >  
Public function Const FWeakWidgetPath

GetWeakCapturePath ( uint32 PointerIndex
)

  
Public function Const FWeakWidgetPath  
Protected function Const const FWeakWidgetPath &  
Public function Const const TMap< uint32, FWeakWidgetPath > &  
Public function Const bool  
Public function Const bool

HasCapture ( uint32 PointerIndex
)

  
Public function Const bool  
Public function Const TOptional< EFocusCause >

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 Returns true if the given widget is in the focus path, but is not the focused widget itself.
Protected function Const bool  
Protected function void  
Protected function Const bool

IsDetectingDrag ( uint32 PointerIndex
)

  
Public function Const bool  
Public function Const bool

IsDragDroppingAffected ( const FPointerEvent& InPointerEvent
)

  
Protected function Const bool

IsTouchPointerActive ( int32 TouchPointerIndex
)

  
Public function Const bool  
Public function Const bool  
Public function Const bool  
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  
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 >& WindowToTest
)

  
Protected function void

LockCursor ( const TSharedRef< SWidget >& Widget
)

  
Protected function void

NotifyPointerMoveBegin ( const FPointerEvent& PointerEvent
)

  
Protected function void

NotifyPointerMoveComplete ( const FPointerEvent& PointerEvent,
const FWidgetPath& WidgetsUnderPointer
)

  
Protected function void

NotifyPointerReleased ( const FPointerEvent& PointerEvent,
const FWidgetPath& WidgetsUnderCursor,
TSharedPtr< FDragDropOperation > DroppedContent,
bool bWasHandled
)

  
Protected function void

NotifyTouchStarted ( const FPointerEvent& TouchEvent
)

  
Protected function void

NotifyWindowDestroyed ( TSharedRef< SWindow > DestroyedWindow
)

  
Protected function void

OverrideCursor ( const TSharedPtr< ICursor > InCursor
)

  
Protected function void

ProcessCursorReply ( const FCursorReply& CursorReply
)

  
Protected function void  
Protected function void  
Public function void  
Public function void

ReleaseCapture ( uint32 PointerIndex
)

  
Public function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Public function bool

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

  
Public function void

SetCursorPosition ( int32 PosX,
int32 PosY
)

  
Public function void  
Public function void

SetCursorVisibility ( bool bDrawCursor
)

  
Protected function void  
Public function bool

SetFocus ( const TSharedRef< SWidget >& WidgetToFocus,
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,
int32 PosX,
int32 PosY
)

  
Public function void

SetPointerPosition ( uint32 PointerIndex,
const UE::Slate::FDeprecateVector2DParameter& NewPointerPos
)

  
Public function void  
Public function Const bool

ShouldShowFocus ( TSharedPtr< const SWidget > Widget
)

  
Public function void

ShowTooltip ( const TSharedRef< IToolTip >& InTooltip,
const UE::Slate::FDeprecateVector2DParameter& InSpawnLocation
)

  
Protected function void

StartDragDetection ( const FWidgetPath& PathToWidget,
int32 PointerIndex,
FKey DragButton,
UE::Slate::FDeprecateVector2DParameter StartLocation
)

  
Protected function bool  
Protected function void  
Protected function void  
Protected function void

UpdatePointerPosition ( const FPointerEvent& PointerEvent
)

  
Protected function void

UpdateTooltip ( const FMenuStack& MenuStack,
bool bCanSpawnNewTooltip
)

  

Enums

  Type Name Description
Private enum ETooltipOffsetDirection    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page