1. Epic GamesDeveloper
  3. SSidebarContainer

SSidebarContainer

A container for a sidebar widget that manages the slider drawer overlay widgets and a default docking location for all drawers.

API > API/Developer > API/Developer/ToolWidgets

A container for a sidebar widget that manages the slider drawer overlay widgets and a default docking location for all drawers.

   
Name SSidebarContainer
Type class
Header File /Engine/Source/Developer/ToolWidgets/Public/Sidebar/SSidebarContainer.h
Include Path #include "Sidebar/SSidebarContainer.h"

Syntax

class SSidebarContainer : public SCompoundWidget

Inheritance Hierarchy

Structs

Name Remarks
FArguments  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void CloseAllDrawerWidgets ( const bool bInAnimate
)

   Sidebar/SSidebarContainer.h  

void Construct ( const FArguments& InArgs
)

   Sidebar/SSidebarContainer.h  

float GetContentSlotSize()

   Sidebar/SSidebarContainer.h  

float GetCurrentDrawerSize()

   Sidebar/SSidebarContainer.h  

FName GetOpenedDrawerId()

   Sidebar/SSidebarContainer.h  

UE::Slate::FDeprecateVector2DResult GetOverlaySize()

   Sidebar/SSidebarContainer.h  

float GetSidebarSlotSize()

   Sidebar/SSidebarContainer.h  

EOrientation GetSplitterOrientation()

   Sidebar/SSidebarContainer.h  

ESidebarTabLocation GetTabLocation()

   Sidebar/SSidebarContainer.h  

void RebuildSidebar ( const TSharedRef< SSidebar >& InSidebarWidget,
const FSidebarState& InState
)

   Sidebar/SSidebarContainer.h  
Reopens the pinned tab only if there are no other open drawers. Sidebar/SSidebarContainer.h  

void UpdateDrawerTabAppearance()

 Updates the appearance of drawer tabs. Sidebar/SSidebarContainer.h  

Protected

Name Remarks Include Path Unreal Specifiers

void AddContentDockSlot()

   Sidebar/SSidebarContainer.h  

bool AddDrawerOverlaySlot ( const TSharedRef< FSidebarDrawer >& InDrawer
)

   Sidebar/SSidebarContainer.h  

void AddSidebarDockSlot ( const FName InDockDrawerId
)

   Sidebar/SSidebarContainer.h  

FMargin CalculateSlotMargin()

   Sidebar/SSidebarContainer.h  

void CloseDrawer_Internal ( const TSharedRef< FSidebarDrawer >& InDrawer,
const bool bInAnimate,
const bool bInSummonPinnedTabIfNothingOpened
)

   Sidebar/SSidebarContainer.h  

TSharedRef< SWidget > ConstructBoxPanel ( const FSidebarState& InState
)

   Sidebar/SSidebarContainer.h  

void ConstructSplitterPanel ( const FSidebarState& InState
)

   Sidebar/SSidebarContainer.h  

void CreateDrawerWidget ( const TSharedRef< FSidebarDrawer >& InDrawer
)

   Sidebar/SSidebarContainer.h  

void DockDrawer_Internal ( const TSharedRef< FSidebarDrawer >& InDrawer
)

   Sidebar/SSidebarContainer.h  

TSharedPtr< FSidebarDrawer > FindDrawer ( const FName InDrawerId
) const

   Sidebar/SSidebarContainer.h  

TSharedPtr< FSidebarDrawer > FindFirstPinnedTab()

   Sidebar/SSidebarContainer.h  

TSharedPtr< SSidebarDrawer > FindOpenDrawerWidget ( const TSharedRef< FSidebarDrawer >& InDrawer
) const

   Sidebar/SSidebarContainer.h  

int32 GetContentSlotIndex()

   Sidebar/SSidebarContainer.h  

TSharedPtr< FSidebarDrawer > GetForegroundDrawer()

   Sidebar/SSidebarContainer.h  

TSharedRef< SWidget > GetSidebarDrawerContent ( const TSharedRef< FSidebarDrawer >& InDrawer
) const

   Sidebar/SSidebarContainer.h  

int32 GetSidebarSlotIndex()

   Sidebar/SSidebarContainer.h  

void OnCloseAnimationFinish ( const TSharedRef< SSidebarDrawer >& InDrawerWidget
)

   Sidebar/SSidebarContainer.h  

void OnContentSlotResizing ( const float InFillPercent
)

 Event that occurs when the docked main content slot is being resized by the user (while mouse down). Sidebar/SSidebarContainer.h  

void OnDrawerSizeChanged ( const TSharedRef< SSidebarDrawer >& InDrawerWidget,
const float InNewPixelSize
)

   Sidebar/SSidebarContainer.h  

void OnOpenAnimationFinish ( const TSharedRef< SSidebarDrawer >& InDrawerWidget
)

   Sidebar/SSidebarContainer.h  

EActiveTimerReturnType OnOpenPendingDrawerTimer ( const double InCurrentTime,
const float InDeltaTime
)

   Sidebar/SSidebarContainer.h  

void OnSidebarSlotResizing ( const float InFillPercent
)

 Event that occurs when the docked sidebar slot is being resized by the user (while mouse down). Sidebar/SSidebarContainer.h  

void OnSplitterResized()

 Event that occurs when the main splitter widget has finished being resized by the user (mouse up). Sidebar/SSidebarContainer.h  

void OnTabDrawerFocusLost ( const TSharedRef< SSidebarDrawer >& InDrawerWidget
)

   Sidebar/SSidebarContainer.h  

void OpenDrawer_Internal ( const TSharedRef< FSidebarDrawer >& InDrawer,
const bool bInAnimate
)

   Sidebar/SSidebarContainer.h  

void OpenDrawerNextFrame ( const TSharedRef< FSidebarDrawer >& InDrawer,
const bool bInAnimate
)

   Sidebar/SSidebarContainer.h  

void Reconstruct ( const FSidebarState& InState
)

   Sidebar/SSidebarContainer.h  

void RemoveContentDockSlot()

   Sidebar/SSidebarContainer.h  

bool RemoveDrawerOverlaySlot ( const TSharedRef< FSidebarDrawer >& InDrawer,
const bool bInAnimate
)

   Sidebar/SSidebarContainer.h  

void RemoveSidebarDockSlot()

   Sidebar/SSidebarContainer.h  

void UndockDrawer_Internal ( const TSharedRef< FSidebarDrawer >& InDrawer
)

   Sidebar/SSidebarContainer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page