FSlateDebugging Class Reference

#include <SlateDebugging.h>

Classes
struct	FScopeProcessInputEvent
struct	FScopeRouteInputEvent
struct	IWidgetInputRoutingEvent

Public Member Functions
	DECLARE_MULTICAST_DELEGATE_OneParam (FBeginWindow, const FSlateWindowElementList &)
	DECLARE_MULTICAST_DELEGATE_OneParam (FEndWindow, const FSlateWindowElementList &)
	DECLARE_MULTICAST_DELEGATE_SixParams (FBeginWidgetPaint, const SWidget *, const FPaintArgs &, const FGeometry &, const FSlateRect &, const FSlateWindowElementList &, int32)
	DECLARE_MULTICAST_DELEGATE_ThreeParams (FEndWidgetPaint, const SWidget *, const FSlateWindowElementList &, int32)
	DECLARE_MULTICAST_DELEGATE_OneParam (FBeginWidgetPrepass, const SWidget *)
	DECLARE_MULTICAST_DELEGATE_OneParam (FEndWidgetPrepass, const SWidget *)
	DECLARE_MULTICAST_DELEGATE_FourParams (FPaintDebugElements, const FPaintArgs &, const FGeometry &, FSlateWindowElementList &, int32 &)
	DECLARE_MULTICAST_DELEGATE_TwoParams (FDrawElement, const FSlateWindowElementList &, int32)
PRAGMA_ENABLE_DEPRECATION_WARNINGS	DECLARE_MULTICAST_DELEGATE_OneParam (FDrawElementType, const FSlateDebuggingElementTypeAddedEventArgs &)
	DECLARE_MULTICAST_DELEGATE_OneParam (FWidgetWarningEvent, const FSlateDebuggingWarningEventArgs &)
	DECLARE_MULTICAST_DELEGATE_OneParam (FWidgetInputEvent, const FSlateDebuggingInputEventArgs &)
	DECLARE_MULTICAST_DELEGATE_OneParam (FWidgetFocusEvent, const FSlateDebuggingFocusEventArgs &)
	DECLARE_MULTICAST_DELEGATE_OneParam (FWidgetAttemptNavigationEvent, const FSlateDebuggingNavigationEventArgs &)
	DECLARE_MULTICAST_DELEGATE_OneParam (FWidgetExecuteNavigationEvent, const FSlateDebuggingExecuteNavigationEventArgs &)
	DECLARE_MULTICAST_DELEGATE_OneParam (FWidgetMouseCaptureEvent, const FSlateDebuggingMouseCaptureEventArgs &)
	DECLARE_MULTICAST_DELEGATE_OneParam (FWidgetCursorQuery, const FSlateDebuggingCursorQueryEventArgs &)
	DECLARE_MULTICAST_DELEGATE_OneParam (FWidgetInvalidate, const FSlateDebuggingInvalidateArgs &)
	DECLARE_MULTICAST_DELEGATE_OneParam (FWidgetUpdatedEvent, const FSlateDebuggingWidgetUpdatedEventArgs &)
	DECLARE_MULTICAST_DELEGATE_TwoParams (FUICommandRun, const FName &, const FText &)

