CReply
- Module
- Arc
- Header
#include "Arc/Framework/CReply.h"- Namespace
Arcf
Public functions
| Returns | Name | Description |
|---|---|---|
CReply | Handled | |
CReply | Unhandled | |
CReply& | CaptureMouse | |
CReply& | ReleaseMouse | |
CReply& | SetUserFocus | |
CReply& | ClearUserFocus | |
CReply& | DetectDrag | |
CReply& | StopBubbling | Swallows a key the handler did NOT act on: the ancestors never see it, but the framework fallbacks (tab traversal, the command system) still run. |
bool | IsEventHandled | |
bool | ShouldStopBubbling | True when the key must not be offered to the next ancestor. |
bool | IsEventConsumed | True when nothing OUTSIDE Arc may act on this event either: a widget handled it, or one deliberately swallowed it (a focused text box owns a plain keystroke even in the frames where its own handler declines and the character arrives as a separate event). |
bool | ShouldCaptureMouse | |
bool | ShouldReleaseMouse | |
bool | ShouldSetFocus | |
bool | ShouldClearFocus | |
bool | ShouldDetectDrag | |
TSharedPtr<AWidget> | GetMouseCaptureWidget | |
TSharedPtr<AWidget> | GetFocusWidget | |
TSharedPtr<AWidget> | GetDetectDragWidget | |
int | GetDetectDragButton |
Function details
Handled
static CReply Handled()Unhandled
static CReply Unhandled()CaptureMouse
CReply& CaptureMouse(TSharedPtr<AWidget> widget)ReleaseMouse
CReply& ReleaseMouse()SetUserFocus
CReply& SetUserFocus(TSharedPtr<AWidget> widget)ClearUserFocus
CReply& ClearUserFocus()DetectDrag
CReply& DetectDrag(TSharedPtr<AWidget> widget, int mouseButton = 0)StopBubbling
CReply& StopBubbling()Swallows a key the handler did NOT act on: the ancestors never see it, but the framework fallbacks (tab traversal, the command system) still run. This is the pre-bubbling drop-on-unhandled behaviour, kept reachable for a widget that must not let a key it declined become one of its parents' shortcuts. Handled() already stops the walk, so this is only for the case where nothing was done.
IsEventHandled
bool IsEventHandled() constShouldStopBubbling
bool ShouldStopBubbling() constTrue when the key must not be offered to the next ancestor.
IsEventConsumed
bool IsEventConsumed() constTrue when nothing OUTSIDE Arc may act on this event either: a widget handled it, or one deliberately swallowed it (a focused text box owns a plain keystroke even in the frames where its own handler declines and the character arrives as a separate event). The host engine's game-input gate reads this. Gating on "something has focus" instead meant one click on a HUD button killed every game key for as long as that widget kept focus.
ShouldCaptureMouse
bool ShouldCaptureMouse() constShouldReleaseMouse
bool ShouldReleaseMouse() constShouldSetFocus
bool ShouldSetFocus() constShouldClearFocus
bool ShouldClearFocus() constShouldDetectDrag
bool ShouldDetectDrag() constGetMouseCaptureWidget
TSharedPtr<AWidget> GetMouseCaptureWidget() constGetFocusWidget
TSharedPtr<AWidget> GetFocusWidget() constGetDetectDragWidget
TSharedPtr<AWidget> GetDetectDragWidget() constGetDetectDragButton
int GetDetectDragButton() const