UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
SVirtualWindow Class Reference

#include <SVirtualWindow.h>

+ Inheritance diagram for SVirtualWindow:

Public Member Functions

SLATE_API void Construct (const FArguments &InArgs)
 
SLATE_API void SetShouldResolveDeferred (bool bResolve)
 
SLATE_API void SetIsFocusable (bool bFocusable)
 
virtual SLATE_API FPopupMethodReply OnQueryPopupMethod () const override
 
virtual SLATE_API bool OnVisualizeTooltip (const TSharedPtr< SWidget > &TooltipContent) override
 
virtual SLATE_API int32 OnPaint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const override
 
virtual SLATE_API void OnArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren) const override
 
virtual SLATE_API bool SupportsKeyboardFocus () const override
 
virtual SLATE_API FVector2D ComputeDesiredSize (float LayoutScaleMultiplier) const override
 
virtual SLATE_API bool Advanced_IsInvalidationRoot () const override
 
- Public Member Functions inherited from SWindow
 SLATE_BEGIN_ARGS (SWindow)
 
SLATECORE_API SWindow ()
 
SLATECORE_API ~SWindow ()
 
SLATECORE_API void Construct (const FArguments &InArgs)
 
EWindowType GetType () const
 
FText GetTitle () const
 
void SetTitle (const FText &InTitle)
 
SLATECORE_API int32 PaintWindow (double CurrentTime, float DeltaTime, FSlateWindowElementList &OutDrawElements, const FWidgetStyle &InWidgetStyle, bool bParentEnabled)
 
SLATECORE_API FOptionalSize GetTitleBarSize () const
 
SLATECORE_API UE::Slate::FDeprecateVector2DResult GetDesiredSizeDesktopPixels () const
 
SLATECORE_API UE::Slate::FDeprecateVector2DResult GetInitialDesiredSizeInScreen () const
 
SLATECORE_API UE::Slate::FDeprecateVector2DResult GetInitialDesiredPositionInScreen () const
 
SLATECORE_API FGeometry GetWindowGeometryInScreen () const
 
SLATECORE_API FGeometry GetWindowGeometryInWindow () const
 
SLATECORE_API FSlateLayoutTransform GetLocalToScreenTransform () const
 
SLATECORE_API FSlateLayoutTransform GetLocalToWindowTransform () const
 
SLATECORE_API UE::Slate::FDeprecateVector2DResult GetPositionInScreen () const
 
SLATECORE_API UE::Slate::FDeprecateVector2DResult GetSizeInScreen () const
 
SLATECORE_API FSlateRect GetNonMaximizedRectInScreen () const
 
SLATECORE_API FSlateRect GetRectInScreen () const
 
SLATECORE_API FSlateRect GetClientRectInScreen () const
 
SLATECORE_API UE::Slate::FDeprecateVector2DResult GetClientSizeInScreen () const
 
SLATECORE_API FSlateRect GetClippingRectangleInWindow () const
 
SLATECORE_API FMargin GetWindowBorderSize (bool bIncTitleBar=false) const
 
SLATECORE_API FMargin GetNonMaximizedWindowBorderSize () const
 
SLATECORE_API void MoveWindowTo (UE::Slate::FDeprecateVector2DParameter NewPosition)
 
SLATECORE_API void ReshapeWindow (UE::Slate::FDeprecateVector2DParameter NewPosition, UE::Slate::FDeprecateVector2DParameter NewSize)
 
SLATECORE_API void ReshapeWindow (const FSlateRect &InNewShape)
 
SLATECORE_API void Resize (UE::Slate::FDeprecateVector2DParameter NewClientSize)
 
SLATECORE_API FSlateRect GetFullScreenInfo () const
 
SLATECORE_API bool IsMorphing () const
 
SLATECORE_API bool IsMorphingSize () const
 
SLATECORE_API void MorphToPosition (const FCurveSequence &Sequence, const float TargetOpacity, const UE::Slate::FDeprecateVector2DParameter &TargetPosition)
 
SLATECORE_API void MorphToShape (const FCurveSequence &Sequence, const float TargetOpacity, const FSlateRect &TargetShape)
 
SLATECORE_API void UpdateMorphTargetShape (const FSlateRect &TargetShape)
 
SLATECORE_API void UpdateMorphTargetPosition (const UE::Slate::FDeprecateVector2DParameter &TargetPosition)
 
SLATECORE_API UE::Slate::FDeprecateVector2DResult GetMorphTargetPosition () const
 
SLATECORE_API FSlateRect GetMorphTargetShape () const
 
SLATECORE_API void FlashWindow ()
 
SLATECORE_API void DrawAttention (const FWindowDrawAttentionParameters &Parameters)
 
SLATECORE_API void BringToFront (bool bForce=false)
 
SLATECORE_API void HACK_ForceToFront ()
 
SLATECORE_API void SetCachedScreenPosition (UE::Slate::FDeprecateVector2DParameter NewPosition)
 
SLATECORE_API void SetCachedSize (UE::Slate::FDeprecateVector2DParameter NewSize)
 
SLATECORE_API TSharedPtr< FGenericWindowGetNativeWindow ()
 
SLATECORE_API TSharedPtr< const FGenericWindowGetNativeWindow () const
 
SLATECORE_API float GetDPIScaleFactor () const
 
SLATECORE_API void SetDPIScaleFactor (const float Factor)
 
SLATECORE_API void SetManualManageDPIChanges (const bool bManualDPI)
 