Static Public Member Functions
static SLATECORE_API void	BroadcastWarning (const FText &WarningText, const TSharedPtr< SWidget > &OptionalContextWidget)
static SLATECORE_API void	BroadcastInputEvent (ESlateDebuggingInputEvent InputEventType, const FInputEvent *InInputEvent, const FReply &InReply)
static SLATECORE_API void	BroadcastInputEvent (ESlateDebuggingInputEvent InputEventType, const FInputEvent *InInputEvent, const TSharedPtr< SWidget > &HandlerWidget)
static SLATECORE_API void	BroadcastInputEvent (ESlateDebuggingInputEvent InputEventType, const FInputEvent *InInputEvent, const FReply &InReply, const TSharedPtr< SWidget > &HandlerWidget)
static SLATECORE_API void	BroadcastInputEvent (ESlateDebuggingInputEvent InputEventType, const FInputEvent *InInputEvent, const FReply &InReply, const TSharedPtr< SWidget > &HandlerWidget, const FString &AdditionalContent)
static SLATECORE_API void	BroadcastInputEvent (ESlateDebuggingInputEvent InputEventType, const FInputEvent *InInputEvent, const FReply &InReply, const TSharedPtr< SWidget > &HandlerWidget, const FName &AdditionalContent)
static SLATECORE_API void	BroadcastInputEvent (ESlateDebuggingInputEvent InputEventType, const FInputEvent *InInputEvent, const FReply &InReply, const TSharedPtr< SWidget > &HandlerWidget, const TCHAR AdditionalContent)
static SLATECORE_API void	BroadcastNoReplyInputEvent (ESlateDebuggingInputEvent InputEventType, const FInputEvent *InInputEvent, const TSharedPtr< SWidget > &HandlerWidget)
static SLATECORE_API void	BroadcastPreProcessInputEvent (ESlateDebuggingInputEvent InputEventType, const TCHAR *InputPrecessorName, bool bHandled)
static SLATECORE_API void	RegisterWidgetInputRoutingEvent (IWidgetInputRoutingEvent *Event)
static SLATECORE_API void	UnregisterWidgetInputRoutingEvent (IWidgetInputRoutingEvent *Event)
static SLATECORE_API void	BroadcastFocusChanging (const FFocusEvent &InFocusEvent, const FWeakWidgetPath &InOldFocusedWidgetPath, const TSharedPtr< SWidget > &InOldFocusedWidget, const FWidgetPath &InNewFocusedWidgetPath, const TSharedPtr< SWidget > &InNewFocusedWidget)
static SLATECORE_API void	BroadcastFocusLost (const FFocusEvent &InFocusEvent, const FWeakWidgetPath &InOldFocusedWidgetPath, const TSharedPtr< SWidget > &InOldFocusedWidget, const FWidgetPath &InNewFocusedWidgetPath, const TSharedPtr< SWidget > &InNewFocusedWidget)
static SLATECORE_API void	BroadcastFocusReceived (const FFocusEvent &InFocusEvent, const FWeakWidgetPath &InOldFocusedWidgetPath, const TSharedPtr< SWidget > &InOldFocusedWidget, const FWidgetPath &InNewFocusedWidgetPath, const TSharedPtr< SWidget > &InNewFocusedWidget)
static SLATECORE_API void	BroadcastAttemptNavigation (const FNavigationEvent &InNavigationEvent, const FNavigationReply &InNavigationReply, const FWidgetPath &InNavigationSource, const TSharedPtr< SWidget > &InDestinationWidget, ESlateDebuggingNavigationMethod InNavigationMethod)
static SLATECORE_API void	BroadcastExecuteNavigation ()
static SLATECORE_API void	BroadcastMouseCapture (uint32 UserIndex, uint32 PointerIndex, TSharedPtr< const SWidget > InCapturingWidget)
static SLATECORE_API void	BroadcastMouseCaptureLost (uint32 UserIndex, uint32 PointerIndex, TSharedPtr< const SWidget > InWidgetLostCapture)
static SLATECORE_API void	BroadcastCursorQuery (TSharedPtr< const SWidget > InWidgetOverridingCursor, const FCursorReply &InReply)
static SLATECORE_API void	BroadcastWidgetInvalidate (const SWidget *WidgetInvalidated, const SWidget *WidgetInvalidateInvestigator, EInvalidateWidgetReason InvalidateReason)
static SLATECORE_API void	BroadcastInvalidationRootInvalidate (const SWidget *WidgetInvalidated, const SWidget *WidgetInvalidateInvestigator, ESlateDebuggingInvalidateRootReason InvalidateReason)
static SLATECORE_API void	BroadcastWidgetUpdated (const SWidget *Invalidated, EWidgetUpdateFlags UpdateFlags)
static SLATECORE_API void	BroadcastWidgetUpdatedByPaint (const SWidget *Invalidated, EWidgetUpdateFlags UpdateFlags)
static SLATECORE_API const TArray< const SWidget * > &	GetAllWidgets ()
static SLATECORE_API void	ExportWidgetList (FStringView Filename)

