FSlateWindowHelper Class Reference

#include <SlateWindowHelper.h>

Static Public Member Functions
static SLATECORE_API void	ArrangeWindowToFront (TArray< TSharedRef< SWindow > > &Windows, const TSharedRef< SWindow > &WindowToBringToFront)
static SLATECORE_API void	BringWindowToFront (TArray< TSharedRef< SWindow > > &Windows, const TSharedRef< SWindow > &BringMeToFront)
static SLATECORE_API bool	CheckWorkAreaForWindows (const TArray< TSharedRef< SWindow > > &WindowsToSearch, const FSlateRect &WorkAreaRect)
static SLATECORE_API bool	ContainsWindow (const TArray< TSharedRef< SWindow > > &WindowsToSearch, const TSharedRef< SWindow > &WindowToFind)
static SLATECORE_API bool	FindPathToWidget (const TArray< TSharedRef< SWindow > > &WindowsToSearch, TSharedRef< const SWidget > InWidget, FWidgetPath &OutWidgetPath, EVisibility VisibilityFilter=EVisibility::Visible)
static SLATECORE_API TSharedPtr< SWindow >	FindWindowByPlatformWindow (const TArray< TSharedRef< SWindow > > &WindowsToSearch, const TSharedRef< FGenericWindow > &PlatformWindow)
static SLATECORE_API void	RemoveWindowFromList (TArray< TSharedRef< SWindow > > &Windows, const TSharedRef< SWindow > &WindowToRemove)

Static Protected Member Functions
static SLATECORE_API TSharedRef< SWindow >	BringToFrontInParent (const TSharedRef< SWindow > &WindowToBringToFront)

Detailed Description

Implements a manager for Slate windows.

Member Function Documentation

ArrangeWindowToFront()

void FSlateWindowHelper::ArrangeWindowToFront ( TArray< TSharedRef< SWindow > > &  Windows, const TSharedRef< SWindow > &  WindowToBringToFront  )

static

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

Parameters

Windows	The collection of windows to reorder.
WindowToBringToFront	The window to bring to the front.

BringToFrontInParent()

TSharedRef< SWindow > FSlateWindowHelper::BringToFrontInParent ( const TSharedRef< SWindow > &  WindowToBringToFront )

staticprotected

Make BringMeToFront first among its peers. i.e. make it the last window in its parent's list of child windows.

Returns

The top-most window whose children were re-arranged

BringWindowToFront()

void FSlateWindowHelper::BringWindowToFront ( TArray< TSharedRef< SWindow > > &  Windows, const TSharedRef< SWindow > &  BringMeToFront  )

static

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

The top-most (front-most) window is last in Z-order and therefore is added to the end of the list.

Parameters

Windows	An ordered list of windows.
BingMeToFront	The window to bring to front.

CheckWorkAreaForWindows()

bool FSlateWindowHelper::CheckWorkAreaForWindows ( const TArray< TSharedRef< SWindow > > &  WindowsToSearch, const FSlateRect &  WorkAreaRect  )

static

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

Parameters

WindowsToSearch	The collection of windows to check.
WorkAreaRect	The work area to check.

Returns

true if at least one window overlaps with the work area, false otherwise.

ContainsWindow()

bool FSlateWindowHelper::ContainsWindow ( const TArray< TSharedRef< SWindow > > &  WindowsToSearch, const TSharedRef< SWindow > &  WindowToFind  )

static

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

Parameters

WindowsToSearch	The collection of windows to search.
WindowToFind	The window to find.

Returns

true if the collection contains the window, false otherwise.

FindPathToWidget()

bool FSlateWindowHelper::FindPathToWidget ( const TArray< TSharedRef< SWindow > > &  WindowsToSearch, TSharedRef< const SWidget >  InWidget, FWidgetPath &  OutWidgetPath, EVisibility  VisibilityFilter = EVisibility::Visible  )

static

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

Note: this is a relatively slow operation!

Parameters

InWidget	Widget to generate a path to.
OutWidgetPath	The generated widget path.
VisibilityFilter	Widgets must have this type of visibility to be included the path.

Returns

True if the widget path was found.

FindWindowByPlatformWindow()

TSharedPtr< SWindow > FSlateWindowHelper::FindWindowByPlatformWindow ( const TArray< TSharedRef< SWindow > > &  WindowsToSearch, const TSharedRef< FGenericWindow > &  PlatformWindow  )

static

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

Parameters

WindowsToSearch	The collection of windows to search.
PlatformWindow	The platform window to find the Slate window for.

Returns

The corresponding Slate window, or nullptr if it was not found.

RemoveWindowFromList()

void FSlateWindowHelper::RemoveWindowFromList ( TArray< TSharedRef< SWindow > > &  Windows, const TSharedRef< SWindow > &  WindowToRemove  )

static

Removes the specified window from the given collection of windows.

Parameters

Windows	The collection of windows.
WindowToRemove	The window to remove.

---

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

• Engine/Source/Runtime/SlateCore/Public/Application/SlateWindowHelper.h
• Engine/Source/Runtime/SlateCore/Private/Application/SlateWindowHelper.cpp