1. Epic GamesDeveloper
  3. UStatusBarSubsystem

UStatusBarSubsystem

API > API/Editor > API/Editor/StatusBar

   
Name UStatusBarSubsystem
Type class
Header File /Engine/Source/Editor/StatusBar/Public/StatusBarSubsystem.h
Include Path #include "StatusBarSubsystem.h"

Syntax

UCLASS ()  
class UStatusBarSubsystem :  
    public UEditorSubsystem,  
    public IProgressNotificationHandler

Inheritance Hierarchy

Implements Interfaces

Constants

Name Type Remarks Include Path
MessageHandleCounter int32   StatusBarSubsystem.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
GlobalStatusBarExtensions TArray< TUniquePtr< IGlobalStatusBarExtension > >   StatusBarSubsystem.h  
PreviousKeyboardFocusedWidget TWeakPtr< SWidget >   StatusBarSubsystem.h  
StatusBarContentBrowser TSharedPtr< SWidget > The floating content browser that is opened via the content browser button in the status bar StatusBarSubsystem.h  
StatusBarOutputLog TSharedPtr< SWidget >   StatusBarSubsystem.h  
StatusBars TMap< FName, FStatusBarData >   StatusBarSubsystem.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool ActiveWindowBehindNotificationHasStatusBar()

   StatusBarSubsystem.h  

bool ActiveWindowHasStatusBar()

   StatusBarSubsystem.h  

void ClearStatusBarMessages ( FName StatusBarName
)

 Removes all messages from the status bar StatusBarSubsystem.h  

virtual void Deinitialize()

 Internal cleanup StatusBarSubsystem.h  

bool DismissContentBrowserDrawer()

 Closes the content browser drawer for a status bar residing in the active window StatusBarSubsystem.h  
Forces all drawers to dismiss. StatusBarSubsystem.h  

virtual void Initialize ( FSubsystemCollectionBase& Collection
)

 Prepares for use StatusBarSubsystem.h  

TSharedRef< SWidget > MakeStatusBarWidget ( FName UniqueStatusBarName,
const TSharedRef< SDockTab >& InParentTab,
UE::Editor::Toolbars::ECreateStatusBarOptions CreateStatusBarOptions
)

 Creates a new instance of a status bar widget StatusBarSubsystem.h  

bool OpenContentBrowserDrawer()

 Opens the content browser drawer for a status bar residing in the active window StatusBarSubsystem.h  

bool OpenOutputLogDrawer()

 Opens the output log drawer for a status bar residing in the active window StatusBarSubsystem.h  

void PopStatusBarMessage ( FName StatusBarName,
FStatusBarMessageHandle InHandle
)

 Removes a message from the status bar. StatusBarSubsystem.h  

FStatusBarMessageHandle PushStatusBarMessage ( FName StatusBarName,
const TAttribute< FText >& InMessage
)

   StatusBarSubsystem.h  

FStatusBarMessageHandle PushStatusBarMessage ( FName StatusBarName,
const TAttribute< FText >& InMessage,
const TAttribute< FText >& InHintText
)

 Pushes a new status bar message StatusBarSubsystem.h  

void RegisterDrawer ( FName StatusBarName,
FWidgetDrawerConfig&& Drawer,
int32 SlotIndex
)

 Creates a new instance of a status bar widget StatusBarSubsystem.h  

IGlobalStatusBarExtension & RegisterGlobalStatusBarExtension ( TUniquePtr< IGlobalStatusBarExtension >&& Extension
)

 Registers a new global status bar extension. StatusBarSubsystem.h  

bool ToggleContentBrowserDrawer()

 Opens or closes the content browser drawer for a status bar residing in the active window StatusBarSubsystem.h  

bool ToggleDebugConsole ( TSharedRef< SWindow > ParentWindow,
bool bAlwaysToggleDrawer
)

 Focuses the debug console or opens the output log drawer on the status bar for status bar residing in the passed in parent window StatusBarSubsystem.h  

bool TryToggleDrawer ( const FName DrawerId
)

 Tries to toggle the given drawer StatusBarSubsystem.h  

void UnregisterDrawer ( FName StatusBarName,
FName DrawerId
)

 Unregisters and destroys the drawer with the given DrawerId StatusBarSubsystem.h  

TUniquePtr< IGlobalStatusBarExtension > UnregisterGlobalStatusBarExtension ( IGlobalStatusBarExtension* Extension
)

 Unregisters an existing status bar extension. StatusBarSubsystem.h  

Static

Name Remarks Include Path Unreal Specifiers

static const FString GetOneTimeStateWithFallback ( const FString StoreId,
const FString SectionName,
const FString KeyName,
const FString FallbackIniLocation,
const FString FallbackIniKey
)

   StatusBarSubsystem.h  

static void SetOneTimeStateWithFallback ( const FString StoreId,
const FString SectionName,
const FString KeyName,
const FString FallbackIniLocation,
const FString FallbackIniKey
)

   StatusBarSubsystem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page