Static Public Attributes
static SLATECORE_API FBeginWindow	BeginWindow
static SLATECORE_API FEndWindow	EndWindow
static SLATECORE_API FBeginWidgetPaint	BeginWidgetPaint
static SLATECORE_API FEndWidgetPaint	EndWidgetPaint
static SLATECORE_API FBeginWidgetPrepass	BeginWidgetPrepass
static SLATECORE_API FEndWidgetPrepass	EndWidgetPrepass
static SLATECORE_API FPaintDebugElements	PaintDebugElements
SLATECORE_API static PRAGMA_DISABLE_DEPRECATION_WARNINGS FDrawElement	ElementAdded
static SLATECORE_API FDrawElementType	ElementTypeAdded
static SLATECORE_API FWidgetWarningEvent	Warning
static SLATECORE_API FWidgetInputEvent	InputEvent
static SLATECORE_API FWidgetFocusEvent	FocusEvent
static SLATECORE_API FWidgetAttemptNavigationEvent	AttemptNavigationEvent
static SLATECORE_API FWidgetExecuteNavigationEvent	ExecuteNavigationEvent
static SLATECORE_API FWidgetMouseCaptureEvent	MouseCaptureEvent
static SLATECORE_API FWidgetCursorQuery	CursorChangedEvent
static SLATECORE_API FWidgetInvalidate	WidgetInvalidateEvent
static SLATECORE_API FWidgetUpdatedEvent	WidgetUpdatedEvent
static SLATECORE_API FUICommandRun	CommandRun

Member Function Documentation

BroadcastAttemptNavigation()

static SLATECORE_API void FSlateDebugging::BroadcastAttemptNavigation ( const FNavigationEvent &  InNavigationEvent, const FNavigationReply &  InNavigationReply, const FWidgetPath &  InNavigationSource, const TSharedPtr< SWidget > &  InDestinationWidget, ESlateDebuggingNavigationMethod  InNavigationMethod  )

static

BroadcastCursorQuery()

static SLATECORE_API void FSlateDebugging::BroadcastCursorQuery ( TSharedPtr< const SWidget >  InWidgetOverridingCursor, const FCursorReply &  InReply  )

static

BroadcastExecuteNavigation()

static SLATECORE_API void FSlateDebugging::BroadcastExecuteNavigation ( )

static

BroadcastFocusChanging()

static SLATECORE_API void FSlateDebugging::BroadcastFocusChanging ( const FFocusEvent &  InFocusEvent, const FWeakWidgetPath &  InOldFocusedWidgetPath, const TSharedPtr< SWidget > &  InOldFocusedWidget, const FWidgetPath &  InNewFocusedWidgetPath, const TSharedPtr< SWidget > &  InNewFocusedWidget  )

static

BroadcastFocusLost()

static SLATECORE_API void FSlateDebugging::BroadcastFocusLost ( const FFocusEvent &  InFocusEvent, const FWeakWidgetPath &  InOldFocusedWidgetPath, const TSharedPtr< SWidget > &  InOldFocusedWidget, const FWidgetPath &  InNewFocusedWidgetPath, const TSharedPtr< SWidget > &  InNewFocusedWidget  )

static

BroadcastFocusReceived()

static SLATECORE_API void FSlateDebugging::BroadcastFocusReceived ( const FFocusEvent &  InFocusEvent, const FWeakWidgetPath &  InOldFocusedWidgetPath, const TSharedPtr< SWidget > &  InOldFocusedWidget, const FWidgetPath &  InNewFocusedWidgetPath, const TSharedPtr< SWidget > &  InNewFocusedWidget  )

static

BroadcastInputEvent() [1/6]

static SLATECORE_API void FSlateDebugging::BroadcastInputEvent ( ESlateDebuggingInputEvent  InputEventType, const FInputEvent *  InInputEvent, const FReply &  InReply  )

static

BroadcastInputEvent() [2/6]

static SLATECORE_API void FSlateDebugging::BroadcastInputEvent ( ESlateDebuggingInputEvent  InputEventType, const FInputEvent *  InInputEvent, const FReply &  InReply, const TSharedPtr< SWidget > &  HandlerWidget  )

static

BroadcastInputEvent() [3/6]

