STabSidebar.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Widgets/DeclarativeSyntaxSupport.h"
#include "Widgets/SCompoundWidget.h"
 
class SDockTab;
class SOverlay;
class STabDrawerButton;
class SVerticalBox;
class STabDrawer;
struct FTabId;
enum class ESidebarLocation : uint8;
 
class STabSidebar : public SCompoundWidget
{
    SLATE_BEGIN_ARGS(STabSidebar)
    {}
        SLATE_ARGUMENT(ESidebarLocation, Location)
    SLATE_END_ARGS()
 
public:
    ~STabSidebar();
 
    void Construct(const FArguments& InArgs, TSharedRef<SOverlay> InDrawersOverlay);
 
    void SetOffset(float Offset);
 
    void AddTab(TSharedRef<SDockTab> Tab);
 
    bool RemoveTab(TSharedRef<SDockTab> TabToRemove);
 
    bool RestoreTab(TSharedRef<SDockTab> TabToRestore);
 
    bool ContainsTab(TSharedPtr<SDockTab> Tab) const;
 
    TArray<FTabId> GetAllTabIds() const;
 
    TArray<TSharedRef<SDockTab>> GetAllTabs() const;
 
    bool TryOpenSidebarDrawer(TSharedRef<SDockTab> ForTab);
private:
    void OnTabDrawerButtonPressed(TSharedRef<SDockTab> ForTab);
    void OnTabDrawerPinButtonToggled(TSharedRef<SDockTab> ForTab, bool bIsPinned);
    void OnTabDrawerFocusLost(TSharedRef<STabDrawer> Drawer);
    void OnTabDrawerClosed(TSharedRef<STabDrawer> Drawer);
    void OnTargetDrawerSizeChanged(TSharedRef<STabDrawer> Drawer, float NewSize);
 
    TSharedRef<SWidget> OnGetTabDrawerContextMenuWidget(TSharedRef<SDockTab> ForTab);
    void OnRestoreTab(TSharedRef<SDockTab> TabToRestore);
    void OnCloseTab(TSharedRef<SDockTab> TabToClose);
    
    void RemoveDrawer(TSharedRef<SDockTab> ForTab);
 
    void RemoveAllDrawers();
 
    EActiveTimerReturnType OnOpenPendingDrawerTimer(double CurrentTime, float DeltaTime);
    void OpenDrawerNextFrame(TSharedRef<SDockTab> ForTab, bool bAnimateOpen);
    void OpenDrawerInternal(TSharedRef<SDockTab> ForTab, bool bAnimateOpen);
    void CloseDrawerInternal(TSharedRef<SDockTab> ForTab);
 
    void SummonPinnedTabIfNothingOpened();
 
    void UpdateDrawerAppearance();
 
    TSharedPtr<SDockTab> FindFirstPinnedTab() const;
 
    TSharedPtr<SDockTab> GetForegroundTab() const;
 
    TSharedPtr<STabDrawer> FindOpenedDrawer(TSharedRef<SDockTab> ForTab) const;
 
private:
    TSharedPtr<SVerticalBox> TabBox;
    TArray<TPair<TSharedRef<SDockTab>, TSharedRef<STabDrawerButton>>> Tabs;
    TSharedPtr<FActiveTimerHandle> OpenPendingDrawerTimerHandle;
    ESidebarLocation Location;
    TSharedPtr<SOverlay> DrawersOverlay;
    TArray<TSharedRef<STabDrawer>> OpenedDrawers;
    TWeakPtr<SDockTab> PendingTabToOpen;
    bool bAnimatePendingTabOpen = false;
};