IUserListEntry.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "UObject/Interface.h"
#include "Kismet/BlueprintFunctionLibrary.h"
#include "IUserListEntry.generated.h"
 
class UUserWidget;
class UListViewBase;
class IObjectTableRow;
enum class EItemDropZone;
enum class EUMGItemDropZone : uint8;
UINTERFACE(BlueprintType, MinimalAPI)
class UUserListEntry : public UInterface
{
    GENERATED_UINTERFACE_BODY()
};
 
class IUserListEntry : public IInterface
{
    GENERATED_IINTERFACE_BODY()
public:
    UMG_API bool IsListItemSelected() const;
    
    UMG_API bool IsListItemExpanded() const;
    
    UMG_API UListViewBase* GetOwningListView() const;
 
    virtual bool IsListItemSelectable() const { return true; }
 
public:
    static UMG_API void ReleaseEntry(UUserWidget& ListEntryWidget);
    static UMG_API void UpdateItemSelection(UUserWidget& ListEntryWidget, bool bIsSelected);
    static UMG_API void UpdateItemExpansion(UUserWidget& ListEntryWidget, bool bIsExpanded);
    static UMG_API void UpdateEntryDropIndicator(UUserWidget& ListEntryWidget, TOptional<EItemDropZone> DropZone);
    static UMG_API void UpdateEntryDragOverState(UUserWidget& ListEntryWidget, bool bIsDraggingOver);
    static UMG_API void EndEntryDropOperation(UUserWidget& ListEntryWidget, bool bSuccess);
    static UMG_API void HandleEntryDropped(UUserWidget& ListEntryWidget, UDragDropOperation* Operation);
    static UMG_API void HandleEntryDragged(UUserWidget& ListEntryWidget, UDragDropOperation* Operation);
 
protected:
    UMG_API virtual void NativeOnItemSelectionChanged(bool bIsSelected);
    UMG_API virtual void NativeOnItemExpansionChanged(bool bIsExpanded);
    UMG_API virtual void NativeOnEntryReleased();
 
    UFUNCTION(BlueprintImplementableEvent, Category = UserListEntry, meta = (DisplayName = "On Item Selection Changed"))
    UMG_API void BP_OnItemSelectionChanged(bool bIsSelected);
 
    UFUNCTION(BlueprintImplementableEvent, Category = UserListEntry, meta = (DisplayName = "On Item Expansion Changed"))
    UMG_API void BP_OnItemExpansionChanged(bool bIsExpanded);
 
    UFUNCTION(BlueprintImplementableEvent, Category = UserListEntry, meta = (DisplayName = "On Entry Released"))
    UMG_API void BP_OnEntryReleased();
 
    UFUNCTION(BlueprintImplementableEvent, Category = UserListEntry, meta = (DisplayName = "On Update Entry Drop Indicator"))
    UMG_API void BP_OnUpdateEntryDropIndicator(EUMGItemDropZone DropZone);
 
    UFUNCTION(BlueprintImplementableEvent, Category = UserListEntry, meta = (DisplayName = "On Entry Drag Over Changed"))
    UMG_API void BP_OnEntryDragOverChanged(bool bIsDraggingOver);
 
    UFUNCTION(BlueprintImplementableEvent, Category = UserListEntry, meta = (DisplayName = "On Entry Accept Drop"))
    UMG_API void BP_OnEndEntryDropOperation(bool bSuccess);
 
    UFUNCTION(BlueprintImplementableEvent, Category = UserListEntry, meta = (DisplayName = "On Entry Dropped"))
    UMG_API void BP_OnEntryDropped(UDragDropOperation* Operation);
 
    UFUNCTION(BlueprintImplementableEvent, Category = UserListEntry, meta = (DisplayName = "On Entry Dragged"))
    UMG_API void BP_OnEntryDragged(UDragDropOperation* Operation);
    
};
 
UCLASS(MinimalAPI)
class UUserListEntryLibrary : public UBlueprintFunctionLibrary
{
    GENERATED_BODY()
 
public:
    UFUNCTION(BlueprintPure, Category = UserListEntry, meta = (DefaultToSelf = UserListEntry))
    static UMG_API bool IsListItemSelected(TScriptInterface<IUserListEntry> UserListEntry);
 
    UFUNCTION(BlueprintPure, Category = UserListEntry, meta = (DefaultToSelf = UserListEntry))
    static UMG_API bool IsListItemExpanded(TScriptInterface<IUserListEntry> UserListEntry);
 
    UFUNCTION(BlueprintPure, Category = UserListEntry, meta = (DefaultToSelf = UserListEntry))
    static UMG_API UListViewBase* GetOwningListView(TScriptInterface<IUserListEntry> UserListEntry);
};