static SLATECORE_API void FSlateDebugging::BroadcastInputEvent ( ESlateDebuggingInputEvent  InputEventType, const FInputEvent *  InInputEvent, const FReply &  InReply, const TSharedPtr< SWidget > &  HandlerWidget, const FName &  AdditionalContent  )

static

BroadcastInputEvent() [4/6]

static SLATECORE_API void FSlateDebugging::BroadcastInputEvent ( ESlateDebuggingInputEvent  InputEventType, const FInputEvent *  InInputEvent, const FReply &  InReply, const TSharedPtr< SWidget > &  HandlerWidget, const FString &  AdditionalContent  )

static

BroadcastInputEvent() [5/6]

static SLATECORE_API void FSlateDebugging::BroadcastInputEvent ( ESlateDebuggingInputEvent  InputEventType, const FInputEvent *  InInputEvent, const FReply &  InReply, const TSharedPtr< SWidget > &  HandlerWidget, const TCHAR  AdditionalContent  )

static

BroadcastInputEvent() [6/6]

static SLATECORE_API void FSlateDebugging::BroadcastInputEvent ( ESlateDebuggingInputEvent  InputEventType, const FInputEvent *  InInputEvent, const TSharedPtr< SWidget > &  HandlerWidget  )

static

BroadcastInvalidationRootInvalidate()

static SLATECORE_API void FSlateDebugging::BroadcastInvalidationRootInvalidate ( const SWidget *  WidgetInvalidated, const SWidget *  WidgetInvalidateInvestigator, ESlateDebuggingInvalidateRootReason  InvalidateReason  )

static

BroadcastMouseCapture()

static SLATECORE_API void FSlateDebugging::BroadcastMouseCapture ( uint32  UserIndex, uint32  PointerIndex, TSharedPtr< const SWidget >  InCapturingWidget  )

static

BroadcastMouseCaptureLost()

static SLATECORE_API void FSlateDebugging::BroadcastMouseCaptureLost ( uint32  UserIndex, uint32  PointerIndex, TSharedPtr< const SWidget >  InWidgetLostCapture  )

static

BroadcastNoReplyInputEvent()

static SLATECORE_API void FSlateDebugging::BroadcastNoReplyInputEvent ( ESlateDebuggingInputEvent  InputEventType, const FInputEvent *  InInputEvent, const TSharedPtr< SWidget > &  HandlerWidget  )

static

BroadcastPreProcessInputEvent()

static SLATECORE_API void FSlateDebugging::BroadcastPreProcessInputEvent ( ESlateDebuggingInputEvent  InputEventType, const TCHAR *  InputPrecessorName, bool  bHandled  )

static

BroadcastWarning()

static SLATECORE_API void FSlateDebugging::BroadcastWarning ( const FText &  WarningText, const TSharedPtr< SWidget > &  OptionalContextWidget  )

static

BroadcastWidgetInvalidate()

static SLATECORE_API void FSlateDebugging::BroadcastWidgetInvalidate ( const SWidget *  WidgetInvalidated, const SWidget *  WidgetInvalidateInvestigator, EInvalidateWidgetReason  InvalidateReason  )

static

BroadcastWidgetUpdated()

static SLATECORE_API void FSlateDebugging::BroadcastWidgetUpdated ( const SWidget *  Invalidated, EWidgetUpdateFlags  UpdateFlags  )

static

BroadcastWidgetUpdatedByPaint()

static SLATECORE_API void FSlateDebugging::BroadcastWidgetUpdatedByPaint ( const SWidget *  Invalidated, EWidgetUpdateFlags  UpdateFlags  )

static

DECLARE_MULTICAST_DELEGATE_FourParams()

FSlateDebugging::DECLARE_MULTICAST_DELEGATE_FourParams	(	FPaintDebugElements	,
		const FPaintArgs &	,
		const FGeometry &	,
		FSlateWindowElementList &	,
		int32 &
	)

Called once the window is drawn (including PaintDeferred). It can be used to draw additional debug info on top of the window.

DECLARE_MULTICAST_DELEGATE_OneParam() [1/14]

FSlateDebugging::DECLARE_MULTICAST_DELEGATE_OneParam	(	FBeginWidgetPrepass	,
		const SWidget *
	)

