ComboBoxString.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 "Fonts/SlateFontInfo.h"
#include "Layout/Margin.h"
#include "Styling/SlateColor.h"
#include "Styling/SlateTypes.h"
#include "Widgets/SWidget.h"
#include "Widgets/Input/SComboBox.h"
#include "Components/Widget.h"
 
#include "ComboBoxString.generated.h"
 
UCLASS(meta=( DisplayName="ComboBox (String)"), MinimalAPI)
class UComboBoxString : public UWidget
{
    GENERATED_UCLASS_BODY()
 
    DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FOnSelectionChangedEvent, FString, SelectedItem, ESelectInfo::Type, SelectionType);
    DECLARE_DYNAMIC_MULTICAST_DELEGATE(FOnOpeningEvent);
 
private:
 
    UPROPERTY(EditAnywhere, Category=Content)
    TArray<FString> DefaultOptions;
 
    UPROPERTY(EditAnywhere, FieldNotify, Category=Content)
    FString 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 ContentPadding is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category=Content)
    FMargin ContentPadding;
 
    UE_DEPRECATED(5.2, "Direct access to MaxListHeight is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category=Content, AdvancedDisplay)
    float MaxListHeight;
 
    UE_DEPRECATED(5.2, "Direct access to HasDownArrow is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter = "IsHasDownArrow", Setter = "SetHasDownArrow", Category = Content, AdvancedDisplay)
    bool HasDownArrow;
 
    UE_DEPRECATED(5.2, "Direct access to EnableGamepadNavigationMode is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter = "IsEnableGamepadNavigationMode", Setter = "SetEnableGamepadNavigationMode", Category = Content, AdvancedDisplay)
    bool EnableGamepadNavigationMode;
 
    UE_DEPRECATED(5.2, "Direct access to Font 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)
    FSlateFontInfo Font;
 
    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 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=Interaction)
    bool bIsFocusable;
 
public: // Events
 
    UPROPERTY(EditAnywhere, Category=Events, meta=( IsBindableEvent="True" ))
    FGenerateWidgetForString OnGenerateWidgetEvent;
 
    UPROPERTY(BlueprintAssignable, Category=Events)
    FOnSelectionChangedEvent OnSelectionChanged;
 
    UPROPERTY(BlueprintAssignable, Category=Events)
    FOnOpeningEvent OnOpening;
 
public:
 
    UFUNCTION(BlueprintCallable, Category="ComboBox")
    UMG_API void AddOption(const FString& Option);
 
    UFUNCTION(BlueprintCallable, Category="ComboBox")
    UMG_API bool RemoveOption(const FString& Option);
 
    UFUNCTION(BlueprintCallable, Category="ComboBox")
    UMG_API int32 FindOptionIndex(const FString& Option) const;
 
    UFUNCTION(BlueprintCallable, Category="ComboBox")
    UMG_API FString GetOptionAtIndex(int32 Index) const;
 
    UFUNCTION(BlueprintCallable, Category="ComboBox")
    UMG_API void ClearOptions();
 
    UFUNCTION(BlueprintCallable, Category="ComboBox")
    UMG_API void ClearSelection();
 
    UFUNCTION(BlueprintCallable, Category="ComboBox")
    UMG_API void RefreshOptions();
 
    UFUNCTION(BlueprintCallable, Category="ComboBox")
    UMG_API void SetSelectedOption(FString Option);
 
    UFUNCTION(BlueprintCallable, Category = "ComboBox")
    UMG_API void SetSelectedIndex(const int32 Index);
 
    UFUNCTION(BlueprintCallable, Category="ComboBox")
    UMG_API FString GetSelectedOption() const;
 
    UFUNCTION(BlueprintCallable, Category="ComboBox")
    UMG_API int32 GetSelectedIndex() const;
 
    UFUNCTION(BlueprintCallable, Category="ComboBox")
    UMG_API int32 GetOptionCount() 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 FSlateFontInfo& GetFont() const;
 
    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;
 
    //~ Begin UObject Interface
    UMG_API virtual void PostInitProperties() override;
    UMG_API virtual void Serialize(FArchive& Ar) override;
    UMG_API virtual void PostLoad() override;
    //~ End UObject Interface
 
#if WITH_EDITOR
    UMG_API virtual const FText GetPaletteCategory() override;
#endif
 
protected:
    UMG_API void UpdateOrGenerateWidget(TSharedPtr<FString> Item);
 
    UMG_API virtual TSharedRef<SWidget> HandleGenerateWidget(TSharedPtr<FString> Item) const;
 
    UMG_API virtual void HandleSelectionChanged(TSharedPtr<FString> Item, ESelectInfo::Type SelectionType);
 
    UMG_API virtual void HandleOpening();
 
    //~ Begin UWidget Interface
    UMG_API virtual TSharedRef<SWidget> RebuildWidget() override;
    //~ End UWidget Interface
 
    UMG_API void InitScrollBarStyle(const FScrollBarStyle& InScrollBarStyle);
 
    UMG_API void InitFont(FSlateFontInfo InFont);
 
    UMG_API void InitIsFocusable(bool InIsFocusable);
 
    UMG_API void InitForegroundColor(FSlateColor InForegroundColor);
 
protected:
    TArray< TSharedPtr<FString> > Options;
 
    TSharedPtr< SComboBox< TSharedPtr<FString> > > MyComboBox;
 
    TSharedPtr< SBox > ComboBoxContent;
 
    TWeakPtr<STextBlock> DefaultComboBoxContent;
 
    TSharedPtr<FString> CurrentOptionPtr;
};