bool IsManualManageDPIChanges () const
 
SLATECORE_API bool IsDescendantOf (const TSharedPtr< SWindow > &ParentWindow) const
 
SLATECORE_API void SetNativeWindow (TSharedRef< FGenericWindow > InNativeWindow)
 
SLATECORE_API void SetContent (TSharedRef< SWidget > InContent)
 
SLATECORE_API TSharedRef< SWidgetGetContent ()
 
SLATECORE_API bool HasOverlay () const
 
SLATECORE_API SOverlay::FScopedWidgetSlotArguments AddOverlaySlot (const int32 ZOrder=INDEX_NONE)
 
SLATECORE_API bool RemoveOverlaySlot (const TSharedRef< SWidget > &InContent)
 
virtual SLATECORE_API TSharedPtr< FPopupLayerOnVisualizePopup (const TSharedRef< SWidget > &PopupContent) override
 
SLATECORE_API FScopedWidgetSlotArguments AddPopupLayerSlot ()
 
SLATECORE_API void RemovePopupLayerSlot (const TSharedRef< SWidget > &WidgetToRemove)
 
SLATECORE_API void SetFullWindowOverlayContent (TSharedPtr< SWidget > InContent)
 
SLATECORE_API void BeginFullWindowOverlayTransition ()
 
SLATECORE_API void EndFullWindowOverlayTransition ()
 
SLATECORE_API bool HasFullWindowOverlayContent () const
 
SLATECORE_API void SetNativeWindowButtonsVisibility (bool bVisible)
 
SLATECORE_API bool AppearsInTaskbar () const
 
FOnWindowActivatedEventGetOnWindowActivatedEvent ()
 
FOnWindowDeactivatedEventGetOnWindowDeactivatedEvent ()
 
SLATECORE_API void SetOnWindowClosed (const FOnWindowClosed &InDelegate)
 
FOnWindowClosedEventGetOnWindowClosedEvent ()
 
SLATECORE_API void SetOnWindowMoved (const FOnWindowMoved &InDelegate)
 
SLATECORE_API void SetRequestDestroyWindowOverride (const FRequestDestroyWindowOverride &InDelegate)
 
SLATECORE_API void RequestDestroyWindow ()
 
SLATECORE_API void DestroyWindowImmediately ()
 
SLATECORE_API void NotifyWindowBeingDestroyed ()
 
SLATECORE_API void ShowWindow ()
 
SLATECORE_API void HideWindow ()
 
SLATECORE_API void EnableWindow (bool bEnable)
 
SLATECORE_API void SetWindowMode (EWindowMode::Type WindowMode)
 
EWindowMode::Type GetWindowMode () const
 
SLATECORE_API bool IsVisible () const
 
SLATECORE_API bool IsWindowMaximized () const
 
SLATECORE_API bool IsWindowMinimized () const
 
SLATECORE_API void InitialMaximize ()
 
SLATECORE_API void InitialMinimize ()
 
SLATECORE_API void SetOpacity (const float InOpacity)
 
SLATECORE_API float GetOpacity () const
 
SLATECORE_API EWindowTransparency GetTransparencySupport () const
 
virtual SLATECORE_API FString ToString () const override
 
void SetWidgetToFocusOnActivate (TSharedPtr< SWidget > InWidget)
 
TWeakPtr< SWidgetGetWidgetFocusedOnDeactivate ()
 
SLATECORE_API EWindowActivationPolicy ActivationPolicy () const
 
SLATECORE_API bool AcceptsInput () const
 
void SetAcceptsInput (bool bEnabled)
 
SLATECORE_API bool IsUserSized () const
 
SLATECORE_API bool IsAutosized () const
 
SLATECORE_API void SetSizingRule (ESizingRule InSizingRule)
 
SLATECORE_API bool IsRegularWindow () const
 
SLATECORE_API bool IsTopmostWindow () const
 
bool SizeWillChangeOften () const
 
bool ShouldPreserveAspectRatio () const
 
int32 GetExpectedMaxWidth () const
 
int32 GetExpectedMaxHeight () const
 
bool HasOSWindowBorder () const
 
SLATECORE_API bool IsScreenspaceMouseWithin (UE::Slate::FDeprecateVector2DParameter ScreenspaceMouseCoordinate) const
 
SLATECORE_API bool HasSizingFrame () const
 
SLATECORE_API bool HasCloseBox () const
 
SLATECORE_API bool HasMaximizeBox () const
 
SLATECORE_API bool HasMinimizeBox () const
 
void SetAsModalWindow ()
 
bool IsModalWindow ()
 
void SetMirrorWindow (bool bSetMirrorWindow)
 
void SetIsHDR (bool bHDR)
 
bool GetIsHDR () const
 
void SetViewportScaleUIOverride (float InViewportScaleUIOverride)
 
void ResetViewportScaleUIOverride ()
 
float GetViewportScaleUIOverride () const
 
bool IsVirtualWindow () const
 
bool IsMirrorWindow ()
 
void SetTitleBar (const TSharedPtr< IWindowTitleBar > InTitleBar)
 
TSharedPtr< IWindowTitleBarGetTitleBar () const
 
virtual SLATECORE_API FCursorReply OnCursorQuery (const FGeometry &MyGeometry, const FPointerEvent &CursorEvent) const override
 
virtual SLATECORE_API bool OnIsActiveChanged (const FWindowActivateEvent &ActivateEvent)
 
SLATECORE_API void Maximize ()
 