Called just before a widget starts its prepass.

DECLARE_MULTICAST_DELEGATE_OneParam() [2/14]

FSlateDebugging::DECLARE_MULTICAST_DELEGATE_OneParam	(	FBeginWindow	,
		const FSlateWindowElementList &
	)

Called when a widget begins painting.

DECLARE_MULTICAST_DELEGATE_OneParam() [3/14]

PRAGMA_ENABLE_DEPRECATION_WARNINGS FSlateDebugging::DECLARE_MULTICAST_DELEGATE_OneParam	(	FDrawElementType	,
		const FSlateDebuggingElementTypeAddedEventArgs &
	)

Called as soon as the element is added to the element list. NOTE: These elements are not valid until the widget finishes painting, or you can resolve them all after the window finishes painting.

DECLARE_MULTICAST_DELEGATE_OneParam() [4/14]

FSlateDebugging::DECLARE_MULTICAST_DELEGATE_OneParam	(	FEndWidgetPrepass	,
		const SWidget *
	)

Called after a widget finishes its prepass.

DECLARE_MULTICAST_DELEGATE_OneParam() [5/14]

FSlateDebugging::DECLARE_MULTICAST_DELEGATE_OneParam	(	FEndWindow	,
		const FSlateWindowElementList &
	)

Called when a window finishes painting.

DECLARE_MULTICAST_DELEGATE_OneParam() [6/14]

FSlateDebugging::DECLARE_MULTICAST_DELEGATE_OneParam	(	FWidgetAttemptNavigationEvent	,
		const FSlateDebuggingNavigationEventArgs &
	)

DECLARE_MULTICAST_DELEGATE_OneParam() [7/14]

FSlateDebugging::DECLARE_MULTICAST_DELEGATE_OneParam	(	FWidgetCursorQuery	,
		const FSlateDebuggingCursorQueryEventArgs &
	)

DECLARE_MULTICAST_DELEGATE_OneParam() [8/14]

FSlateDebugging::DECLARE_MULTICAST_DELEGATE_OneParam	(	FWidgetExecuteNavigationEvent	,
		const FSlateDebuggingExecuteNavigationEventArgs &
	)

DECLARE_MULTICAST_DELEGATE_OneParam() [9/14]

FSlateDebugging::DECLARE_MULTICAST_DELEGATE_OneParam	(	FWidgetFocusEvent	,
		const FSlateDebuggingFocusEventArgs &
	)

DECLARE_MULTICAST_DELEGATE_OneParam() [10/14]

FSlateDebugging::DECLARE_MULTICAST_DELEGATE_OneParam	(	FWidgetInputEvent	,
		const FSlateDebuggingInputEventArgs &
	)

DECLARE_MULTICAST_DELEGATE_OneParam() [11/14]

FSlateDebugging::DECLARE_MULTICAST_DELEGATE_OneParam	(	FWidgetInvalidate	,
		const FSlateDebuggingInvalidateArgs &
	)

DECLARE_MULTICAST_DELEGATE_OneParam() [12/14]

FSlateDebugging::DECLARE_MULTICAST_DELEGATE_OneParam	(	FWidgetMouseCaptureEvent	,
		const FSlateDebuggingMouseCaptureEventArgs &
	)

DECLARE_MULTICAST_DELEGATE_OneParam() [13/14]

FSlateDebugging::DECLARE_MULTICAST_DELEGATE_OneParam	(	FWidgetUpdatedEvent	,
		const FSlateDebuggingWidgetUpdatedEventArgs &
	)

DECLARE_MULTICAST_DELEGATE_OneParam() [14/14]

FSlateDebugging::DECLARE_MULTICAST_DELEGATE_OneParam	(	FWidgetWarningEvent	,
		const FSlateDebuggingWarningEventArgs &
	)

DECLARE_MULTICAST_DELEGATE_SixParams()

FSlateDebugging::DECLARE_MULTICAST_DELEGATE_SixParams	(	FBeginWidgetPaint	,
		const SWidget *	,
		const FPaintArgs &	,
		const FGeometry &	,
		const FSlateRect &	,
		const FSlateWindowElementList &	,
		int32
	)

