STabDrawer.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Widgets/SCompoundWidget.h"
#include "Widgets/DeclarativeSyntaxSupport.h"
#include "Application/ThrottleManager.h"
#include "Animation/CurveSequence.h"
 
struct FSplitterStyle;
 
class STabDrawer;
class SDockTab;
 
enum class ETabDrawerOpenDirection : uint8
{
    Left,
 
    Right,
 
    Bottom
};
 
DECLARE_DELEGATE_TwoParams(FOnDrawerTargetSizeChanged, TSharedRef<STabDrawer>, float);
DECLARE_DELEGATE_OneParam(FOnDrawerFocusLost, TSharedRef<STabDrawer>);
DECLARE_DELEGATE_OneParam(FOnDrawerClosed, TSharedRef<STabDrawer>);
 
class STabDrawer : public SCompoundWidget
{
    SLATE_BEGIN_ARGS(STabDrawer)
    {
        _Clipping = EWidgetClipping::ClipToBounds;
        _ShadowOffset = FVector2D(8.0f, 8.0f);
    }
    SLATE_DEFAULT_SLOT(FArguments, Content)
        SLATE_ARGUMENT(float, MinDrawerSize)
        SLATE_ARGUMENT(float, MaxDrawerSize)
        SLATE_ARGUMENT(float, TargetDrawerSize)
        SLATE_EVENT(FOnDrawerTargetSizeChanged, OnTargetDrawerSizeChanged)
        SLATE_EVENT(FOnDrawerFocusLost, OnDrawerFocusLost)
        SLATE_EVENT(FOnDrawerClosed, OnDrawerClosed)
        SLATE_ARGUMENT(FVector2D, ShadowOffset)
    SLATE_END_ARGS()
 
    ~STabDrawer();
    void Construct(const FArguments& InArgs, TSharedRef<SDockTab> InTab, TWeakPtr<SWidget> InTabButton, ETabDrawerOpenDirection InOpenDirection);
 
    void SetCurrentSize(float InSize);
 
    void Open(bool bAnimateOpen=true);
 
    void Close();
 
    bool IsOpen() const;
 
    bool IsClosing() const;
 
    const TSharedRef<SDockTab> GetTab() const;
 
    virtual bool SupportsKeyboardFocus() const override;
    virtual FVector2D ComputeDesiredSize(float LayoutScaleMultiplier) const override;
    virtual void OnArrangeChildren(const FGeometry& AllottedGeometry, FArrangedChildren& ArrangedChildren) const override;
    virtual FReply OnMouseButtonDown(const FGeometry& AllottedGeometry, const FPointerEvent& MouseEvent) override;
    virtual FReply OnMouseButtonUp(const FGeometry& AllottedGeometry, const FPointerEvent& MouseEvent) override;
    virtual FReply OnMouseMove(const FGeometry& AllottedGeometry, const FPointerEvent& MouseEvent) override;
    virtual void OnMouseLeave(const FPointerEvent& MouseEvent) override;
    virtual FCursorReply OnCursorQuery(const FGeometry& MyGeometry, const FPointerEvent& CursorEvent) const override;
    virtual int32 OnPaint(const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawElements, int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled) const override;
 
private:
    FGeometry GetRenderTransformedGeometry(const FGeometry& AllottedGeometry) const;
    FGeometry GetResizeHandleGeometry(const FGeometry& AllottedGeometry) const;
    EActiveTimerReturnType UpdateAnimation(double CurrentTime, float DeltaTime);
    void OnGlobalFocusChanging(const FFocusEvent& FocusEvent, const FWeakWidgetPath& OldFocusedWidgetPath, const TSharedPtr<SWidget>& OldFocusedWidget, const FWidgetPath& NewFocusedWidgetPath, const TSharedPtr<SWidget>& NewFocusedWidget);
    void OnActiveTabChanged(TSharedPtr<SDockTab> NewlyActivated, TSharedPtr<SDockTab> PreviouslyActive);
 
private:
    FGeometry InitialResizeGeometry;
    FOnDrawerTargetSizeChanged OnTargetDrawerSizeChanged;
    FOnDrawerFocusLost OnDrawerFocusLost;
    FOnDrawerClosed OnDrawerClosed;
    TSharedPtr<FActiveTimerHandle> OpenCloseTimer;
    TSharedPtr<SDockTab> ForTab;
    TWeakPtr<SWidget> TabButton;
    FThrottleRequest ResizeThrottleHandle;
    FThrottleRequest AnimationThrottle;
    FCurveSequence OpenCloseAnimation;
    const FSlateBrush* BackgroundBrush;
    const FSlateBrush* ShadowBrush;
    const FSlateBrush* BorderBrush; // border with all corners rounded
    const FSlateBrush* BorderSquareEdgeBrush; // border with corners squared on one edge depending on open direction
    const FSplitterStyle* SplitterStyle;
    FVector2D ShadowOffset;
    float ExpanderSize;
    float CurrentSize;
    float MinDrawerSize;
    float MaxDrawerSize;
    float TargetDrawerSize;
    float InitialSizeAtResize;
    ETabDrawerOpenDirection OpenDirection;
    bool bIsResizing;
    bool bIsResizeHandleHovered;
};