SLATECORE_API void Restore ()
 
SLATECORE_API void Minimize ()
 
SLATECORE_API EWindowZone::Type GetCurrentWindowZone (UE::Slate::FDeprecateVector2DParameter LocalMousePosition)
 
SLATECORE_API int32 GetCornerRadius ()
 
bool IsDrawingEnabled () const
 
virtual bool Advanced_IsWindow () const override
 
virtual SLATECORE_API const FSlateInvalidationRootAdvanced_AsInvalidationRoot () const override
 
SLATECORE_API UE::Slate::FDeprecateVector2DResult GetWindowSizeFromClientSize (UE::Slate::FDeprecateVector2DParameter InClientSize, TOptional< float > DPIScale=TOptional< float >())
 
bool IsFocusedInitially () const
 
SLATECORE_API const TArray< TSharedRef< SWindow > > & GetChildWindows () const
 
SLATECORE_API TArray< TSharedRef< SWindow > > & GetChildWindows ()
 
SLATECORE_API void AddChildWindow (const TSharedRef< SWindow > &ChildWindow)
 
SLATECORE_API TSharedPtr< SWindowGetParentWindow () const
 
SLATECORE_API TSharedPtr< SWindowGetTopmostAncestor ()
 
SLATECORE_API bool RemoveDescendantWindow (const TSharedRef< SWindow > &DescendantToRemove)
 
SLATECORE_API void SetOnWorldSwitchHack (FOnSwitchWorldHack &InOnWorldSwitchHack)
 
SLATECORE_API int32 SwitchWorlds (int32 WorldId) const
 
SLATECORE_API bool IsActive () const
 
SLATECORE_API bool HasActiveChildren () const
 
SLATECORE_API bool HasActiveParent () const
 
void SetViewportSizeDrivenByWindow (bool bDrivenByWindow)
 
bool IsViewportSizeDrivenByWindow () const
 
UE::Slate::FDeprecateVector2DResult GetViewportSize () const
 
void SetIndependentViewportSize (const UE::Slate::FDeprecateVector2DParameter &VP)
 
void SetViewport (TSharedRef< ISlateViewport > ViewportRef)
 
void UnsetViewport (TSharedRef< ISlateViewport > ViewportRef)
 
TSharedPtr< ISlateViewportGetViewport ()
 
SLATECORE_API FHittestGridGetHittestGrid ()
 
SLATECORE_API FWindowSizeLimits GetSizeLimits () const
 
SLATECORE_API void SetSizeLimits (const FWindowSizeLimits &InSizeLimits)
 
SLATECORE_API void SetAllowFastUpdate (bool bInAllowFastUpdate)
 
virtual SLATECORE_API void Tick (const FGeometry &AllottedGeometry, const double InCurrentTime, const float InDeltaTime) override
 
SLATECORE_API EVisibility GetWindowVisibility () const
 
SLATECORE_API TAttribute< FTextGetWindowCloseButtonToolTipText () const
 
SLATECORE_API void ProcessWindowInvalidation ()
 
- Public Member Functions inherited from SCompoundWidget
const FVector2D GetContentScale () const
 
void SetContentScale (TAttribute< FVector2D > InContentScale)
 
FLinearColor GetColorAndOpacity () const
 
void SetColorAndOpacity (TAttribute< FLinearColor > InColorAndOpacity)
 
void SetForegroundColor (TAttribute< FSlateColor > InForegroundColor)
 
virtual SLATECORE_API FChildrenGetChildren () override
 
virtual SLATECORE_API FSlateColor GetForegroundColor () const override
 
virtual SLATECORE_API void SetVisibility (TAttribute< EVisibility > InVisibility) override final
 
- Public Member Functions inherited from SWidget
SLATECORE_API int32 Paint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const
 
virtual SLATECORE_API void OnFocusLost (const FFocusEvent &InFocusEvent)
 
virtual SLATECORE_API void OnFocusChanging (const FWeakWidgetPath &PreviousFocusPath, const FWidgetPath &NewWidgetPath, const FFocusEvent &InFocusEvent)
 
virtual SLATECORE_API FReply OnKeyChar (const FGeometry &MyGeometry, const FCharacterEvent &InCharacterEvent)
 
virtual SLATECORE_API FReply OnPreviewKeyDown (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)
 
virtual SLATECORE_API FReply OnKeyDown (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)
 
virtual SLATECORE_API FReply OnKeyUp (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)
 
virtual SLATECORE_API FReply OnAnalogValueChanged (const FGeometry &MyGeometry, const FAnalogInputEvent &InAnalogInputEvent)
 
