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

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 FGenerateWidgetEvent OnGenerateContentWidget Called when the widget is needed for the content.
Public variable FGenerateWidgetEvent OnGenerateItemWidget 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.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

AddOption ( FName Option
)

 Add an element to the option list.
Public function void Remove all the elements of the option list.
Public function 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 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 bool

IsOpen ()

 Is the combobox menu opened.
Public function 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 void 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    

Deprecated Variables

  Type Name Description
Public variable bool bEnableGamepadNavigationMode Direct access to bEnableGamepadNavigationMode is deprecated. Please use the getter or setter.
Public variable bool bHasDownArrow Direct access to bHasDownArrow is deprecated. Please use the getter or setter.
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 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 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