Navigation
API > API/Developer > API/Developer/ToolWidgets
Static sidebar tab widget that cannot be dragged or moved to a different location. Multiple drawers can be registered to a single sidebar and each drawer can have its own sections, each of which can be displayed single, in combination, or all together through buttons at the top of the drawer.
| Name | SSidebar |
| Type | class |
| Header File | /Engine/Source/Developer/ToolWidgets/Public/Sidebar/SSidebar.h |
| Include Path | #include "Sidebar/SSidebar.h" |
Syntax
class SSidebar : public SCompoundWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SSidebar
- FSlateControlledConstruction → SWidget → SCompoundWidget → SSidebar
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~SSidebar() |
Sidebar/SSidebar.h |
Structs
| Name | Remarks |
|---|---|
| FArguments |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| MaxTabButtonSize | float | Sidebar/SSidebar.h | |
| MinTabButtonSize | float | Sidebar/SSidebar.h | |
| TabButtonThickness | float | Sidebar/SSidebar.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bAlwaysUseMaxButtonSize | bool | Sidebar/SSidebar.h | ||
| bDisableDock | bool | Sidebar/SSidebar.h | ||
| bDisablePin | bool | Sidebar/SSidebar.h | ||
| bHideWhenAllDocked | bool | Sidebar/SSidebar.h | ||
| ContainerWidgetWeak | TWeakPtr< SSidebarContainer > | Sidebar/SSidebar.h | ||
| Drawers | TArray< TSharedRef< FSidebarDrawer > > | Sidebar/SSidebar.h | ||
| OnGetContent | FOnGetContent | Sidebar/SSidebar.h | ||
| OnStateChanged | FOnSidebarStateChanged | Sidebar/SSidebar.h | ||
| TabButtonContainer | TSharedPtr< SScrollBox > | Sidebar/SSidebar.h | ||
| TabLocation | ESidebarTabLocation | Sidebar/SSidebar.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CloseAllDrawers
(
const bool bInAnimate |
Closes any drawers that are open. | Sidebar/SSidebar.h | |
void Construct
(
const FArguments& InArgs, |
Constructs the sidebar widget. | Sidebar/SSidebar.h | |
bool ContainsDrawer
(
const FName InDrawerId |
Checks if a drawer exists in the sidebar. | Sidebar/SSidebar.h | |
| Checks if a drawer section exists within a sidebar drawer. | Sidebar/SSidebar.h | ||
TSet< FName > GetDockedDrawerIds() |
Sidebar/SSidebar.h | ||
int32 GetDrawerCount() |
Sidebar/SSidebar.h | ||
TSharedRef< SWidget > GetMainContent() |
Sidebar/SSidebar.h | ||
FName GetOpenedDrawerId() |
Sidebar/SSidebar.h | ||
TSet< FName > GetPinnedDrawerIds() |
Sidebar/SSidebar.h | ||
FSidebarState GetState() |
Sidebar/SSidebar.h | ||
ESidebarTabLocation GetTabLocation() |
Sidebar/SSidebar.h | ||
bool HasDrawerDocked() |
Sidebar/SSidebar.h | ||
bool HasDrawerOpened() |
Sidebar/SSidebar.h | ||
bool HasDrawerPinned() |
Sidebar/SSidebar.h | ||
bool IsDrawerDocked
(
const FName InDrawerId |
Sidebar/SSidebar.h | ||
bool IsDrawerOpened
(
const FName InDrawerId |
Checks if a drawer is opened. | Sidebar/SSidebar.h | |
bool IsDrawerPinned
(
const FName InDrawerId |
Checks if a drawer is pinned. | Sidebar/SSidebar.h | |
bool IsHorizontal() |
Sidebar/SSidebar.h | ||
bool IsVertical() |
Sidebar/SSidebar.h | ||
void RebuildDrawer
(
const FName InDrawerId, |
Rebuilds a drawer's content (unless it has been overriden). | Sidebar/SSidebar.h | |
bool RegisterDrawer
(
FSidebarDrawerConfig&& InDrawerConfig |
Registers and displays a new drawer in the sidebar. | Sidebar/SSidebar.h | |
bool RegisterDrawerSection
(
const FName InDrawerId, |
Registers and displays a new drawer section in the sidebar. | Sidebar/SSidebar.h | |
void SetDrawerDocked
(
const FName InDrawerId, |
Docks a drawer so it embeds itself into the content. | Sidebar/SSidebar.h | |
void SetDrawerPinned
(
const FName InDrawerId, |
Pins a drawer so it stays open even when focus is lost. | Sidebar/SSidebar.h | |
bool TryOpenDrawer
(
const FName InDrawerId |
Attempt to open a specific drawer in the sidebar. | Sidebar/SSidebar.h | |
void UndockAllDrawers() |
Undocks any drawers that are docked. | Sidebar/SSidebar.h | |
void UnpinAllDrawers() |
Unpins any drawers that are pinned. | Sidebar/SSidebar.h | |
bool UnregisterDrawer
(
const FName InDrawerId |
Unregisters and removes a drawer from the sidebar. | Sidebar/SSidebar.h | |
| Unregisters and removes a drawer section from the sidebar. | Sidebar/SSidebar.h |