Called just before a widget paints.

DECLARE_MULTICAST_DELEGATE_ThreeParams()

FSlateDebugging::DECLARE_MULTICAST_DELEGATE_ThreeParams	(	FEndWidgetPaint	,
		const SWidget *	,
		const FSlateWindowElementList &	,
		int32
	)

Called after a widget finishes painting.

DECLARE_MULTICAST_DELEGATE_TwoParams() [1/2]

FSlateDebugging::DECLARE_MULTICAST_DELEGATE_TwoParams	(	FDrawElement	,
		const FSlateWindowElementList &	,
		int32
	)

Called as soon as the element is added to the element list. NOTE: These elements are not valid until the widget finishes painting, or you can resolve them all after the window finishes painting.

DECLARE_MULTICAST_DELEGATE_TwoParams() [2/2]

FSlateDebugging::DECLARE_MULTICAST_DELEGATE_TwoParams	(	FUICommandRun	,
		const FName &	,
		const FText &
	)

ExportWidgetList()

static SLATECORE_API void FSlateDebugging::ExportWidgetList ( FStringView  Filename )

static

GetAllWidgets()

static SLATECORE_API const TArray< const SWidget * > & FSlateDebugging::GetAllWidgets ( )

static

RegisterWidgetInputRoutingEvent()

static SLATECORE_API void FSlateDebugging::RegisterWidgetInputRoutingEvent ( IWidgetInputRoutingEvent *  Event )

static

UnregisterWidgetInputRoutingEvent()

static SLATECORE_API void FSlateDebugging::UnregisterWidgetInputRoutingEvent ( IWidgetInputRoutingEvent *  Event )

static

Member Data Documentation

AttemptNavigationEvent

SLATECORE_API FWidgetAttemptNavigationEvent FSlateDebugging::AttemptNavigationEvent

static

BeginWidgetPaint

SLATECORE_API FBeginWidgetPaint FSlateDebugging::BeginWidgetPaint

static

BeginWidgetPrepass

SLATECORE_API FBeginWidgetPrepass FSlateDebugging::BeginWidgetPrepass

static

BeginWindow

SLATECORE_API FBeginWindow FSlateDebugging::BeginWindow

static

CommandRun

SLATECORE_API FUICommandRun FSlateDebugging::CommandRun

static

CursorChangedEvent

SLATECORE_API FWidgetCursorQuery FSlateDebugging::CursorChangedEvent

static

ElementAdded

SLATECORE_API static PRAGMA_DISABLE_DEPRECATION_WARNINGS FDrawElement FSlateDebugging::ElementAdded

static

ElementTypeAdded

SLATECORE_API FDrawElementType FSlateDebugging::ElementTypeAdded

static

EndWidgetPaint

SLATECORE_API FEndWidgetPaint FSlateDebugging::EndWidgetPaint

static

EndWidgetPrepass

SLATECORE_API FEndWidgetPrepass FSlateDebugging::EndWidgetPrepass

static

EndWindow

SLATECORE_API FEndWindow FSlateDebugging::EndWindow

static

ExecuteNavigationEvent

SLATECORE_API FWidgetExecuteNavigationEvent FSlateDebugging::ExecuteNavigationEvent

static

FocusEvent

SLATECORE_API FWidgetFocusEvent FSlateDebugging::FocusEvent

static

InputEvent

SLATECORE_API FWidgetInputEvent FSlateDebugging::InputEvent

static

MouseCaptureEvent

SLATECORE_API FWidgetMouseCaptureEvent FSlateDebugging::MouseCaptureEvent

static

PaintDebugElements

SLATECORE_API FPaintDebugElements FSlateDebugging::PaintDebugElements

static

Warning

SLATECORE_API FWidgetWarningEvent FSlateDebugging::Warning

static

WidgetInvalidateEvent

SLATECORE_API FWidgetInvalidate FSlateDebugging::WidgetInvalidateEvent

static

WidgetUpdatedEvent

SLATECORE_API FWidgetUpdatedEvent FSlateDebugging::WidgetUpdatedEvent

static

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/SlateCore/Public/Debugging/SlateDebugging.h