1. Epic GamesDeveloper
  3. UComboBoxString

UComboBoxString

The combobox allows you to display a list of options to the user in a dropdown menu for them to select one.

API > API/Runtime > API/Runtime/UMG

The combobox allows you to display a list of options to the user in a dropdown menu for them to select one.

   
Name UComboBoxString
Type class
Header File /Engine/Source/Runtime/UMG/Public/Components/ComboBoxString.h
Include Path #include "Components/ComboBoxString.h"

Syntax

UCLASS (Meta=(DisplayName="ComboBox (String)"), MinimalAPI)  
class UComboBoxString : public UWidget

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UComboBoxString ( const FObjectInitializer& ObjectInitializer
)

   Components/ComboBoxString.h  

Classes

Name Remarks
FOnOpeningEvent  
FOnSelectionChangedEvent  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bIsFocusable bool   Components/ComboBoxString.h
  • EditAnywhere
  • BlueprintReadOnly
  • Getter="IsFocusable"
  • Category=Interaction
ContentPadding FMargin   Components/ComboBoxString.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category=Content
EnableGamepadNavigationMode bool When false, directional keys will change the selection. Components/ComboBoxString.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter="IsEnableGamepadNavigationMode"
  • Setter="SetEnableGamepadNavigationMode"
  • Category=Content
  • AdvancedDisplay
Font FSlateFontInfo The default font to use in the combobox, only applies if you're not implementing OnGenerateWidgetEvent to factory each new entry. Components/ComboBoxString.h
  • EditAnywhere
  • BlueprintReadOnly
  • Getter
  • Category=Style
ForegroundColor FSlateColor The foreground color to pass through the hierarchy. Components/ComboBoxString.h
  • EditAnywhere
  • BlueprintReadOnly
  • Getter
  • Category=Style
  • Meta=(DesignerRebuild)
HasDownArrow bool When false, the down arrow is not generated and it is up to the API consumer to make their own visual hint that this is a drop down. Components/ComboBoxString.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter="IsHasDownArrow"
  • Setter="SetHasDownArrow"
  • Category=Content
  • AdvancedDisplay
ItemStyle FTableRowStyle The item row style. Components/ComboBoxString.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category=Style
MaxListHeight float The max height of the combobox list that opens Components/ComboBoxString.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category=Content
  • AdvancedDisplay
OnGenerateWidgetEvent FGenerateWidgetForString Called when the widget is needed for the item. Components/ComboBoxString.h
  • EditAnywhere
  • Category=Events
  • Meta=(IsBindableEvent="True")
OnOpening FOnOpeningEvent Called when the combobox is opening Components/ComboBoxString.h
  • BlueprintAssignable
  • Category=Events
OnSelectionChanged FOnSelectionChangedEvent Called when a new item is selected in the combobox. Components/ComboBoxString.h
  • BlueprintAssignable
  • Category=Events
ScrollBarStyle FScrollBarStyle The scroll bar style. Components/ComboBoxString.h
  • EditAnywhere
  • BlueprintReadOnly
  • Getter
  • Category="Style"
WidgetStyle FComboBoxStyle The style. Components/ComboBoxString.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category=Style
  • Meta=(DisplayName="Style")

Protected

Name Type Remarks Include Path Unreal Specifiers
DefaultOptions TArray< FString > The default list of items to be displayed on the combobox. Components/ComboBoxString.h
  • EditAnywhere
  • Category=Content
SelectedOption FString The item in the combobox to select by default Components/ComboBoxString.h
  • EditAnywhere
  • FieldNotify
  • Category=Content

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddOption ( const FString& Option
)

   Components/ComboBoxString.h
  • BlueprintCallable
  • Category="ComboBox"

void ClearOptions()

   Components/ComboBoxString.h
  • BlueprintCallable
  • Category="ComboBox"

void ClearSelection()

   Components/ComboBoxString.h
  • BlueprintCallable
  • Category="ComboBox"

int32 FindOptionIndex ( const FString& Option
) const

   Components/ComboBoxString.h
  • BlueprintCallable
  • Category="ComboBox"

FMargin GetContentPadding()

 Get the padding for content. Components/ComboBoxString.h  

const FSlateFontInfo & GetFont()

 Get the default font for Combobox if no OnGenerateWidgetEvent is specified. Components/ComboBoxString.h  

FSlateColor GetForegroundColor()

 Get the foreground color of the button. Components/ComboBoxString.h  

const FTableRowStyle & GetItemStyle()

 Get the style of the items. Components/ComboBoxString.h  

float GetMaxListHeight()

 Get the maximum height of the combobox list. Components/ComboBoxString.h  

