className
stringlengths
1
167
headerPath
stringlengths
14
166
description
stringlengths
0
1.62k
module
stringlengths
0
76
code
stringlengths
0
11.4k
variables
listlengths
0
395
FNavigationReply::CustomBoundary
/Engine/Source/Runtime/SlateCore/Public/Input/NavigationReply.h
An event should return aFNavigationReply::CustomBoundary()to let the system know to call a custom delegate to get the widget to navigate to is the widgets boundary is hit.
SlateCore
static [FNavigationReply](API\Runtime\SlateCore\Input\FNavigationReply) CustomBoundary ( const FNavigationDelegate & InFocusDelegate )
[]
FNavigationReply::Explicit
/Engine/Source/Runtime/SlateCore/Public/Input/NavigationReply.h
An event should return aFNavigationReply::Explicit()to let the system know to navigate to an explicit widget at the bounds of this widget.
SlateCore
static [FNavigationReply](API\Runtime\SlateCore\Input\FNavigationReply) Explicit ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > InFocusRecipient )
[]
FNavigationReply::GetBoundaryRule
/Engine/Source/Runtime/SlateCore/Public/Input/NavigationReply.h
Get the navigation boundary rule.
SlateCore
EUINavigationRule GetBoundaryRule() const
[]
FNavigationReply::GetFocusDelegate
/Engine/Source/Runtime/SlateCore/Public/Input/NavigationReply.h
If the event replied with a delegate explicit boundary rule this returns the delegate to get the focus recipient. Delegate will be unbound if a constant widget was provided.
SlateCore
const FNavigationDelegate & GetFocusDelegate() const
[]
FNavigationReply::GetFocusRecipient
/Engine/Source/Runtime/SlateCore/Public/Input/NavigationReply.h
If the event replied with a constant explicit boundary rule this returns the desired focus recipient. Otherwise returns an invalid pointer.
SlateCore
const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > & GetFocusRecipient() const
[]
FNavigationReply::Stop
/Engine/Source/Runtime/SlateCore/Public/Input/NavigationReply.h
An event should return aFNavigationReply::Stop()to let the system know to stop at the bounds of this widget.
SlateCore
static [FNavigationReply](API\Runtime\SlateCore\Input\FNavigationReply) Stop()
[]
FNavigationReply::Wrap
/Engine/Source/Runtime/SlateCore/Public/Input/NavigationReply.h
An event should return aFNavigationReply::Wrap()to let the system know to wrap at the bounds of this widget.
SlateCore
static [FNavigationReply](API\Runtime\SlateCore\Input\FNavigationReply) Wrap()
[]
FNavigationReply::GetHandler
/Engine/Source/Runtime/SlateCore/Public/Input/NavigationReply.h
The widget that ultimately specified the boundary rule for the navigation
SlateCore
const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GetHandler() const
[]
FNavigationReply
/Engine/Source/Runtime/SlateCore/Public/Input/NavigationReply.h
No constructors are accessible with public or protected access.
SlateCore
class FNavigationReply
[]
FNoReply::Unhandled
/Engine/Source/Runtime/SlateCore/Public/Input/ReplyBase.h
SlateCore
static [FNoReply](API\Runtime\SlateCore\Input\FNoReply) Unhandled()
[]
FNoReply::FNoReply
/Engine/Source/Runtime/SlateCore/Public/Input/ReplyBase.h
SlateCore
FNoReply()
[]
FNoReply
/Engine/Source/Runtime/SlateCore/Public/Input/ReplyBase.h
A reply type for events that return a void reply. e.g. OnMouseLeave()
SlateCore
class FNoReply : public [TReplyBase< FNoReply >](API\Runtime\SlateCore\Input\TReplyBase)
[]
FPointerEvent::GetCursorDelta
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
Returns the distance the mouse traveled since the last event was handled.
SlateCore
const [UE::Slate::FDeprecateVector2DResult](API\Runtime\SlateCore\Types\FDeprecateVector2DResult) & GetCursorDelta() const
[]
FPointerEvent::GetGestureType
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
Returns the type of touch gesture
SlateCore
EGestureEvent GetGestureType() const
[]
FPointerEvent::GetEffectingButton
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
Mouse button that caused this event to be raised (possibly FKey::Invalid)
SlateCore
[FKey](API\Runtime\InputCore\FKey) GetEffectingButton() const
[]
FPointerEvent::GetLastScreenSpacePosition
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
Returns the position of the cursor in screen space last time we handled an input event
SlateCore
const [UE::Slate::FDeprecateVector2DResult](API\Runtime\SlateCore\Types\FDeprecateVector2DResult) & GetLastScreenSpacePosition() const
[]
FPointerEvent::GetPointerIndex
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
Returns the unique identifier of the pointer (e.g., finger index)
SlateCore
uint32 GetPointerIndex() const
[]
FPointerEvent::GetPressedButtons
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
Returns the full set of pressed buttons
SlateCore
const [TSet](API\Runtime\Core\Containers\TSet)< [FKey](API\Runtime\InputCore\FKey) > & GetPressedButtons() const
[]
FPointerEvent::GetScreenSpacePosition
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
Returns The position of the cursor in screen space
SlateCore
const [UE::Slate::FDeprecateVector2DResult](API\Runtime\SlateCore\Types\FDeprecateVector2DResult) & GetScreenSpacePosition() const
[]
FPointerEvent::GetTouchpadIndex
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
Returns the index of the touch pad that generated this event (for platforms with multiple touch pads per user)
SlateCore
uint32 GetTouchpadIndex() const
[]
FPointerEvent::GetTouchForce
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
Returns the force of a touch (1.0f is mapped to an general touch force, < 1 is "light", > 1 is "heavy", and 10 is the max force possible)
SlateCore
float GetTouchForce() const
[]
FPointerEvent::GetUserIndex
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
Returns the index of the user that caused the event
SlateCore
int32 GetUserIndex() const
[]
FPointerEvent::GetGestureDelta
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
Returns the change in gesture value since the last gesture event of the same type.
SlateCore
const [UE::Slate::FDeprecateVector2DResult](API\Runtime\SlateCore\Types\FDeprecateVector2DResult) & GetGestureDelta() const
[]
FPointerEvent::GetWheelDelta
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
How much did the mouse wheel turn since the last mouse event
SlateCore
float GetWheelDelta() const
[]
FPointerEvent::IsDirectionInvertedFromDevice
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
Is the gesture delta inverted
SlateCore
bool IsDirectionInvertedFromDevice() const
[]
FPointerEvent::IsMouseButtonDown
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
Mouse buttons that are currently pressed
SlateCore
bool IsMouseButtonDown ( [FKey](API\Runtime\InputCore\FKey) MouseButton ) const
[]
FPointerEvent::IsPointerEvent
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
Is this event a pointer event (touch or cursor).
SlateCore
virtual bool IsPointerEvent() const
[]
FPointerEvent::IsTouchEvent
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
Is this event a result from a touch (as opposed to a mouse)
SlateCore
bool IsTouchEvent() const
[]
FPointerEvent::IsTouchFirstMoveEvent
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
Is this event a special first-move touch event
SlateCore
bool IsTouchFirstMoveEvent() const
[]
FPointerEvent::IsTouchForceChangedEvent
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
Is this event a special force-change touch event
SlateCore
bool IsTouchForceChangedEvent() const
[]
FPointerEvent::MakeTranslatedEvent
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
SlateCore
template<typename PointerEventType> static PointerEventType MakeTranslatedEvent ( const PointerEventType & InPointerEvent, const [FVirtualPointerPosition](API\Runtime\SlateCore\Input\FVirtualPointerPosition) & VirtualPosition )
[]
FPointerEvent::ToText
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
SlateCore
virtual [FText](API\Runtime\Core\Internationalization\FText) ToText() const
[]
FPointerEvent::FPointerEvent
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
SlateCore
FPointerEvent ( [FInputDeviceId](API\Runtime\Core\Misc\FInputDeviceId) InDeviceId, uint32 InPointerIndex, const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & InScreenSpacePosition, const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & InLastScreenSpacePosition, float InForce, bool bPressLeftMouseButton, bool bInIsForceChanged, bool bInIsFirstMove, const [FModifierKeysState](API\Runtime\ApplicationCore\GenericPlatform\FModifierKeysState) & InModifierKeys, uint32 InTouchpadIndex, const [TOptional](API\Runtime\Core\IO\TOptional)< int32 > InOptionalSlateUserIndex )
[]
FPointerEvent::FPointerEvent
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
UStructConstructor. Not meant for normal usage.
SlateCore
FPointerEvent()
[]
FPointerEvent::FPointerEvent
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
A constructor to alter cursor positions
SlateCore
FPointerEvent ( const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & Other, const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & InScreenSpacePosition, const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & InLastScreenSpacePosition )
[]
FPointerEvent::FPointerEvent
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
A constructor for raw mouse events
SlateCore
FPointerEvent ( uint32 InPointerIndex, const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & InScreenSpacePosition, const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & InLastScreenSpacePosition, const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & InDelta, const [TSet](API\Runtime\Core\Containers\TSet)< [FKey](API\Runtime\InputCore\FKey) > & InPressedButtons, const [FModifierKeysState](API\Runtime\ApplicationCore\GenericPlatform\FModifierKeysState) & InModifierKeys )
[]
FPointerEvent::FPointerEvent
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
Events are immutable once constructed.
SlateCore
FPointerEvent ( uint32 InPointerIndex, const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & InScreenSpacePosition, const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & InLastScreenSpacePosition, const [TSet](API\Runtime\Core\Containers\TSet)< [FKey](API\Runtime\InputCore\FKey) > & InPressedButtons, [FKey](API\Runtime\InputCore\FKey) InEffectingButton, float InWheelDelta, const [FModifierKeysState](API\Runtime\ApplicationCore\GenericPlatform\FModifierKeysState) & InModifierKeys )
[]
FPointerEvent::FPointerEvent
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
SlateCore
FPointerEvent ( uint32 InUserIndex, uint32 InPointerIndex, const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & InScreenSpacePosition, const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & InLastScreenSpacePosition, const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & InDelta, const [TSet](API\Runtime\Core\Containers\TSet)< [FKey](API\Runtime\InputCore\FKey) > & InPressedButtons, const [FModifierKeysState](API\Runtime\ApplicationCore\GenericPlatform\FModifierKeysState) & InModifierKeys )
[]
FPointerEvent::FPointerEvent
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
A constructor for gesture events
SlateCore
FPointerEvent ( const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & InScreenSpacePosition, const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & InLastScreenSpacePosition, const [TSet](API\Runtime\Core\Containers\TSet)< [FKey](API\Runtime\InputCore\FKey) > & InPressedButtons, const [FModifierKeysState](API\Runtime\ApplicationCore\GenericPlatform\FModifierKeysState) & InModifierKeys, EGestureEvent InGestureType, const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & InGestureDelta, bool bInIsDirectionInvertedFromDevice )
[]
FPointerEvent::FPointerEvent
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
SlateCore
FPointerEvent ( uint32 InUserIndex, uint32 InPointerIndex, const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & InScreenSpacePosition, const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & InLastScreenSpacePosition, const [TSet](API\Runtime\Core\Containers\TSet)< [FKey](API\Runtime\InputCore\FKey) > & InPressedButtons, [FKey](API\Runtime\InputCore\FKey) InEffectingButton, float InWheelDelta, const [FModifierKeysState](API\Runtime\ApplicationCore\GenericPlatform\FModifierKeysState) & InModifierKeys )
[]
FPointerEvent::FPointerEvent
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
SlateCore
FPointerEvent ( uint32 InUserIndex, uint32 InPointerIndex, const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & InScreenSpacePosition, const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & InLastScreenSpacePosition, float InForce, bool bPressLeftMouseButton, bool bInIsForceChanged, bool bInIsFirstMove, const [FModifierKeysState](API\Runtime\ApplicationCore\GenericPlatform\FModifierKeysState) & InModifierKeys, uint32 InTouchpadIndex )
[]
FPointerEvent::FPointerEvent
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
SlateCore
FPointerEvent ( [FInputDeviceId](API\Runtime\Core\Misc\FInputDeviceId) InDeviceId, uint32 InPointerIndex, const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & InScreenSpacePosition, const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & InLastScreenSpacePosition, const [TSet](API\Runtime\Core\Containers\TSet)< [FKey](API\Runtime\InputCore\FKey) > & InPressedButtons, [FKey](API\Runtime\InputCore\FKey) InEffectingButton, float InWheelDelta, const [FModifierKeysState](API\Runtime\ApplicationCore\GenericPlatform\FModifierKeysState) & InModifierKeys, const [TOptional](API\Runtime\Core\IO\TOptional)< int32 > InOptionalSlateUserIndex )
[]
FPopupMethodReply::GetPopupMethod
/Engine/Source/Runtime/SlateCore/Public/Input/PopupMethodReply.h
Which method to use for the popup: new window or reuse current window
SlateCore
EPopupMethod GetPopupMethod() const
[]
FPointerEvent
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
FPointerEventdescribes a mouse or touch action (e.g. Press, Release, Move, etc). It is passed to event handlers dealing with pointer-based input.
SlateCore
struct FPointerEvent : public [FInputEvent](API\Runtime\SlateCore\Input\FInputEvent)
[]
FPopupMethodReply::GetShouldThrottle
/Engine/Source/Runtime/SlateCore/Public/Input/PopupMethodReply.h
Should we throttle the engine?
SlateCore
EShouldThrottle GetShouldThrottle() const
[]
FPopupMethodReply::SetShouldThrottle
/Engine/Source/Runtime/SlateCore/Public/Input/PopupMethodReply.h
Specify whether we should throttle the engine ticking s.t. the UI is most responsive when this popup is up.
SlateCore
[FPopupMethodReply](API\Runtime\SlateCore\Input\FPopupMethodReply) & SetShouldThrottle ( EShouldThrottle InShouldThrottle )
[]
FPopupMethodReply::IsSet
/Engine/Source/Runtime/SlateCore/Public/Input/PopupMethodReply.h
Alias for IsEventHandled for situations where this is used as optional
SlateCore
bool IsSet() const
[]
FPopupMethodReply::UseMethod
/Engine/Source/Runtime/SlateCore/Public/Input/PopupMethodReply.h
Create a reply that specifies how a popup should be handled.
SlateCore
static [FPopupMethodReply](API\Runtime\SlateCore\Input\FPopupMethodReply) UseMethod ( EPopupMethod WithMethod )
[]
FPopupMethodReply::Unhandled
/Engine/Source/Runtime/SlateCore/Public/Input/PopupMethodReply.h
Create a reply that signals not having an opinion about the popup method
SlateCore
static [FPopupMethodReply](API\Runtime\SlateCore\Input\FPopupMethodReply) Unhandled()
[]
FPopupMethodReply::FPopupMethodReply
/Engine/Source/Runtime/SlateCore/Public/Input/PopupMethodReply.h
SlateCore
FPopupMethodReply &40; bool bIsHandled, EPopupMethod InMethod &41;
[]
FPopupMethodReply::FPopupMethodReply
/Engine/Source/Runtime/SlateCore/Public/Input/PopupMethodReply.h
SlateCore
FPopupMethodReply()
[]
FPopupMethodReply
/Engine/Source/Runtime/SlateCore/Public/Input/PopupMethodReply.h
Reply informs Slate how it should express the popup: by creating a new window or by reusing the existing window.
SlateCore
class FPopupMethodReply : public [TReplyBase< FPopupMethodReply >](API\Runtime\SlateCore\Input\TReplyBase)
[]
FReply::AffectsAllUsers
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
If the event replied with a request to change the user focus whether it should do it for all users or just the current UserIndex
SlateCore
bool AffectsAllUsers() const
[]
FReply::BeginDragDrop
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
An event should returnFReply::Handled().BeginDragDrop( Content ) to initiate a drag and drop operation. reference back to theFReplyso that this call can be chained.
SlateCore
[FReply](API\Runtime\SlateCore\Input\FReply) & BeginDragDrop ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FDragDropOperation](API\Runtime\SlateCore\Input\FDragDropOperation) > InDragDropContent )
[]
FReply::CancelFocusRequest
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
An event should rarely invokeFReply::CancelFocusRequest. This will change the reply so that it no longer contains a request for the system to set or clear focus. This is most useful when a reply has been cached for use in async operations.
SlateCore
[FReply](API\Runtime\SlateCore\Input\FReply) & CancelFocusRequest()
[]
FReply::CaptureMouse
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
An event should return aFReply::Handled().CaptureMouse( SomeWidget ) as a means of asking the system to forward all mouse events to SomeWidget
SlateCore
[FReply](API\Runtime\SlateCore\Input\FReply) & CaptureMouse ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > InMouseCaptor )
[]
FReply::ClearUserFocus
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
An event should return aFReply::Handled().ClearUserFocus()to ask the system to clear user focus
SlateCore
[FReply](API\Runtime\SlateCore\Input\FReply) & ClearUserFocus ( EFocusCause ReasonFocusIsChanging, bool bInAllUsers )
[]
FReply::ClearUserFocus
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
An event should return aFReply::Handled().ClearUserFocus()to ask the system to clear user focus
SlateCore
[FReply](API\Runtime\SlateCore\Input\FReply) & ClearUserFocus ( bool bInAllUsers )
[]
FReply::DetectDrag
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
Ask Slate to detect if a user started dragging in this widget. If a drag is detected, Slate will send an OnDragDetected event.
SlateCore
[FReply](API\Runtime\SlateCore\Input\FReply) & DetectDrag ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > & DetectDragInMe, [FKey](API\Runtime\InputCore\FKey) MouseButton )
[]
FReply::EndDragDrop
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
An event should returnFReply::Handled().EndDragDrop()to request that the current drag/drop operation be terminated.
SlateCore
[FReply](API\Runtime\SlateCore\Input\FReply) & EndDragDrop()
[]
FReply::GetDetectDragRequest
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
a widget for which to detect a drag; Invalid SharedPtr if no drag detection requested
SlateCore
[TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GetDetectDragRequest() const
[]
FReply::GetDetectDragRequestButton
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
the mouse button for which we are detecting a drag
SlateCore
[FKey](API\Runtime\InputCore\FKey) GetDetectDragRequestButton() const
[]
FReply::GetFocusCause
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
Get the reason that a focus change is being requested.
SlateCore
EFocusCause GetFocusCause() const
[]
FReply::GetMouseCaptor
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
If the event replied with a request to capture the mouse, this returns the desired mouse captor. Otherwise returns an invalid pointer.
SlateCore
[TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GetMouseCaptor() const
[]
FReply::GetNavigationDestination
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
Get the widget that is the navigation destination.
SlateCore
[TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GetNavigationDestination() const
[]
FReply::GetMouseLockWidget
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
Returns the widget that the mouse should be locked to (if any)
SlateCore
[TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GetMouseLockWidget() const
[]
FReply::GetNavigationGenesis
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
Get the genesis of the navigation.
SlateCore
ENavigationGenesis GetNavigationGenesis() const
[]
FReply::GetNavigationSource
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
Get the source of the navigation.
SlateCore
ENavigationSource GetNavigationSource() const
[]
FReply::GetRequestedMousePos
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
The coordinates of the requested mouse position
SlateCore
const [TOptional](API\Runtime\Core\IO\TOptional)< FIntPoint > & GetRequestedMousePos() const
[]
FReply::GetDragDropContent
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
the Content that we should use for the Drag and Drop operation; Invalid SharedPtr if a drag and drop operation is not requested
SlateCore
const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FDragDropOperation](API\Runtime\SlateCore\Input\FDragDropOperation) > & GetDragDropContent() const
[]
FReply::GetNavigationType
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
Get the navigation type (Invalid if no navigation is requested).
SlateCore
EUINavigation GetNavigationType() const
[]
FReply::GetUserFocusRecepient
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
When not nullptr, user focus has been requested to be set on the FocusRecipient.
SlateCore
[TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GetUserFocusRecepient() const
[]
FReply::Handled
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
An event should return aFReply::Handled()to let the system know that an event was handled.
SlateCore
static [FReply](API\Runtime\SlateCore\Input\FReply) Handled()
[]
FReply::PreventThrottling
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
Ensures throttling for SlateUI responsiveness is not done on mouse down
SlateCore
[FReply](API\Runtime\SlateCore\Input\FReply) & PreventThrottling()
[]
FReply::LockMouseToWidget
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
An event should returnFReply::Handled().LockMouseToWidget( SomeWidget ) as a means of asking the system to Lock the mouse so it cannot move out of the bounds of the widget.
SlateCore
[FReply](API\Runtime\SlateCore\Input\FReply) & LockMouseToWidget ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > InWidget )
[]
FReply::ReleaseMouseCapture
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
An event should return aFReply::Handled().ReleaseMouse() to ask the system to release mouse capture NOTE: Deactivates high precision mouse movement if activated.
SlateCore
[FReply](API\Runtime\SlateCore\Input\FReply) & ReleaseMouseCapture()
[]
FReply::ReleaseMouseLock
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
An event should return aFReply::Handled().ReleaseMouseLock()to ask the system to release mouse lock on a widget
SlateCore
[FReply](API\Runtime\SlateCore\Input\FReply) & ReleaseMouseLock()
[]
FReply::SetMousePos
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
An event should returnFReply::Handled().SetMousePos to ask Slate to move the mouse cursor to a different location
SlateCore
[FReply](API\Runtime\SlateCore\Input\FReply) & SetMousePos ( const FIntPoint & NewMousePos )
[]
FReply::SetNavigation
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
An event should returnFReply::Handled().SetNavigation( NavigationType ) as a means of asking the system to attempt a navigation
SlateCore
[FReply](API\Runtime\SlateCore\Input\FReply) & SetNavigation ( EUINavigation InNavigationType, const ENavigationGenesis InNavigationGenesis, const ENavigationSource InNavigationSource )
[]
FReply::SetNavigation
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
An event should returnFReply::Handled().SetNavigation( NavigationDestination ) as a means of asking the system to attempt a navigation to the specified destination
SlateCore
[FReply](API\Runtime\SlateCore\Input\FReply) & SetNavigation ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > InNavigationDestination, const ENavigationGenesis InNavigationGenesis, const ENavigationSource InNavigationSource )
[]
FReply::ShouldEndDragDrop
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
true if the user has asked us to terminate the ongoing drag/drop operation
SlateCore
bool ShouldEndDragDrop() const
[]
FReply::SetUserFocus
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
An event should returnFReply::Handled().SetUserFocus( SomeWidget ) as a means of asking the system to set users focus to the provided widget
SlateCore
[FReply](API\Runtime\SlateCore\Input\FReply) & SetUserFocus ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GiveMeFocus, EFocusCause ReasonFocusIsChanging, bool bInAllUsers )
[]
FReply::ShouldReleaseMouseLock
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
True if the reply indicated that we should release mouse lock
SlateCore
bool ShouldReleaseMouseLock() const
[]
FReply::ShouldReleaseMouse
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
True if this reply indicated that we should release mouse capture as a result of the event being handled
SlateCore
bool ShouldReleaseMouse() const
[]
FReply::ShouldReleaseUserFocus
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
True if this reply indicated that we should release focus as a result of the event being handled
SlateCore
bool ShouldReleaseUserFocus() const
[]
FReply::ShouldSetUserFocus
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
True if this reply indicated that we should set focus as a result of the event being handled
SlateCore
bool ShouldSetUserFocus() const
[]
FReply::ShouldThrottle
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
Whether or not we should throttle on mouse down
SlateCore
bool ShouldThrottle() const
[]
FReply::Unhandled
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
An event should return aFReply::Unhandled()to let the system know that an event was unhandled.
SlateCore
static [FReply](API\Runtime\SlateCore\Input\FReply) Unhandled()
[]
FReply::UseHighPrecisionMouseMovement
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
Enables the use of high precision (raw input) mouse movement, for more accurate mouse movement without mouse ballistics NOTE: This implies mouse capture and hidden mouse movement. Releasing mouse capture deactivates this mode.
SlateCore
[FReply](API\Runtime\SlateCore\Input\FReply) & UseHighPrecisionMouseMovement ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > InMouseCaptor )
[]
FReply::ShouldUseHighPrecisionMouse
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
True if this reply indicated that we should use high precision mouse movement
SlateCore
bool ShouldUseHighPrecisionMouse() const
[]
FReply::ToString
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
Converts the reply into an string representation.
SlateCore
[FString](API\Runtime\Core\Containers\FString) ToString()
[]
FReply
/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
No constructors are accessible with public or protected access.
SlateCore
class FReply : public [TReplyBase< FReply >](API\Runtime\SlateCore\Input\TReplyBase)
[]
FReplyBase::GetHandler
/Engine/Source/Runtime/SlateCore/Public/Input/ReplyBase.h
The widget that ultimately handled the event
SlateCore
const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GetHandler() const
[]
FReplyBase::IsEventHandled
/Engine/Source/Runtime/SlateCore/Public/Input/ReplyBase.h
true if this this reply is a result of the event being handled; false otherwise.
SlateCore
bool IsEventHandled() const
[]
FReplyBase
/Engine/Source/Runtime/SlateCore/Public/Input/ReplyBase.h
Base class for all the ways that a Slate Widget can reply to events. Typical replies include requests to set focus, capture or release the pointer, signify a cursor preference, etc.
SlateCore
class FReplyBase
[ { "type": "bool", "name": "bIsHandled", "description": "Has a widget handled an event." }, { "type": "TSharedPtr<SWi...", "name": "EventHandler", "description": "Widget that handled the event that generated this reply." } ]
FReplyBase::FReplyBase
/Engine/Source/Runtime/SlateCore/Public/Input/ReplyBase.h
A reply can be handled or unhandled. Any widget handling events decides whether it has handled the event.
SlateCore
FReplyBase ( bool InIsHandled )
[]
EmptySet
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
The empty set contains no valid keys.
SlateCore
static const [FTouchKeySet](API\Runtime\SlateCore\Input\FTouchKeySet) EmptySet;
[]
StandardSet
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
The standard set consists of just the left mouse button key.
SlateCore
static const [FTouchKeySet](API\Runtime\SlateCore\Input\FTouchKeySet) StandardSet;
[]
FTouchKeySet::FTouchKeySet
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
Creates and initializes a new instance with the specified key.
SlateCore
FTouchKeySet ( [FKey](API\Runtime\InputCore\FKey) Key )
[]
FTouchKeySet
/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
Helper class to auto-populate a set with the set of "keys" a touch represents
SlateCore
class FTouchKeySet : public [TSet< FKey >](API\Runtime\Core\Containers\TSet)
[]