ComboBoxKey.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Components/Widget.h"
#include "Widgets/Input/SComboBox.h"
 
#include "ComboBoxKey.generated.h"
 
 
UCLASS(meta = (DisplayName = "ComboBox (Key)"), MinimalAPI)
class UComboBoxKey : public UWidget
{
    GENERATED_BODY()
 
public:
    UMG_API UComboBoxKey();
 
    DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FOnSelectionChangedEvent, FName, SelectedItem, ESelectInfo::Type, SelectionType);
    DECLARE_DYNAMIC_MULTICAST_DELEGATE(FOnOpeningEvent);
    DECLARE_DYNAMIC_DELEGATE_RetVal_OneParam(UWidget*, FGenerateWidgetEvent, FName, Item);
 
private:
    UPROPERTY(EditAnywhere, Category = Content)
    TArray<FName> Options;
 
    UPROPERTY(EditAnywhere, FieldNotify, Category = Content)
    FName SelectedOption;
 
public:
    UE_DEPRECATED(5.2, "Direct access to WidgetStyle is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category = Style, meta = (DisplayName = "Style"))
    FComboBoxStyle WidgetStyle;
 
    UE_DEPRECATED(5.2, "Direct access to ItemStyle is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category = Style)
    FTableRowStyle ItemStyle;
 
    UE_DEPRECATED(5.2, "Direct access to ScrollBarStyle is deprecated. Please use the getter. Note that this property is only set at construction and is not modifiable at runtime.")
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Getter, Category="Style")
    FScrollBarStyle ScrollBarStyle;
 
    UE_DEPRECATED(5.2, "Direct access to ForegroundColor is deprecated. Please use the getter. Note that this property is only set at construction and is not modifiable at runtime.")
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Getter, Category = Style, meta = (DesignerRebuild))
    FSlateColor ForegroundColor;
 
    UE_DEPRECATED(5.2, "Direct access to ContentPadding is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category = Style)
    FMargin ContentPadding;
 
    UE_DEPRECATED(5.2, "Direct access to MaxListHeight is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category = Style, AdvancedDisplay)
    float MaxListHeight;
 
    UE_DEPRECATED(5.2, "Direct access to bHasDownArrow is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter = "IsHasDownArrow", Setter = "SetHasDownArrow", Category = Style, AdvancedDisplay)
    bool bHasDownArrow;
 
    UE_DEPRECATED(5.2, "Direct access to bEnableGamepadNavigationMode is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter = "IsEnableGamepadNavigationMode", Setter = "SetEnableGamepadNavigationMode", Category = Style, AdvancedDisplay)
    bool bEnableGamepadNavigationMode;
 
    UE_DEPRECATED(5.2, "Direct access to bIsFocusable is deprecated. Please use the getter. Note that this property is only set at construction and is not modifiable at runtime.")
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Getter = "IsFocusable", Category = Style)
    bool bIsFocusable;
 
public: // Events
 
    UPROPERTY(EditAnywhere, Category = Events, meta = (IsBindableEvent = "True"))
    FGenerateWidgetEvent OnGenerateContentWidget;
    
    UPROPERTY(EditAnywhere, Category = Events, meta = (IsBindableEvent = "True"))
    FGenerateWidgetEvent OnGenerateItemWidget;
 
    UPROPERTY(BlueprintAssignable, Category = Events)
    FOnSelectionChangedEvent OnSelectionChanged;
 
    UPROPERTY(BlueprintAssignable, Category = Events)
    FOnOpeningEvent OnOpening;
 
public:
 
    
 
    UFUNCTION(BlueprintCallable, Category = "ComboBox")
    UMG_API void AddOption(FName Option);
 
    UFUNCTION(BlueprintCallable, Category = "ComboBox")
    UMG_API bool RemoveOption(FName Option);
 
    UFUNCTION(BlueprintCallable, Category = "ComboBox")
    UMG_API void ClearOptions();
 
    UFUNCTION(BlueprintCallable, Category = "ComboBox")
    UMG_API void ClearSelection();
 
    UFUNCTION(BlueprintCallable, Category = "ComboBox")
    UMG_API void SetSelectedOption(FName Option);
 
    UFUNCTION(BlueprintCallable, Category = "ComboBox")
    UMG_API FName GetSelectedOption() const;
 
    UFUNCTION(BlueprintCallable, Category = "ComboBox", Meta = (ReturnDisplayName = "bOpen"))
    UMG_API bool IsOpen() const;
 
    //~ Begin UVisual Interface
    UMG_API virtual void ReleaseSlateResources(bool bReleaseChildren) override;
    //~ End UVisual Interface
 
    UMG_API void SetContentPadding(FMargin InPadding);
 
    UMG_API FMargin GetContentPadding() const;
 
    UMG_API bool IsEnableGamepadNavigationMode() const;
 
    UMG_API void SetEnableGamepadNavigationMode(bool InEnableGamepadNavigationMode);
 
    UMG_API bool IsHasDownArrow() const;
 
    UMG_API void SetHasDownArrow(bool InHasDownArrow);
 
    UMG_API float GetMaxListHeight() const;
 
    UMG_API void SetMaxListHeight(float InMaxHeight);
 
    UMG_API const FComboBoxStyle& GetWidgetStyle() const;
 
    UMG_API void SetWidgetStyle(const FComboBoxStyle& InWidgetStyle);
 
    UMG_API const FTableRowStyle& GetItemStyle() const;
 
    UMG_API void SetItemStyle(const FTableRowStyle& InItemStyle);
 
    UMG_API const FScrollBarStyle& GetScrollBarStyle() const;
 
    UMG_API bool IsFocusable() const;
 
    UMG_API FSlateColor GetForegroundColor() const;
 
#if WITH_EDITOR
    UMG_API virtual const FText GetPaletteCategory() override;
#endif
 
protected:
 
    UMG_API void InitScrollBarStyle(const FScrollBarStyle& InScrollBarStyle);
 
    UMG_API void InitIsFocusable(bool InIsFocusable);
 
    UMG_API void InitForegroundColor(FSlateColor InForegroundColor);
 
private:
    void GenerateContent();
 
    TSharedRef<SWidget> HandleGenerateItemWidget(FName Item);
 
    void HandleSelectionChanged(FName Item, ESelectInfo::Type SelectionType);
 
    void HandleOpening();
 
    //~ Begin UWidget Interface
    UMG_API virtual TSharedRef<SWidget> RebuildWidget() override;
    //~ End UWidget Interface
 
private:
    TSharedPtr<SComboBox<FName>> MyComboBox;
 
    TSharedPtr< SBox > ComboBoxContent;
};