FString GetOptionAtIndex ( int32 Index
) const

   Components/ComboBoxString.h
  • BlueprintCallable
  • Category="ComboBox"

int32 GetOptionCount()

 Returns the number of options Components/ComboBoxString.h
  • BlueprintCallable
  • Category="ComboBox"

const FScrollBarStyle & GetScrollBarStyle()

 Get the style of the scrollbar. Components/ComboBoxString.h  

int32 GetSelectedIndex()

   Components/ComboBoxString.h
  • BlueprintCallable
  • Category="ComboBox"

FString GetSelectedOption()

   Components/ComboBoxString.h
  • BlueprintCallable
  • Category="ComboBox"

const FComboBoxStyle & GetWidgetStyle()

 Get the style of the combobox. Components/ComboBoxString.h  

bool IsEnableGamepadNavigationMode()

 Is the combobox navigated by gamepad. Components/ComboBoxString.h  

bool IsFocusable()

 Is the combobox focusable. Components/ComboBoxString.h  

bool IsHasDownArrow()

 Is the combobox arrow showing. Components/ComboBoxString.h  

bool IsOpen()

   Components/ComboBoxString.h
  • BlueprintCallable
  • Category="ComboBox"
  • Meta=(ReturnDisplayName="bOpen")

void RefreshOptions ()

 Refreshes the list of options. Components/ComboBoxString.h
  • BlueprintCallable
  • Category="ComboBox"

bool RemoveOption ( const FString& Option
)

   Components/ComboBoxString.h
  • BlueprintCallable
  • Category="ComboBox"

void SetContentPadding ( FMargin InPadding
)

 Set the padding for content. Components/ComboBoxString.h  

void SetEnableGamepadNavigationMode ( bool InEnableGamepadNavigationMode
)

 Set whether the combobox is navigated by gamepad. Components/ComboBoxString.h  

void SetHasDownArrow ( bool InHasDownArrow
)

 Set whether the combobox arrow is showing. Components/ComboBoxString.h  

void SetItemStyle ( const FTableRowStyle& InItemStyle
)

 Set the style of the items. Components/ComboBoxString.h  

void SetMaxListHeight ( float InMaxHeight
)

 Set the maximum height of the combobox list. Components/ComboBoxString.h  

void SetSelectedIndex ( const int32 Index
)

   Components/ComboBoxString.h
  • BlueprintCallable
  • Category="ComboBox"

void SetSelectedOption ( FString Option
)

   Components/ComboBoxString.h
  • BlueprintCallable
  • Category="ComboBox"

void SetWidgetStyle ( const FComboBoxStyle& InWidgetStyle
)

 Set the style of the combobox. Components/ComboBoxString.h  

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual const FText GetPaletteCategory()

 Gets the palette category of the widget Components/ComboBoxString.h  

Overridden from UVisual

Name Remarks Include Path Unreal Specifiers

virtual void ReleaseSlateResources ( bool bReleaseChildren
)

   Components/ComboBoxString.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostInitProperties()

   Components/ComboBoxString.h  

virtual void PostLoad()

   Components/ComboBoxString.h  

virtual void Serialize ( FArchive& Ar
)

   Components/ComboBoxString.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual TSharedRef< SWidget > HandleGenerateWidget ( TSharedPtr< FString > Item
) const

 Called by slate when it needs to generate a new item for the combobox Components/ComboBoxString.h  

virtual void HandleOpening()

 Called by slate when the underlying combobox is opening Components/ComboBoxString.h  

virtual void HandleSelectionChanged ( TSharedPtr< FString > Item,
ESelectInfo::Type SelectionType
)

 Called by slate when the underlying combobox selection changes Components/ComboBoxString.h  

void InitFont ( FSlateFontInfo InFont
)

 Initialize the default font in the constructor before the SWidget is constructed. Components/ComboBoxString.h  

void InitForegroundColor ( FSlateColor InForegroundColor
)

 Initialize ForegroundColor in the constructor before the SWidget is constructed. Components/ComboBoxString.h  

void InitIsFocusable ( bool InIsFocusable
)

 Initialize IsFocusable in the constructor before the SWidget is constructed. Components/ComboBoxString.h  

void InitScrollBarStyle ( const FScrollBarStyle& InScrollBarStyle
)

 Initialize the scrollbar style in the constructor before the SWidget is constructed. Components/ComboBoxString.h  

void UpdateOrGenerateWidget ( TSharedPtr< FString > Item
)

 Refresh ComboBoxContent with the correct widget/data when the selected option changes Components/ComboBoxString.h  

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual TSharedRef< SWidget > RebuildWidget()

 Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed. Components/ComboBoxString.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page