FSlateWindowHelper

Implements a manager for Slate windows.

Choose your operating system:

Windows

macOS

Linux

References

Module

SlateCore

Header

/Engine/Source/Runtime/SlateCore/Public/Application/SlateWindowHelper.h

Include

#include "Application/SlateWindowHelper.h"

Syntax

class FSlateWindowHelper

Remarks

Implements a manager for Slate windows.

Functions

Name Description

Public function Static

void

 

ArrangeWindowToFront

(
    TArray< TSharedRef< SWindow >>& Wi...,
    const TSharedRef< SWindow >& Windo...
)

Reorders the given collection of windows so the specified window is brought to the front.

Protected function Static

TSharedRef< ...

 

BringToFrontInParent

(
    const TSharedRef< SWindow >& Windo...
)

Make BringMeToFront first among its peers.

Public function Static

void

 

BringWindowToFront

(
    TArray< TSharedRef< SWindow >>& Wi...,
    const TSharedRef< SWindow >& Bring...
)

Put 'BringMeToFront' at the font of the list of 'WindowsToReorder'.

Public function Static

bool

 

CheckWorkAreaForWindows

(
    const TArray< TSharedRef< SWindow >...,
    const FSlateRect& WorkAreaRect
)

Checks whether any of the given windows overlap the specified work area.

Public function Static

bool

 

ContainsWindow

(
    const TArray< TSharedRef< SWindow >...,
    const TSharedRef< SWindow >& Windo...
)

Checks whether the given collection of windows contains the specified window.

Public function Static

bool

 

FindPathToWidget

(
    const TArray< TSharedRef< SWindow >...,
    TSharedRef< const SWidget > InWidge...,
    FWidgetPath& OutWidgetPath,
    EVisibility VisibilityFilter
)

Searches for the specified widget and generates a full path to it.

Public function Static

TSharedPtr< ...

 

FindWindowByPlatformWindow

(
    const TArray< TSharedRef< SWindow >...,
    const TSharedRef< FGenericWindow > ...
)

Searches the given collection of windows to find the Slate window that corresponds to the specified platform window.

Public function Static

void

 

RemoveWindowFromList

(
    TArray< TSharedRef< SWindow >>& Wi...,
    const TSharedRef< SWindow >& Windo...
)

Removes the specified window from the given collection of windows.