Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

UComboBoxString

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

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UComboBoxString

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

	Name	Description
bool	bIsFocusable
TSharedPtr< SBo...	ComboBoxContent	A shared pointer to a container that holds the combobox content that is selected
FMargin	ContentPadding
TSharedPtr< FSt...	CurrentOptionPtr	A shared pointer to the current selected string
TWeakPtr< SText...	DefaultComboBoxContent	If OnGenerateWidgetEvent is not bound, this will store the default STextBlock generated
bool	EnableGamepadNavigationMode	When false, directional keys will change the selection.
FSlateFontInfo	Font	The default font to use in the combobox, only applies if you're not implementing OnGenerateWidgetEvent to factory each new entry.
FSlateColor	ForegroundColor	The foreground color to pass through the hierarchy.
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.
FTableRowStyle	ItemStyle	The item row style.
float	MaxListHeight	The max height of the combobox list that opens
TSharedPtr< SCo...	MyComboBox	A shared pointer to the underlying slate combobox
FGenerateWidget...	OnGenerateWidgetEvent	Called when the widget is needed for the item.
FOnOpeningEvent	OnOpening	Called when the combobox is opening
FOnSelectionCha...	OnSelectionChanged	Called when a new item is selected in the combobox.
TArray< TShared...	Options	The true objects bound to the Slate combobox.
FComboBoxStyle	WidgetStyle	The style.

Constructors

	Name	Description
	UComboBoxString ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	AddOption ( const FString& Option )
void	ClearOptions()
void	ClearSelection()
int32	FindOptionIndex ( const FString& Option )
FString	GetOptionAtIndex ( int32 Index )
int32	GetOptionCount()	Returns the number of options
int32	GetSelectedIndex()
FString	GetSelectedOption()
TSharedRef< ...	HandleGenerateWidget ( TSharedPtr< FString > Item )	Called by slate when it needs to generate a new item for the combobox
void	HandleOpening()	Called by slate when the underlying combobox is opening
void	HandleSelectionChanged ( TSharedPtr< FString > Item, ESelectInfo::Type SelectionType )	Called by slate when the underlying combobox selection changes
bool	IsOpen()
void	RefreshOptions()	Refreshes the list of options.
bool	RemoveOption ( const FString& Option )
void	SetSelectedIndex ( const int32 Index )
void	SetSelectedOption ( FString Option )
void	UpdateOrGenerateWidget ( TSharedPtr< FString > Item )	Refresh ComboBoxContent with the correct widget/data when the selected option changes

Overridden from UWidget

		Name	Description
	const FText	GetPaletteCategory()	Gets the palette category of the widget
	TSharedRef< ...	RebuildWidget()	Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.

Overridden from UVisual

		Name	Description
	void	ReleaseSlateResources ( bool bReleaseChildren )

Overridden from UObject

	Name	Description
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Classes

	Name	Description
	FOnOpeningEvent
	FOnSelectionChangedEvent

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss