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

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
Protected variable TSharedPtr< SBox > ComboBoxContent A shared pointer to a container that holds the combobox content that is selected
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
Protected variable TSharedPtr< SComboBox< TSharedPtr< FString > > > MyComboBox A shared pointer to the underlying slate combobox
Public variable FGenerateWidgetForString OnGenerateWidgetEvent Called when the widget is needed for the item.
Public variable FOnOpeningEvent OnOpening Called when the combobox is opening
Public variable 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.

Constructors

  Type Name Description
Public function  

UComboBoxString ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void

AddOption ( const FString& Option
)

  
Public function void  
Public function void  
Public function Const 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 FString

GetOptionAtIndex ( int32 Index
)

  
Public function Const int32 Returns the number of options
Public function Const const FScrollBarStyle & Get the style of the scrollbar.
Public function Const int32  
Public function Const FString  
Public function Const const FComboBoxStyle & Get the style of the combobox.
Protected function Virtual Const TSharedRef< SWidget > 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 Called by slate when the underlying combobox selection changes
Protected function void 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 bool

IsOpen ()

  
Public function void Refreshes the list of options.
Public function bool

RemoveOption ( const FString& Option
)

  
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 void

SetSelectedIndex ( const int32 Index
)

  
Public function void  
Public function void

SetWidgetStyle ( const FComboBoxStyle& InWidgetStyle
)

 Set the style of the combobox.
Protected function void 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
)

  

Overridden from UObject

  Type Name Description
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Classes

  Type Name Description
Public class FOnOpeningEvent    
Public class FOnSelectionChangedEvent    

Deprecated Variables

  Type Name Description
Public variable bool bIsFocusable 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.
Public variable FMargin ContentPadding Direct access to ContentPadding is deprecated. Please use the getter or setter.
Public variable bool EnableGamepadNavigationMode Direct access to EnableGamepadNavigationMode is deprecated. Please use the getter or setter.
Public variable FSlateFontInfo Font 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.
Public variable FSlateColor ForegroundColor 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.
Public variable bool HasDownArrow Direct access to HasDownArrow is deprecated. Please use the getter or setter.
Public variable FTableRowStyle ItemStyle Direct access to ItemStyle is deprecated. Please use the getter or setter.
Public variable float MaxListHeight Direct access to MaxListHeight is deprecated. Please use the getter or setter.
Public variable FScrollBarStyle ScrollBarStyle 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.
Public variable FComboBoxStyle WidgetStyle Direct access to WidgetStyle is deprecated. Please use the getter or setter.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page