class

CReply

Module
Arc
Header
#include "Arc/Framework/CReply.h"
Namespace
Arcf

Public functions

ReturnsNameDescription
CReplyHandled
CReplyUnhandled
CReply&CaptureMouse
CReply&ReleaseMouse
CReply&SetUserFocus
CReply&ClearUserFocus
CReply&DetectDrag
CReply&StopBubblingSwallows a key the handler did NOT act on: the ancestors never see it, but the framework fallbacks (tab traversal, the command system) still run.
boolIsEventHandled
boolShouldStopBubblingTrue when the key must not be offered to the next ancestor.
boolIsEventConsumedTrue 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).
boolShouldCaptureMouse
boolShouldReleaseMouse
boolShouldSetFocus
boolShouldClearFocus
boolShouldDetectDrag
TSharedPtr<AWidget>GetMouseCaptureWidget
TSharedPtr<AWidget>GetFocusWidget
TSharedPtr<AWidget>GetDetectDragWidget
intGetDetectDragButton

Function details

Handled

C++
static CReply Handled()

Unhandled

C++
static CReply Unhandled()

CaptureMouse

C++
CReply& CaptureMouse(TSharedPtr<AWidget> widget)

ReleaseMouse

C++
CReply& ReleaseMouse()

SetUserFocus

C++
CReply& SetUserFocus(TSharedPtr<AWidget> widget)

ClearUserFocus

C++
CReply& ClearUserFocus()

DetectDrag

C++
CReply& DetectDrag(TSharedPtr<AWidget> widget, int mouseButton = 0)

StopBubbling

C++
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

C++
bool IsEventHandled() const

ShouldStopBubbling

C++
bool ShouldStopBubbling() const

True when the key must not be offered to the next ancestor.

IsEventConsumed

C++
bool IsEventConsumed() const

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). 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

C++
bool ShouldCaptureMouse() const

ShouldReleaseMouse

C++
bool ShouldReleaseMouse() const

ShouldSetFocus

C++
bool ShouldSetFocus() const

ShouldClearFocus

C++
bool ShouldClearFocus() const

ShouldDetectDrag

C++
bool ShouldDetectDrag() const

GetMouseCaptureWidget

C++
TSharedPtr<AWidget> GetMouseCaptureWidget() const

GetFocusWidget

C++
TSharedPtr<AWidget> GetFocusWidget() const

GetDetectDragWidget

C++
TSharedPtr<AWidget> GetDetectDragWidget() const

GetDetectDragButton

C++
int GetDetectDragButton() const
Generated from Arc/Framework/CReply.h via arc.json · Nov 5, 2026Version 1.0.0