1. Epic GamesDeveloper
  3. UComboBoxKey

UComboBoxKey

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/ComboBoxKey.h
Include #include "Components/ComboBoxKey.h"

Syntax

UCLASS (Meta=(DisplayName="ComboBox (Key)"), MinimalAPI)  
class UComboBoxKey : 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. Use OnGenerateConentWidgetEvent to return a custom built widget.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite getter, setter bool bEnableGamepadNavigationMode When false, directional keys will change the selection.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite getter, setter bool bHasDownArrow 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 BlueprintReadOnly getter bool bIsFocusable When true, allows the combo box to receive keyboard focus
Public variable UProperty Category, EditAnywhere BlueprintReadWrite getter, setter FMargin ContentPadding  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly getter FSlateColor ForegroundColor The foreground color to pass through the hierarchy.
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
Public variable UProperty Category, EditAnywhere, Meta FGenerateWidgetEvent OnGenerateContentWidget Called when the widget is needed for the content.
Public variable UProperty Category, EditAnywhere, Meta FGenerateWidgetEvent OnGenerateItemWidget 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.
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 combobox style.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void

AddOption ( FName Option
)

 Add an element to the option list.
Public function UFunction BlueprintCallable, Category void Remove all the elements of the option list.
Public function UFunction BlueprintCallable, Category void Clear the current selection.
Public function Const FMargin Get the padding for content.
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 const FScrollBarStyle & Get the style of the scrollbar.
Public function Const UFunction BlueprintCallable, Category FName Get the current selected option
Public function Const const FComboBoxStyle & Get the style of the combobox.
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 ()

 Is the combobox menu opened.
Public function UFunction BlueprintCallable, Category bool

RemoveOption ( FName Option
)

 Remove an element to the option list.
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

SetSelectedOption ( FName Option
)

 Set the current selected option.
Public function void

SetWidgetStyle ( const FComboBoxStyle& InWidgetStyle
)

 Set the style of the combobox.

Overridden from UWidget

  Type Name Description
Public function Virtual const FText Gets the palette category of the widget

Overridden from UVisual

  Type Name Description
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Classes

  Type Name Description
Public class FGenerateWidgetEvent    
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