unreal.ComboBoxString
¶
- class unreal.ComboBoxString(outer: Optional[Object] = None, name: Union[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] Accessible Behavior: 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] Accessible Summary Behavior: 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] Accessible Summary Text: When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.accessible_text
(Text): [Read-Write] Accessible Text: 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] Can Children be Accessible: Whether or not children of this widget can appear as distinct accessible widgets.clipping
(WidgetClipping): [Read-Write] Clippingcontent_padding
(Margin): [Read-Write] Content Paddingcursor
(MouseCursor): [Read-Write] Cursordefault_options
(Array[str]): [Read-Write] Default Options: The default list of items to be displayed on the combobox.enable_gamepad_navigation_mode
(bool): [Read-Write] Enable Gamepad Navigation Mode: 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] Flow Direction Preferencefont
(SlateFontInfo): [Read-Write] Font: 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] Foreground Color: The foreground color to pass through the hierarchy.has_down_arrow
(bool): [Read-Write] Has Down Arrow: 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] Is Enabledis_focusable
(bool): [Read-Write] Is Focusableis_volatile
(bool): [Read-Write] Is Volatile: 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] Item Style: The item row style.max_list_height
(float): [Read-Write] Max List Height: The max height of the combobox list that opensnavigation
(WidgetNavigation): [Read-Write] Navigation: 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] On Generate Widget Event: Called when the widget is needed for the item.on_opening
(OnOpeningEvent): [Read-Write] On Opening: Called when the combobox is openingon_selection_changed
(OnSelectionChangedEvent): [Read-Write] On Selection Changed: Called when a new item is selected in the combobox.override_accessible_defaults
(bool): [Read-Write] Override Accessible Defaults: Override all of the default accessibility behavior and text for this widget.override_cursor
(bool): [Read-Write] Override Cursorrender_opacity
(float): [Read-Write] Render Opacityrender_transform
(WidgetTransform): [Read-Write] Render Transformrender_transform_pivot
(Vector2D): [Read-Write] Render Transform Pivotselected_option
(str): [Read-Write] Selected Option: The item in the combobox to select by defaultslot
(PanelSlot): [Read-Write] Slot: The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.tool_tip_text
(Text): [Read-Write] Tool Tip Texttool_tip_widget
(Widget): [Read-Only] Tool Tip Widgetvisibility
(SlateVisibility): [Read-Write] Visibilitywidget_style
(ComboBoxStyle): [Read-Write] Widget Style: The style.
[Read-Only] Enable Gamepad Navigation Mode: When false, directional keys will change the selection. When true, ComboBox must be activated and will only capture arrow input while activated.
- Type:
(bool)
- property font: SlateFontInfo¶
[Read-Only] Font: The default font to use in the combobox, only applies if you’re not implementing OnGenerateWidgetEvent to factory each new entry.
- Type:
- property foreground_color: SlateColor¶
[Read-Only] Foreground Color: The foreground color to pass through the hierarchy.
- Type:
- get_option_count() int32 ¶
Returns the number of options
- Return type:
int32
- get_selected_index() int32 ¶
Get Selected Index
- Return type:
int32
- property has_down_arrow: bool¶
[Read-Only] Has Down Arrow: 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 item_style: TableRowStyle¶
[Read-Write] Item Style: The item row style.
- Type:
- property max_list_height: float¶
[Read-Only] Max List Height: The max height of the combobox list that opens
- Type:
(float)
- property on_opening: OnOpeningEvent¶
[Read-Write] On Opening: Called when the combobox is opening
- Type:
(OnOpeningEvent)
- property on_selection_changed: OnSelectionChangedEvent¶
[Read-Write] On Selection Changed: 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.
- property widget_style: ComboBoxStyle¶
[Read-Write] Widget Style: The style.
- Type: