FInputHandlerStack

Class responsible for handling input to multiple objects that reside at the same level in the widget hierarchy.

API > API/Editor > API/Editor/SequencerCore > API/Editor/SequencerCore/MVVM > API/Editor/SequencerCore/MVVM/Views

References

   
Module SequencerCore
Header /Engine/Source/Editor/SequencerCore/Public/MVVM/Views/SequencerInputHandlerStack.h
Include #include "MVVM/Views/SequencerInputHandlerStack.h"

Syntax

class FInputHandlerStack

Remarks

Class responsible for handling input to multiple objects that reside at the same level in the widget hierarchy.

The sequencer track area is one such example of a single widget that delegates its input handling to multiple sources (edit tool, or time slider controller). To alleviate the complexity of handling input for such sources, where each may fight for mouse capture, this class keeps track of which handler captured the mouse and routs input accordingly.

When no mouse capture is active, handlers are called sequentially in the order they were added, until the event is handled.

Variables

  Type Name Description
Public variable FSimpleMulticastDelegate OnBeginCapture  
Public variable FSimpleMulticastDelegate OnEndCapture  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void Add a handler to the stack
Public function Const int32 Get the index of the currently captured handler, or INDEX_NONE
Public function FReply

HandleKeyDown ( SWidget& OwnerWidget,
const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

  
Public function FReply

HandleKeyUp ( SWidget& OwnerWidget,
const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

  
Public function FReply

HandleMouseButtonDown ( SWidget& OwnerWidget,
const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 Handle a mouse down
Public function FReply

HandleMouseButtonUp ( SWidget& OwnerWidget,
const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 Handle a mouse up
Public function FReply

HandleMouseMove ( SWidget& OwnerWidget,
const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 Handle a mouse move
Public function FReply

HandleMouseWheel ( SWidget& OwnerWidget,
const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 Handle a mouse wheel
Public function void

SetHandlerAt ( int32 Index,
ISequencerInputHandler* Handler
)

 Reset an existing entry in the stack to a new handler

Typedefs

Name Description
InputHandlerFunction  
KeyInputHandlerFunction A Reply is something that a Slate event returns to the system to notify it about certain aspect of how an event was handled.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page