virtual SLATECORE_API FReply OnPreviewMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API void OnMouseEnter (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API void OnMouseLeave (const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API FReply OnMouseWheel (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API TOptional< TSharedRef< SWidget > > OnMapCursor (const FCursorReply &CursorReply) const
 
virtual SLATECORE_API FReply OnMouseButtonDoubleClick (const FGeometry &InMyGeometry, const FPointerEvent &InMouseEvent)
 
virtual SLATECORE_API FReply OnDragDetected (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API void OnDragEnter (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)
 
virtual SLATECORE_API void OnDragLeave (const FDragDropEvent &DragDropEvent)
 
virtual SLATECORE_API FReply OnDragOver (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)
 
virtual SLATECORE_API FReply OnDrop (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)
 
virtual SLATECORE_API FReply OnTouchGesture (const FGeometry &MyGeometry, const FPointerEvent &GestureEvent)
 
virtual SLATECORE_API FReply OnTouchStarted (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)
 
virtual SLATECORE_API FReply OnTouchMoved (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)
 
virtual SLATECORE_API FReply OnTouchEnded (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)
 
virtual SLATECORE_API FReply OnTouchForceChanged (const FGeometry &MyGeometry, const FPointerEvent &TouchEvent)
 
virtual SLATECORE_API FReply OnTouchFirstMove (const FGeometry &MyGeometry, const FPointerEvent &TouchEvent)
 
virtual SLATECORE_API FReply OnMotionDetected (const FGeometry &MyGeometry, const FMotionEvent &InMotionEvent)
 
virtual SLATECORE_API TOptional< boolOnQueryShowFocus (const EFocusCause InFocusCause) const
 
virtual SLATECORE_API TOptional< FVirtualPointerPositionTranslateMouseCoordinateForCustomHitTestChild (const SWidget &ChildWidget, const FGeometry &MyGeometry, const FVector2D ScreenSpaceMouseCoordinate, const FVector2D LastScreenSpaceMouseCoordinate) const
 
virtual SLATECORE_API void OnFinishedPointerInput ()
 
virtual SLATECORE_API void OnFinishedKeyInput ()
 
virtual SLATECORE_API FNavigationReply OnNavigation (const FGeometry &MyGeometry, const FNavigationEvent &InNavigationEvent)
 
virtual SLATECORE_API EWindowZone::Type GetWindowZoneOverride () const
 
bool NeedsPrepass () const
 
SLATECORE_API void SlatePrepass ()
 
SLATECORE_API void SlatePrepass (float InLayoutScaleMultiplier)
 
void SetCanTick (bool bInCanTick)
 
bool GetCanTick () const
 
bool HasRegisteredSlateAttribute () const
 
bool IsAttributesUpdatesEnabled () const
 
const FSlateWidgetPersistentStateGetPersistentState () const
 
const FWidgetProxyHandle GetProxyHandle () const
 
SLATECORE_API UE::Slate::FDeprecateVector2DResult GetDesiredSize () const
 
SLATECORE_API void AssignParentWidget (TSharedPtr< SWidget > InParent)
 
SLATECORE_API bool ConditionallyDetatchParentWidget (SWidget *InExpectedParent)
 
virtual bool ValidatePathToChild (SWidget *InChild)
 
bool IsParentValid () const
 
TSharedPtr< SWidgetGetParentWidget () const
 
TSharedPtr< SWidgetAdvanced_GetPaintParentWidget () const
 
SLATECORE_API FSlateRect CalculateCullingAndClippingRules (const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, bool &bClipToBounds, bool &bAlwaysClip, bool &bIntersectClipBounds) const
 
bool HasAnyUpdateFlags (EWidgetUpdateFlags FlagsToCheck) const
 
TStatId GetStatID (bool bForDeferredUse=false) const
 
virtual SLATECORE_API float GetRelativeLayoutScale (const int32 ChildIndex, float LayoutScaleMultiplier) const
 
SLATECORE_API void ArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren, bool bUpdateAttributes=false) const
 
virtual FChildrenGetAllChildren ()
 
virtual SLATECORE_API bool HasKeyboardFocus () const
 
SLATECORE_API TOptional< EFocusCauseHasUserFocus (int32 UserIndex) const
 
SLATECORE_API TOptional< EFocusCauseHasAnyUserFocus () const
 
SLATECORE_API bool HasUserFocusedDescendants (int32 UserIndex) const
 
SLATECORE_API bool HasFocusedDescendants () const
 
SLATECORE_API bool HasAnyUserFocusOrFocusedDescendants () const
 
SLATECORE_API bool HasMouseCapture () const
 
SLATECORE_API bool HasMouseCaptureByUser (int32 UserIndex, TOptional< int32 > PointerIndex=TOptional< int32 >()) const
 
virtual SLATECORE_API void OnMouseCaptureLost (const FCaptureLostEvent &CaptureLostEvent)
 
void SetEnabled (TAttribute< bool > InEnabledState)
 
bool IsEnabled () const
 
virtual bool IsInteractable () const
 
virtual SLATECORE_API TSharedPtr< IToolTipGetToolTip ()
 
virtual SLATECORE_API void OnToolTipClosing ()
 
SLATECORE_API void EnableToolTipForceField (const bool bEnableForceField)
 
bool HasToolTipForceField () const
 
bool IsHovered () const
 
SLATECORE_API bool IsDirectlyHovered () const
 
EVisibility GetVisibility () const
 
bool IsVolatile () const
 
bool IsVolatileIndirectly () const
 
void ForceVolatile (bool bForce)
 
bool ShouldInvalidatePrepassDueToVolatility ()
 
SLATECORE_API void Invalidate (EInvalidateWidgetReason InvalidateReason)
 
void CacheVolatility ()
 
void MarkPrepassAsDirty ()
 
float GetRenderOpacity () const
 
void SetRenderOpacity (float InRenderOpacity)
 
void SetTag (FName InTag)
 
const TOptional< FSlateRenderTransform > & GetRenderTransform () const
 
TOptional< FSlateRenderTransformGetRenderTransformWithRespectToFlowDirection () const
 
UE::Slate::FDeprecateVector2DResult GetRenderTransformPivotWithRespectToFlowDirection () const
 
void SetRenderTransform (TAttribute< TOptional< FSlateRenderTransform > > InTransform)
 
UE::Slate::FDeprecateVector2DResult GetRenderTransformPivot () const
 
void SetRenderTransformPivot (TAttribute< FVector2D > InTransformPivot)
 
SLATECORE_API void SetClipping (EWidgetClipping InClipping)
 
EWidgetClipping GetClipping () const
 
SLATECORE_API void SetPixelSnapping (EWidgetPixelSnapping InPixelSnappingMethod)
 
EWidgetPixelSnapping GetPixelSnapping () const
 
void SetCullingBoundsExtension (const FMargin &InCullingBoundsExtension)
 
FMargin GetCullingBoundsExtension () const
 
void SetFlowDirectionPreference (EFlowDirectionPreference InFlowDirectionPreference)
 
EFlowDirectionPreference GetFlowDirectionPreference () const
 
SLATECORE_API void SetToolTipText (const TAttribute< FText > &ToolTipText)
 
SLATECORE_API void SetToolTipText (const FText &InToolTipText)
 
SLATECORE_API void SetToolTip (const TAttribute< TSharedPtr< IToolTip > > &InToolTip)
 
SLATECORE_API void SetCursor (const TAttribute< TOptional< EMouseCursor::Type > > &InCursor)
 
template<typename MetaDataType >
TSharedPtr< MetaDataType > GetMetaData () const
 
template<typename MetaDataType >
TArray< TSharedRef< MetaDataType > > GetAllMetaData () const
 
template<typename MetaDataType >
void AddMetadata (const TSharedRef< MetaDataType > &AddMe)
 
template<typename MetaDataType >
int32 RemoveMetaData (const TSharedRef< MetaDataType > &RemoveMe)
 
SLATECORE_API void SetOnMouseButtonDown (FPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseButtonUp (FPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseMove (FPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseDoubleClick (FPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseEnter (FNoReplyPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseLeave (FSimpleNoReplyPointerEventHandler EventHandler)
 
SLATECORE_API FString GetTypeAsString () const
 
SLATECORE_API FName GetType () const
 
virtual SLATECORE_API FString GetReadableLocation () const
 
SLATECORE_API FName GetCreatedInLocation () const
 
virtual SLATECORE_API FName GetTag () const
 
virtual SLATECORE_API FSlateColor GetDisabledForegroundColor () const
 
SLATECORE_API const FGeometryGetCachedGeometry () const
 
SLATECORE_API const FGeometryGetTickSpaceGeometry () const
 
SLATECORE_API const FGeometryGetPaintSpaceGeometry () const
 
const TOptional< FSlateClippingState > & GetCurrentClippingState () const
 
SLATECORE_API TSharedRef< FActiveTimerHandleRegisterActiveTimer (float TickPeriod, FWidgetActiveTimerDelegate TickFunction)
 
SLATECORE_API void UnRegisterActiveTimer (const TSharedRef< FActiveTimerHandle > &ActiveTimerHandle)
 
bool HasActiveTimers () const
 
- Public Member Functions inherited from FSlateControlledConstruction
 FSlateControlledConstruction ()=default
 
virtual ~FSlateControlledConstruction ()=default
 
virtual const FSlateWidgetClassDataGetWidgetClass () const =0
 
void operator delete (void *mem)
 
- Public Member Functions inherited from TSharedFromThis< SWidget >
TSharedRef< SWidget, Mode > AsShared ()
 
TSharedRef< SWidget const, Mode > AsShared () const
 
TSharedRef< SubobjectType, Mode > AsSharedSubobject (SubobjectType *SubobjectPtr) const
 
TWeakPtr< SWidget, Mode > AsWeak ()
 
TWeakPtr< SWidget const, Mode > AsWeak () const
 
TWeakPtr< SubobjectType, Mode > AsWeakSubobject (SubobjectType *SubobjectPtr) const
 
void UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
 
void UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
 
UE_FORCEINLINE_HINT bool DoesSharedInstanceExist () const
 
- Public Member Functions inherited from FSlateInvalidationRoot
SLATECORE_API FSlateInvalidationRoot ()
 
virtual SLATECORE_API ~FSlateInvalidationRoot ()
 
virtual SLATECORE_API void AddReferencedObjects (FReferenceCollector &Collector) override
 
virtual SLATECORE_API FString GetReferencerName () const override
 
SLATECORE_API void InvalidateRootChildOrder (const SWidget *Investigator=nullptr)
 
SLATECORE_API void InvalidateRootLayout (const SWidget *Investigator=nullptr)
 
SLATECORE_API void InvalidateScreenPosition (const SWidget *Investigator=nullptr)
 
bool NeedsSlowPath () const
 
FHittestGridGetHittestGrid () const
 
FSlateCachedElementDataGetCachedElements ()
 
const FSlateCachedElementDataGetCachedElements () const
 
const SWidgetGetInvalidationRootWidget () const
 
FSlateInvalidationRootHandle GetInvalidationRootHandle () const
 
const FSlateInvalidationWidgetListGetFastPathWidgetList () const
 
SLATECORE_API const TSharedPtr< SWidgetGetFastPathWidgetListRoot () const
 
SLATECORE_API FSlateInvalidationResult PaintInvalidationRoot (const FSlateInvalidationContext &Context)
 
void OnWidgetDestroyed (const SWidget *Widget)
 
SLATECORE_API void Advanced_ResetInvalidation (bool bClearResourcesImmediately)
 
- Public Member Functions inherited from FGCObject
 FGCObject ()
 
 FGCObject (const FGCObject &Other)
 
 FGCObject (FGCObject &&Other)
 
 FGCObject (EFlags Flags)
 
virtual ~FGCObject ()
 
FGCObjectoperator= (const FGCObject &)
 
FGCObjectoperator= (FGCObject &&)
 
COREUOBJECT_API void RegisterGCObject ()
 
COREUOBJECT_API void UnregisterGCObject ()
 
virtual bool GetReferencerPropertyName (UObject *Object, FString &OutPropertyName) const
 

Additional Inherited Members

- Public Types inherited from SWindow
using FScopedWidgetSlotArguments = TPanelChildren< FPopupLayerSlot >::FScopedWidgetSlotArguments
 
- Public Types inherited from FGCObject
enum class  EFlags : uint32 { None = 0 , RegisterLater = 1 << 0 , AddStableNativeReferencesOnly = 1 << 1 }
 
- Static Public Member Functions inherited from SWindow
static SLATECORE_API TSharedRef< SWindowMakeToolTipWindow ()
 
static SLATECORE_API TSharedRef< SWindowMakeCursorDecorator ()
 
static SLATECORE_API TSharedRef< SWindowMakeStyledCursorDecorator (const FWindowStyle &InStyle)
 
static SLATECORE_API TSharedRef< SWindowMakeNotificationWindow ()
 
static SLATECORE_API UE::Slate::FDeprecateVector2DResult ComputeWindowSizeForContent (UE::Slate::FDeprecateVector2DParameter ContentSize)
 
- Static Public Member Functions inherited from FSlateControlledConstruction
static const FSlateWidgetClassDataStaticWidgetClass ()
 
- Static Public Member Functions inherited from FGCObject
static COREUOBJECT_API void StaticInit ()
 
- Public Attributes inherited from SWindow
EWindowZone::Type MoveResizeZone
 
UE::Slate::FDeprecateVector2DResult MoveResizeStart
 
FSlateRect MoveResizeRect
 
- Static Public Attributes inherited from FGCObject
static COREUOBJECT_API UGCObjectReferencerGGCObjectReferencer = nullptr
 
- Protected Member Functions inherited from SWindow
virtual SLATECORE_API TSharedRef< SWidgetMakeWindowTitleBar (const TSharedRef< SWindow > &Window, const TSharedPtr< SWidget > &CenterContent, EHorizontalAlignment CenterContentAlignment)
 
virtual SLATECORE_API EHorizontalAlignment GetTitleAlignment ()
 
SLATECORE_API void StartMorph ()
 
virtual SLATECORE_API bool CustomPrepass (float LayoutScaleMultiplier) override
 
SLATECORE_API void ConstructWindowInternals ()
 
SLATECORE_API EActiveTimerReturnType TriggerPlayMorphSequence (double InCurrentTime, float InDeltaTime)
 
SLATECORE_API void SetWindowBackground (const FSlateBrush *InWindowBackground)
 
SLATECORE_API void UpdateWindowContentVisibility ()
 
virtual SLATECORE_API TSharedRef< SWidgetGetRootWidget () override
 
virtual SLATECORE_API int32 PaintSlowPath (const FSlateInvalidationContext &InvalidationContext) override
 
- Protected Member Functions inherited from SCompoundWidget
TSlateAttributeRef< FVector2DGetContentScaleAttribute () const
 
TSlateAttributeRef< FLinearColorGetColorAndOpacityAttribute () const
 
TSlateAttributeRef< FSlateColorGetForegroundColorAttribute () const
 
SLATECORE_API SCompoundWidget ()
 
virtual SLATECORE_API ~SCompoundWidget ()
 
- Protected Member Functions inherited from SWidget
void SetVolatilePrepass (bool bVolatile)
 
virtual SLATECORE_API void CacheDesiredSize (float InLayoutScaleMultiplier)
 
void SetHover (TAttribute< bool > InHovered)
 
bool IsChildWidgetCulled (const FSlateRect &, const FArrangedWidget &) const
 
SLATECORE_API void InvalidateChildRemovedFromTree (SWidget &Child)
 
bool Advanced_InvalidateVolatility ()
 
EFlowDirection ComputeFlowDirection () const
 
SLATECORE_API void SetDebugInfo (const ANSICHAR *InType, const ANSICHAR *InFile, int32 OnLine, size_t InAllocSize)
 
virtual SLATECORE_API TOptional< EMouseCursor::TypeGetCursor () const
 
SLATECORE_API SWidget ()
 
SLATECORE_API void SWidgetConstruct (const FSlateBaseNamedArgs &Args)
 
bool IsConstructed () const
 
SLATECORE_API bool FindChildGeometries (const FGeometry &MyGeometry, const TSet< TSharedRef< SWidget > > &WidgetsToFind, TMap< TSharedRef< SWidget >, FArrangedWidget > &OutResult) const
 
SLATECORE_API void FindChildGeometries_Helper (const FGeometry &MyGeometry, const TSet< TSharedRef< SWidget > > &WidgetsToFind, TMap< TSharedRef< SWidget >, FArrangedWidget > &OutResult) const
 
SLATECORE_API FGeometry FindChildGeometry (const FGeometry &MyGeometry, TSharedRef< SWidget > WidgetToFind) const
 
bool ShouldBeEnabled (bool InParentEnabled) const
 
virtual SLATECORE_API const FSlateBrushGetFocusBrush () const
 
virtual SLATECORE_API void OnClippingChanged ()
 
float GetPrepassLayoutScaleMultiplier () const
 
SLATECORE_API void Prepass_ChildLoop (float InLayoutScaleMultiplier, FChildren *MyChildren)
 
template<typename TargetValueType , typename SourceValueType >
bool SetAttribute (TAttribute< TargetValueType > &TargetValue, const TAttribute< SourceValueType > &SourceValue, EInvalidateWidgetReason BaseInvalidationReason)
 
TSlateAttributeRef< boolGetEnabledStateAttribute () const
 
TSlateAttributeRef< boolGetHoveredAttribute () const
 
TSlateAttributeRef< EVisibilityGetVisibilityAttribute () const
 
TSlateAttributeRef< TOptional< FSlateRenderTransform > > GetRenderTransformAttribute () const
 
TSlateAttributeRef< FVector2DGetRenderTransformPivotAttribute () const
 
virtual SLATECORE_API ~SWidget ()
 
- Protected Member Functions inherited from TSharedFromThis< SWidget >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThisoperator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 
- Protected Member Functions inherited from FSlateInvalidationRoot
void SetInvalidationRootWidget (SWidget &InInvalidationRootWidget)
 
void SetInvalidationRootHittestGrid (FHittestGrid &InHittestGrid)
 
int32 GetCachedMaxLayerId () const
 
SLATECORE_API bool ProcessInvalidation ()
 
SLATECORE_API void ClearAllFastPathData (bool bClearResourcesImmediately)
 
virtual void OnRootInvalidated ()
 
SLATECORE_API void SetNeedsSlowPath (bool InNeedsSlowPath)
 
- Protected Member Functions inherited from FNoncopyable
 FNoncopyable ()
 
 ~FNoncopyable ()
 
- Static Protected Member Functions inherited from SWidget
static SLATECORE_API int32 FindChildUnderMouse (const FArrangedChildren &Children, const FPointerEvent &MouseEvent)
 
static SLATECORE_API int32 FindChildUnderPosition (const FArrangedChildren &Children, const UE::Slate::FDeprecateVector2DParameter &ArrangedSpacePosition)
 
static TAttribute< EVisibilityAccessWidgetVisibilityAttribute (const TSharedRef< SWidget > &Widget)
 
- Static Protected Member Functions inherited from TSharedFromThis< SWidget >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode > SharedThis (OtherType *ThisPtr)
 
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode > SharedThis (const OtherType *ThisPtr)
 
- Protected Attributes inherited from SWindow
EWindowType Type
 
TAttribute< FTextTitle
 
TAttribute< FTextCloseButtonToolTipText
 
bool bDragAnywhere
 
float Opacity
 
ESizingRule SizingRule
 
EAutoCenter AutoCenterRule
 
EWindowTransparency TransparencySupport
 
bool bCreateTitleBar: 1
 
bool bIsPopupWindow: 1
 
bool bIsTopmostWindow: 1
 
bool bSizeWillChangeOften: 1
 
bool bInitiallyMaximized: 1
 
bool bInitiallyMinimized: 1
 
bool bHasEverBeenShown: 1
 
bool bFocusWhenFirstShown: 1
 
bool bHasOSWindowBorder: 1
 
bool bVirtualWindow: 1
 
bool bHasCloseButton: 1
 
bool bHasMinimizeButton: 1
 
bool bHasMaximizeButton: 1
 
bool bHasSizingFrame: 1
 
bool bIsModalWindow: 1
 
bool bIsMirrorWindow: 1
 
bool bShouldPreserveAspectRatio: 1
 
bool bIsHDR: 1
 
bool bManualManageDPI: 1
 
bool bAllowFastUpdate: 1
 
bool bAcceptsInput: 1
 
EWindowActivationPolicy WindowActivationPolicy
 
UE::Slate::FDeprecateVector2DResult InitialDesiredScreenPosition
 
UE::Slate::FDeprecateVector2DResult InitialDesiredSize
 
UE::Slate::FDeprecateVector2DResult ScreenPosition
 
UE::Slate::FDeprecateVector2DResult PreFullscreenPosition
 
UE::Slate::FDeprecateVector2DResult Size
 
UE::Slate::FDeprecateVector2DResult ViewportSize
 
TWeakPtr< ISlateViewportViewport
 
float ViewportScaleUIOverride
 
float TitleBarSize
 
struct SWindow::FMorpher Morpher
 
EWindowZone::Type WindowZone
 
TSharedPtr< SWidgetTitleArea
 
SVerticalBox::FSlotContentSlot
 
TWeakPtr< SWidgetWidgetToFocusOnActivate
 
TWeakPtr< SWidgetWidgetFocusedOnDeactivate
 
FWindowSizeLimits SizeLimits
 
TSharedPtr< FGenericWindowNativeWindow
 
TUniquePtr< FHittestGridHittestGrid
 
FOnWindowActivated OnWindowActivated
 
FOnWindowActivatedEvent WindowActivatedEvent
 
FOnWindowDeactivated OnWindowDeactivated
 
FOnWindowDeactivatedEvent WindowDeactivatedEvent
 
FOnWindowClosed OnWindowClosed
 
FOnWindowClosedEvent WindowClosedEvent
 
FOnWindowMoved OnWindowMoved
 
FRequestDestroyWindowOverride RequestDestroyWindowOverride
 
TSharedPtr< SOverlayWindowOverlay
 
TSharedPtr< class SPopupLayerPopupLayer
 
TSharedPtr< SWidgetFullWindowOverlayWidget
 
TWeakPtr< SWindowParentWindowPtr
 
TArray< TSharedRef< SWindow > > ChildWindows
 
FOnSwitchWorldHack OnWorldSwitchHack
 
bool bShouldShowWindowContentDuringOverlay
 
int32 ExpectedMaxWidth
 
int32 ExpectedMaxHeight
 
int32 FocusUserIndex
 
TSharedPtr< IWindowTitleBarTitleBar
 
FMargin LayoutBorder
 
FMargin UserResizeBorder
 
bool bIsDrawingEnabled
 
- Protected Attributes inherited from SCompoundWidget
FCompoundWidgetOneChildSlot ChildSlot
 
- Protected Attributes inherited from SWidget
uint8 bCanSupportFocus: 1
 
uint8 bCanHaveChildren: 1
 
uint8 bClippingProxy: 1
 
uint8 bHasCustomPrepass: 1
 
uint8 bHasRelativeLayoutScale: 1
 
uint8 bVolatilityAlwaysInvalidatesPrepass: 1
 
EWidgetClipping Clipping
 
EWidgetPixelSnapping PixelSnappingMethod
 
FMargin CullingBoundsExtension
 
float RenderOpacity
 

Member Function Documentation

◆ Advanced_IsInvalidationRoot()

bool SVirtualWindow::Advanced_IsInvalidationRoot ( ) const
overridevirtual

Reimplemented from SWindow.

◆ ComputeDesiredSize()

FVector2D SVirtualWindow::ComputeDesiredSize ( float  LayoutScaleMultiplier) const
overridevirtual

The window's desired size takes into account the ratio between the slate units and the pixel size

Reimplemented from SWindow.

◆ Construct()

void SVirtualWindow::Construct ( const FArguments &  InArgs)

◆ OnArrangeChildren()

void SVirtualWindow::OnArrangeChildren ( const FGeometry AllottedGeometry,
FArrangedChildren ArrangedChildren 
) const
overridevirtual

Compute the Geometry of all the children and add populate the ArrangedChildren list with their values. Each type of Layout panel should arrange children based on desired behavior.

Parameters
AllottedGeometryThe geometry allotted for this widget by its parent.
ArrangedChildrenThe array to which to add the WidgetGeometries that represent the arranged children.

Reimplemented from SCompoundWidget.

◆ OnPaint()

int32 SVirtualWindow::OnPaint ( const FPaintArgs Args,
const FGeometry AllottedGeometry,
const FSlateRect MyCullingRect,
FSlateWindowElementList OutDrawElements,
int32  LayerId,
const FWidgetStyle InWidgetStyle,
bool  bParentEnabled 
) const
overridevirtual

The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children. Called by the non-virtual OnPaint to enforce pre/post conditions during OnPaint.

Parameters
ArgsAll the arguments necessary to paint this widget (
AllottedGeometryThe FGeometry that describes an area in which the widget should appear.
MyCullingRectThe rectangle representing the bounds currently being used to completely cull widgets. Unless IsChildWidgetCulled(...) returns true, you should paint the widget.
OutDrawElementsA list of FDrawElements to populate with the output.
LayerIdThe Layer onto which this widget should be rendered.
InColorAndOpacityColor and Opacity to be applied to all the descendants of the widget being painted
bParentEnabledTrue if the parent of this widget is enabled.
Returns
The maximum layer ID attained by this widget or any of its children.

Reimplemented from SWindow.

◆ OnQueryPopupMethod()

FPopupMethodReply SVirtualWindow::OnQueryPopupMethod ( ) const
overridevirtual

Popups can manifest in a NEW OS WINDOW or via an OVERLAY in an existing window. This can be set explicitly on SMenuAnchor, or can be determined by a scoping widget. A scoping widget can reply to OnQueryPopupMethod() to drive all its descendants' poup methods.

e.g. Fullscreen games cannot summon a new window, so game SViewports will reply with EPopupMethod::UserCurrentWindow. This makes all the menu anchors within them use the current window.

Reimplemented from SWidget.

◆ OnVisualizeTooltip()

bool SVirtualWindow::OnVisualizeTooltip ( const TSharedPtr< SWidget > &  TooltipContent)
overridevirtual

Called when Slate wants to visualize tooltip. If nobody handles this event, Slate will use default tooltip visualization. If you override this event, you should probably return true.

Parameters
TooltipContentThe TooltipContent that I may want to visualize.
Returns
true if this widget visualized the tooltip content; i.e., the event is handled.

Reimplemented from SWidget.

◆ SetIsFocusable()

void SVirtualWindow::SetIsFocusable ( bool  bFocusable)

◆ SetShouldResolveDeferred()

void SVirtualWindow::SetShouldResolveDeferred ( bool  bResolve)

We allow users to control the resolve policy for deferred content. When a virtual window is used in a retainer, we don't want it trying to resolve the deferred content, we instead need it to pass that content up to the non-retained window drawing the retainer. If a virtual window is used in a case like the WidgetComponent, we always want to resolve the deferred content because there won't be another opportunity since the 3D widget has no owner window that can draw it.

◆ SupportsKeyboardFocus()

bool SVirtualWindow::SupportsKeyboardFocus ( ) const
overridevirtual

Checks to see if this widget supports keyboard focus. Override this in derived classes.

Returns
True if this widget can take keyboard focus

Reimplemented from SWindow.


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