Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

UUserWidget::OnPreviewMouseButtonDown

Just like OnMouseButtonDown, but tunnels instead of bubbling.

Windows

MacOS

Linux

References

Module	UMG
Header	/Engine/Source/Runtime/UMG/Public/Blueprint/UserWidget.h
Include	#include "Blueprint/UserWidget.h"

Syntax

FEventReply OnPreviewMouseButtonDown
(
FGeometry MyGeometry,
const FPointerEvent & MouseEvent
)

Remarks

Just like OnMouseButtonDown, but tunnels instead of bubbling. If this even is handled, OnMouseButtonDown will not be sent.

Use this event sparingly as preview events generally make UIs more difficult to reason about.

Returns

Whether the event was handled along with possible requests for the system to take action.

Parameters

Parameter	Description
MyGeometry	The Geometry of the widget receiving the event
MouseEvent	Information about the input event

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss