unreal.ComboBoxString

class unreal.ComboBoxString(outer: Object | None = None, name: Name | str = 'None')

Bases: Widget

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

C++ Source:

  • Module: UMG

  • File: ComboBoxString.h

Editor Properties: (see get_editor_property/set_editor_property)

  • accessible_behavior (SlateAccessibleBehavior): [Read-Write] Whether or not the widget is accessible, and how to describe it. If set to custom, additional customization options will appear.

  • accessible_summary_behavior (SlateAccessibleBehavior): [Read-Write] How to describe this widget when it’s being presented through a summary of a parent widget. If set to custom, additional customization options will appear.

  • accessible_summary_text (Text): [Read-Write] When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.

  • accessible_text (Text): [Read-Write] When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.

  • can_children_be_accessible (bool): [Read-Write] Whether or not children of this widget can appear as distinct accessible widgets.

  • clipping (WidgetClipping): [Read-Write] Controls how the clipping behavior of this widget. Normally content that overflows the bounds of the widget continues rendering. Enabling clipping prevents that overflowing content from being seen.

    NOTE: Elements in different clipping spaces can not be batched together, and so there is a performance cost to clipping. Do not enable clipping unless a panel actually needs to prevent content from showing up outside its bounds.

  • content_padding (Margin): [Read-Write]

  • cursor (MouseCursor): [Read-Write] The cursor to show when the mouse is over the widget

  • default_options (Array[str]): [Read-Write] The default list of items to be displayed on the combobox.

  • enable_gamepad_navigation_mode (bool): [Read-Write] When false, directional keys will change the selection. When true, ComboBox must be activated and will only capture arrow input while activated.

  • flow_direction_preference (FlowDirectionPreference): [Read-Write] Allows you to set a new flow direction

  • font (SlateFontInfo): [Read-Write] The default font to use in the combobox, only applies if you’re not implementing OnGenerateWidgetEvent to factory each new entry.

  • foreground_color (SlateColor): [Read-Write] The foreground color to pass through the hierarchy.

  • has_down_arrow (bool): [Read-Write] 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.

  • is_enabled (bool): [Read-Write] Sets whether this widget can be modified interactively by the user

  • is_focusable (bool): [Read-Write]

  • is_volatile (bool): [Read-Write] If true prevents the widget or its child’s geometry or layout information from being cached. If this widget changes every frame, but you want it to still be in an invalidation panel you should make it as volatile instead of invalidating it every frame, which would prevent the invalidation panel from actually ever caching anything.

  • item_style (TableRowStyle): [Read-Write] The item row style.

  • max_list_height (float): [Read-Write] The max height of the combobox list that opens

  • navigation (WidgetNavigation): [Read-Write] The navigation object for this widget is optionally created if the user has configured custom navigation rules for this widget in the widget designer. Those rules determine how navigation transitions can occur between widgets.

  • on_generate_widget_event (GenerateWidgetForString): [Read-Write] Called when the widget is needed for the item.

  • on_opening (OnOpeningEvent): [Read-Write] Called when the combobox is opening

  • on_selection_changed (OnSelectionChangedEvent): [Read-Write] Called when a new item is selected in the combobox.

  • override_accessible_defaults (bool): [Read-Write] Override all of the default accessibility behavior and text for this widget.

  • override_cursor (bool): [Read-Write]

  • render_opacity (float): [Read-Write] The opacity of the widget

  • render_transform (WidgetTransform): [Read-Write] The render transform of the widget allows for arbitrary 2D transforms to be applied to the widget.

  • render_transform_pivot (Vector2D): [Read-Write] The render transform pivot controls the location about which transforms are applied. This value is a normalized coordinate about which things like rotations will occur.

  • scroll_bar_style (ScrollBarStyle): [Read-Write] The scroll bar style.

  • selected_option (str): [Read-Write] The item in the combobox to select by default

  • slot (PanelSlot): [Read-Write] The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.

  • tool_tip_text (Text): [Read-Write] Tooltip text to show when the user hovers over the widget with the mouse

  • tool_tip_widget (Widget): [Read-Only] Tooltip widget to show when the user hovers over the widget with the mouse

  • visibility (SlateVisibility): [Read-Write] The visibility of the widget

  • widget_style (ComboBoxStyle): [Read-Write] The style.

add_option(option) → None

Add Option

Parameters:

option (str) –

clear_options() → None

Clear Options

clear_selection() → None

Clear Selection

property content_padding: Margin

[Read-Write]

Type:

(Margin)

property enable_gamepad_navigation_mode: bool

[Read-Write] When false, directional keys will change the selection. When true, ComboBox must be activated and will only capture arrow input while activated.

Type:

(bool)

find_option_index(option) → int32

Find Option Index

Parameters:

option (str) –

Return type:

int32

property font: SlateFontInfo

[Read-Only] The default font to use in the combobox, only applies if you’re not implementing OnGenerateWidgetEvent to factory each new entry.

Type:

(SlateFontInfo)

property foreground_color: SlateColor

[Read-Only] The foreground color to pass through the hierarchy.

Type:

(SlateColor)

get_option_at_index(index) → str

Get Option at Index

Parameters:

index (int32) –

Return type:

str

get_option_count() → int32

Returns the number of options

Return type:

int32

get_selected_index() → int32

Get Selected Index

Return type:

int32

get_selected_option() → str

Get Selected Option

Return type:

str

property has_down_arrow: bool

[Read-Write] 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.

Type:

(bool)

property is_focusable: bool

[Read-Only]

Type:

(bool)

is_open() → bool

Is Open

Return type:

bool

property item_style: TableRowStyle

[Read-Write] The item row style.

Type:

(TableRowStyle)

property max_list_height: float

[Read-Write] The max height of the combobox list that opens

Type:

(float)

property on_opening: OnOpeningEvent

[Read-Write] Called when the combobox is opening

Type:

(OnOpeningEvent)

property on_selection_changed: OnSelectionChangedEvent

[Read-Write] Called when a new item is selected in the combobox.

Type:

(OnSelectionChangedEvent)

refresh_options() → None

Refreshes the list of options. If you added new ones, and want to update the list even if it’s currently being displayed use this.

remove_option(option) → bool

Remove Option

Parameters:

option (str) –

Return type:

bool

property scroll_bar_style: ScrollBarStyle

[Read-Only] The scroll bar style.

Type:

(ScrollBarStyle)

set_selected_index(index) → None

Set Selected Index

Parameters:

index (int32) –

set_selected_option(option) → None

Set Selected Option

Parameters:

option (str) –

property widget_style: ComboBoxStyle

[Read-Write] The style.

Type:

(ComboBoxStyle)