SDockingTabWell.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 "Input/Reply.h"
#include "Layout/Children.h"
#include "Widgets/SPanel.h"
#include "Framework/Docking/SDockingNode.h"
#include "Widgets/Docking/SDockTab.h"
#include "Framework/Docking/SDockingTabStack.h"
 
class FArrangedChildren;
class FPaintArgs;
class FSlateWindowElementList;
 
struct FDockingConstants
{
    static const FVector2D MaxMinorTabSize;
    static const FVector2D MaxMajorTabSize;
    static const float MaxTabSizeNoNameWidth;
    static const float MaxTabSizeNoNameCantCloseWidth;
    static const FVector2D SLATE_API GetMaxTabSizeFor( ETabRole TabRole );
};
 
class SDockingTabWell : public SPanel
{
public:
 
    SLATE_BEGIN_ARGS( SDockingTabWell )
        : _ParentStackNode( TSharedPtr<SDockingTabStack>( NULL ) )
        {}
        SLATE_ATTRIBUTE( TSharedPtr<SDockingTabStack>, ParentStackNode )
    SLATE_END_ARGS()
 
    SDockingTabWell();
 
    void Construct( const FArguments& InArgs );
 
    int32 GetNumTabs() const;
 
    const TSlotlessChildren<SDockTab>& GetTabs() const;
 
    void AddTab(const TSharedRef<SDockTab>& InTab, int32 AtIndex = INDEX_NONE, bool bKeepInactive = false);
    
    void BringTabToFront( int32 TabIndexToActivate );
    
    void BringTabToFront( TSharedPtr<SDockTab> TabToActivate );
 
    TSharedPtr<SDockTab> GetForegroundTab() const;
 
    int32 GetForegroundTabIndex() const;
 
    void RemoveAndDestroyTab(const TSharedRef<SDockTab>& TabToRemove, SDockingNode::ELayoutModification RemovalMethod);
 
    void RefreshParentContent();
    
    TSharedPtr<SDockingArea> GetDockArea();
 
    TSharedPtr<SDockingTabStack> GetParentDockTabStack();
 
    FReply StartDraggingTab( TSharedRef<SDockTab> TabToStartDragging, FVector2D TabGrabOffsetFraction, const FPointerEvent& MouseEvent );
 
public:
    FVector2D ComputeChildSize( const FGeometry& AllottedGeometry ) const;
 
    // SWidget interface
    virtual void OnArrangeChildren( const FGeometry& AllottedGeometry, FArrangedChildren& ArrangedChildren ) 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;
    virtual FVector2D ComputeDesiredSize(float) const override;
    virtual FChildren* GetChildren() override;
    virtual void OnDragEnter( const FGeometry& MyGeometry, const FDragDropEvent& DragDropEvent ) override;
    virtual void OnDragLeave( const FDragDropEvent& DragDropEvent ) override;
    virtual FReply OnDragOver( const FGeometry& MyGeometry, const FDragDropEvent& DragDropEvent ) override;
    virtual FReply OnDrop( const FGeometry& MyGeometry, const FDragDropEvent& DragDropEvent ) override;
    virtual EWindowZone::Type GetWindowZoneOverride() const override;
    virtual FReply OnMouseButtonUp( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent ) override;
    virtual FReply OnMouseMove( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent ) override;
    // End of SWidget interface
 
private:
    
    float ComputeDraggedTabOffset( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent, const FVector2D& TabGrabOffsetFraction ) const;
 
    int32 ComputeChildDropIndex(const FGeometry& MyGeometry, const TSharedRef<SDockTab>& TabBeingDragged) const;
 
private:
 
    TSlotlessChildren< SDockTab > Tabs;
 
    TWeakPtr<class SDockingTabStack> ParentTabStackPtr;
 
    TSharedPtr<SDockTab> TabBeingDraggedPtr;
 
    const FSlateBrush* SeparatorBrush;
 
    float ChildBeingDraggedOffset;
 
    FVector2D TabGrabOffsetFraction;
 
    int32 ForegroundTabIndex;
};