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 > API/Runtime/UMG/Components

Inheritance Hierarchy

References

   
Module UMG
Header /Engine/Source/Runtime/UMG/Public/Components/ComboBoxString.h
Include #include "Components/ComboBoxString.h"

Syntax

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

Remarks

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

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadOnly getter bool bIsFocusable  
Protected variable TSharedPtr< SBox > ComboBoxContent A shared pointer to a container that holds the combobox content that is selected
Public variable UProperty Category, EditAnywhere BlueprintReadWrite getter, setter FMargin ContentPadding  
Protected variable TSharedPtr< FString > CurrentOptionPtr A shared pointer to the current selected string
Protected variable TWeakPtr< STextBlock > DefaultComboBoxContent If OnGenerateWidgetEvent is not bound, this will store the default STextBlock generated
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite getter, setter bool EnableGamepadNavigationMode When false, directional keys will change the selection.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly getter FSlateFontInfo Font The default font to use in the combobox, only applies if you're not implementing OnGenerateWidgetEvent to factory each new entry.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly getter FSlateColor ForegroundColor The foreground color to pass through the hierarchy.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite getter, setter bool HasDownArrow 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.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite getter, setter FTableRowStyle ItemStyle The item row style.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite getter, setter float MaxListHeight The max height of the combobox list that opens
Protected variable TSharedPtr< SComboBox< TSharedPtr< FString > > > MyComboBox A shared pointer to the underlying slate combobox
Public variable UProperty Category, EditAnywhere, Meta FGenerateWidgetForString OnGenerateWidgetEvent Called when the widget is needed for the item.
Public variable UProperty Category BlueprintAssignable FOnOpeningEvent OnOpening Called when the combobox is opening
Public variable UProperty Category BlueprintAssignable FOnSelectionChangedEvent OnSelectionChanged Called when a new item is selected in the combobox.
Protected variable TArray< TSharedPtr< FString > > Options The true objects bound to the Slate combobox.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly getter FScrollBarStyle ScrollBarStyle The scroll bar style.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter FComboBoxStyle WidgetStyle The style.

Constructors

  Type Name Description
Public function  

UComboBoxString ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void

AddOption ( const FString& Option
)

  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void  
Public function Const UFunction BlueprintCallable, Category int32

FindOptionIndex ( const FString& Option
)

  
Public function Const FMargin Get the padding for content.
Public function Const const FSlateFontInfo &

GetFont ()

 Get the default font for Combobox if no OnGenerateWidgetEvent is specified.
Public function Const FSlateColor Get the foreground color of the button.
Public function Const const FTableRowStyle & Get the style of the items.
Public function Const float Get the maximum height of the combobox list.
Public function Const UFunction BlueprintCallable, Category FString

GetOptionAtIndex ( int32 Index
)

  
Public function Const UFunction BlueprintCallable, Category int32 Returns the number of options
Public function Const const FScrollBarStyle & Get the style of the scrollbar.
Public function Const UFunction BlueprintCallable, Category int32  
Public function Const UFunction BlueprintCallable, Category FString  
Public function Const const FComboBoxStyle & Get the style of the combobox.
Protected function Virtual Const TSharedRef< SWidget >

HandleGenerateWidget ( TSharedPtr< FString > Item
)

 Called by slate when it needs to generate a new item for the combobox
Protected function Virtual void Called by slate when the underlying combobox is opening
Protected function Virtual void

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

 Called by slate when the underlying combobox selection changes
Protected function void

InitFont ( FSlateFontInfo InFont
)

 Initialize the default font in the constructor before the SWidget is constructed.
Protected function void

InitForegroundColor ( FSlateColor InForegroundColor
)

 Initialize ForegroundColor in the constructor before the SWidget is constructed.
Protected function void

InitIsFocusable ( bool InIsFocusable
)

 Initialize IsFocusable in the constructor before the SWidget is constructed.
Protected function void

InitScrollBarStyle ( const FScrollBarStyle& InScrollBarStyle
)

 Initialize the scrollbar style in the constructor before the SWidget is constructed.
Public function Const bool Is the combobox navigated by gamepad.
Public function Const bool Is the combobox focusable.
Public function Const bool Is the combobox arrow showing.
Public function Const UFunction BlueprintCallable, Category, Meta bool

IsOpen ()

  
Public function Virtual void  
Public function Virtual void  
Public function UFunction BlueprintCallable, Category void Refreshes the list of options.
Public function UFunction BlueprintCallable, Category bool

RemoveOption ( const FString& Option
)

  
Public function Virtual void

Serialize ( FArchive& Ar
)

  
Public function void

SetContentPadding ( FMargin InPadding
)

 Set the padding for content.
Public function void

SetEnableGamepadNavigationMode ( bool InEnableGamepadNavigationMode
)

 Set whether the combobox is navigated by gamepad.
Public function void

SetHasDownArrow ( bool InHasDownArrow
)

 Set whether the combobox arrow is showing.
Public function void

SetItemStyle ( const FTableRowStyle& InItemStyle
)

 Set the style of the items.
Public function void

SetMaxListHeight ( float InMaxHeight
)

 Set the maximum height of the combobox list.
Public function UFunction BlueprintCallable, Category void

SetSelectedIndex ( const int32 Index
)

  
Public function UFunction BlueprintCallable, Category void

SetSelectedOption ( FString Option
)

  
Public function void

SetWidgetStyle ( const FComboBoxStyle& InWidgetStyle
)

 Set the style of the combobox.
Protected function void

UpdateOrGenerateWidget ( TSharedPtr< FString > Item
)

 Refresh ComboBoxContent with the correct widget/data when the selected option changes

Overridden from UWidget

  Type Name Description
Public function Virtual const FText Gets the palette category of the widget
Protected function Virtual TSharedRef< SWidget > Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.

Overridden from UVisual

  Type Name Description
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Classes

  Type Name Description
Public class FOnOpeningEvent    
Public class FOnSelectionChangedEvent    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page