SListPanel.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Misc/Attribute.h"
#include "Layout/Visibility.h"
#include "SlotBase.h"
#include "Layout/Children.h"
#include "Widgets/DeclarativeSyntaxSupport.h"
#include "Widgets/SPanel.h"
#include "Widgets/Views/STableViewBase.h"
 
class FArrangedChildren;
 
class SListPanel : public SPanel
{
    SLATE_DECLARE_WIDGET_API(SListPanel, SPanel, SLATE_API)
 
public:
    class FSlot : public TSlotBase<FSlot>
    {
    public:
        FSlot()
        : TSlotBase<FSlot>()
        {}
    };
    
    static SLATE_API FSlot::FSlotArguments Slot();
    
    using FScopedWidgetSlotArguments = TPanelChildren<FSlot>::FScopedWidgetSlotArguments;
    SLATE_API FScopedWidgetSlotArguments AddSlot(int32 InsertAtIndex = INDEX_NONE);
    
    SLATE_BEGIN_ARGS( SListPanel )
        : _ItemWidth(0)
        , _ItemHeight(16)
        , _NumDesiredItems(0)
        , _ItemAlignment(EListItemAlignment::EvenlyDistributed)
        , _ListOrientation(Orient_Vertical)
        {
            _Visibility = EVisibility::SelfHitTestInvisible;
            _Clipping = EWidgetClipping::ClipToBounds;
        }
    
        SLATE_SLOT_ARGUMENT(FSlot, Slots)
        SLATE_ATTRIBUTE( float, ItemWidth )
        SLATE_ATTRIBUTE( float, ItemHeight )
        SLATE_ATTRIBUTE( int32, NumDesiredItems )
        SLATE_ATTRIBUTE( EListItemAlignment, ItemAlignment )
        SLATE_ARGUMENT( EOrientation, ListOrientation )
 
    SLATE_END_ARGS()
    
    SLATE_API SListPanel();
 
    SLATE_API virtual ~SListPanel();
 
    SLATE_API void Construct( const FArguments& InArgs );
 
public:
 
    // SWidget interface
    SLATE_API virtual void OnArrangeChildren( const FGeometry& AllottedGeometry, FArrangedChildren& ArrangedChildren ) const override;
    SLATE_API virtual FVector2D ComputeDesiredSize(float) const override;
    SLATE_API virtual FChildren* GetAllChildren() override;
    SLATE_API virtual FChildren* GetChildren() override;
    SLATE_API virtual void Tick( const FGeometry& AllottedGeometry, const double InCurrentTime, const float InDeltaTime ) override;
    // End of SWidget interface
 
    SLATE_API void SetFirstLineScrollOffset(float InFirstLineScrollOffset);
 
    SLATE_API void SetOverscrollAmount( float InOverscrollAmount );
    
    SLATE_API void ClearItems();
 
    SLATE_API FTableViewDimensions GetDesiredItemDimensions() const;
 
    SLATE_API FTableViewDimensions GetItemSize(const FGeometry& AllottedGeometry) const;
 
    SLATE_API FTableViewDimensions GetItemSize(const FGeometry& AllottedGeometry, const EListItemAlignment ListItemAlignment) const;
 
    SLATE_API float GetItemPadding(const FGeometry& AllottedGeometry) const;
 
    SLATE_API float GetItemPadding(const FGeometry& AllottedGeometry, const EListItemAlignment ListItemAlignment) const;
 
    SLATE_API float GetLinePadding(const FGeometry& AllottedGeometry, const int32 LineStartIndex) const;
 
    SLATE_API void SetRefreshPending( bool IsPendingRefresh );
 
    SLATE_API bool IsRefreshPending() const;
 
    SLATE_API void SetItemHeight(TAttribute<float> Height);
 
    SLATE_API void SetItemWidth(TAttribute<float> Width);
 
protected:
 
    SLATE_API bool ShouldArrangeAsTiles() const;
 
protected:
    TPanelChildren<FSlot> Children;
    
    float FirstLineScrollOffset = 0.f;
 
    float OverscrollAmount = 0.f;
 
    int32 PreferredNumLines = 1;
 
    bool bIsRefreshPending = false;
 
    EOrientation Orientation;
 
private:
    TSlateAttribute<EListItemAlignment> ItemAlignmentAttribute;
 
    TSlateAttribute<float> ItemWidthAttribute;
 
    TSlateAttribute<float> ItemHeightAttribute;
 
    TSlateAttribute<int32> NumDesiredItemsAttribute;
};