TileView.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "ListView.h"
#include "Widgets/Views/STileView.h"
#include "TileView.generated.h"
 
UCLASS(MinimalAPI)
class UTileView : public UListView
{
    GENERATED_BODY()
 
public:
    UMG_API UTileView(const FObjectInitializer& ObjectInitializer);
 
    UMG_API virtual void ReleaseSlateResources(bool bReleaseChildren) override;
 
    UFUNCTION(BlueprintCallable, Category = TileView)
    UMG_API void SetEntryHeight(float NewHeight);
 
    UFUNCTION(BlueprintCallable, Category = TileView)
    UMG_API void SetEntryWidth(float NewWidth);
 
    UFUNCTION(BlueprintPure, Category = TileView)
    float GetEntryHeight() const { return EntryHeight; }
 
    UFUNCTION(BlueprintPure, Category = TileView)
    float GetEntryWidth() const { return EntryWidth; }
 
protected:
    UMG_API virtual TSharedRef<STableViewBase> RebuildListWidget() override;
    UMG_API virtual FMargin GetDesiredEntryPadding(UObject* Item) const override;
 
    UMG_API float GetTotalEntryHeight() const;
    UMG_API float GetTotalEntryWidth() const;
 
    template <template<typename> class TileViewT = STileView>
    TSharedRef<TileViewT<UObject*>> ConstructTileView()
    {
        FTileViewConstructArgs Args;
        Args.bAllowFocus = bIsFocusable;
        Args.SelectionMode = SelectionMode;
        Args.bClearSelectionOnClick = bClearSelectionOnClick;
        Args.ConsumeMouseWheel = ConsumeMouseWheel;
        Args.bReturnFocusToSelection = bReturnFocusToSelection;
        Args.TileAlignment = TileAlignment;
        Args.bWrapDirectionalNavigation = bWrapHorizontalNavigation;
        Args.Orientation = Orientation;
        Args.ScrollBarStyle = &ScrollBarStyle;
        Args.ScrollbarDisabledVisibility = UWidget::ConvertSerializedVisibilityToRuntime(ScrollbarDisabledVisibility);
 
        if (IsAligned() && !bEntrySizeIncludesEntrySpacing)
        {
            // This tells the underlying ListView to expect entries with the final width/height equal to EntryWidth/EntryHeight + spacing
            // It allows the entry widget to always occupy the entire EntryWidth/EntryHeight.
            Args.EntryWidth = GetTotalEntryWidth();
            Args.EntryHeight = GetTotalEntryHeight();
        }
        else
        {
            // This tells the underlying ListView to expect entries with the final width/height equal to EntryWidth/EntryHeight.
            // It forces the entry widget size to adjust so that the summation of entry widget width/height and spacing does not exceed EntryWidth/EntryHeight.
            Args.EntryWidth = EntryWidth;
            Args.EntryHeight = EntryHeight;
        }
 
        MyListView = MyTileView = ITypedUMGListView<UObject*>::ConstructTileView<TileViewT>(this, ListItems, Args);
        MyTileView->SetOnEntryInitialized(SListView<UObject*>::FOnEntryInitialized::CreateUObject(this, &UTileView::HandleOnEntryInitializedInternal));
        return StaticCastSharedRef<TileViewT<UObject*>>(MyTileView.ToSharedRef());
    }
 
private:
    UFUNCTION()
    UMG_API bool IsAligned() const;
 
protected:
    UPROPERTY(EditAnywhere, Category = ListEntries)
    float EntryHeight = 128.f;
 
    UPROPERTY(EditAnywhere, Category = ListEntries)
    float EntryWidth = 128.f;
 
    UPROPERTY(EditAnywhere, Category = ListEntries)
    EListItemAlignment TileAlignment;
 
    UPROPERTY(EditAnywhere, Category = Navigation)
    bool bWrapHorizontalNavigation = false;
 
    UPROPERTY(EditAnywhere, Category = ListView, meta=(ValidEnumValues="Collapsed, Hidden, Visible"))
    ESlateVisibility ScrollbarDisabledVisibility = ESlateVisibility::Collapsed;
 
    TSharedPtr<STileView<UObject*>> MyTileView;
 
private:
    UPROPERTY(EditAnywhere, Category = ListEntries, meta = (EditCondition = "IsAligned"))
    bool bEntrySizeIncludesEntrySpacing = true;
};