unreal.CommonTabListWidgetBase
¶
- class unreal.CommonTabListWidgetBase(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
CommonUserWidget
Base class for a list of selectable tabs that correspondingly activate and display an arbitrary widget in a linked switcher
C++ Source:
Plugin: CommonUI
Module: CommonUI
File: CommonTabListWidgetBase.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.auto_listen_for_input
(bool): [Read-Write] Whether to register to handle tab list input immediately upon constructioncan_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.
color_and_opacity
(LinearColor): [Read-Write] The color and opacity of this widget. Tints all child widgets.consume_pointer_input
(bool): [Read-Write] Set this to true if you don’t want any pointer (mouse and touch) input to bubble past this widgetcursor
(MouseCursor): [Read-Write] The cursor to show when the mouse is over the widgetdefer_rebuilding_tab_list
(bool): [Read-Write] Whether to defer until next tick rebuilding tab list when inserting new tab (rather than adding to the end). Useful if inserting multiple tabs in the same tick as the tab list will only be rebuilt once.display_in_action_bar
(bool): [Read-Write] True to generally display this widget’s actions in the action bar, assuming it has actions.flow_direction_preference
(FlowDirectionPreference): [Read-Write] Allows you to set a new flow directionforeground_color
(SlateColor): [Read-Write] The foreground color of the widget, this is inherited by sub widgets. Any color property that is marked as inherit will use this color.is_enabled
(bool): [Read-Write] Sets whether this widget can be modified interactively by the useris_focusable
(bool): [Read-Write] Setting this flag to true, allows this widget to accept focus when clicked, or when navigated to.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.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.next_tab_enhanced_input_action
(InputAction): [Read-Write] The input action to listen for causing the next tab to be selectednext_tab_input_action_data
(DataTableRowHandle): [Read-Write] The input action to listen for causing the next tab to be selectedon_tab_button_creation
(OnTabButtonCreation): [Read-Write] Broadcasts when a new tab is created.on_tab_button_removal
(OnTabButtonRemoval): [Read-Write] Broadcasts when a new tab is created.on_tab_list_rebuilt
(OnTabListRebuilt): [Read-Write] Broadcasts when the tab list has been rebuilt (after a new tab has been inserted rather than added to the end).on_tab_selected
(OnTabSelected): [Read-Write] Broadcasts when a new tab is selected.on_visibility_changed
(OnVisibilityChangedEvent): [Read-Write] Called when the visibility has changedoverride_accessible_defaults
(bool): [Read-Write] Override all of the default accessibility behavior and text for this widget.override_cursor
(bool): [Read-Write]padding
(Margin): [Read-Write] The padding area around the content.preview_background
(Texture2D): [Read-Write] A preview background that you can use when designing the UI to get a sense of scale on the screen. Use a texture with a screenshot of your game in it, for example if you were designing a HUD.previous_tab_enhanced_input_action
(InputAction): [Read-Write] The input action to listen for causing the previous tab to be selectedprevious_tab_input_action_data
(DataTableRowHandle): [Read-Write] The input action to listen for causing the previous tab to be selectedpriority
(int32): [Read-Write]render_opacity
(float): [Read-Write] The opacity of the widgetrender_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.slot
(PanelSlot): [Read-Write] The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.stop_action
(bool): [Read-Write]tick_frequency
(WidgetTickFrequency): [Read-Write] This widget is allowed to tick. If this is unchecked tick will never be called, animations will not play correctly, and latent actions will not execute. Uncheck this for performance reasons onlytool_tip_text
(Text): [Read-Write] Tooltip text to show when the user hovers over the widget with the mousetool_tip_widget
(Widget): [Read-Only] Tooltip widget to show when the user hovers over the widget with the mousevisibility
(SlateVisibility): [Read-Write] The visibility of the widget
- property auto_listen_for_input: bool¶
[Read-Only] Whether to register to handle tab list input immediately upon construction
- Type:
(bool)
- disable_tab_with_reason(tab_name_id, reason) None ¶
Disables the tab associated with the given ID with a reason
- get_linked_switcher() CommonAnimatedSwitcher ¶
- Returns:
The switcher that this tab list is associated with and manipulates
- Return type:
- get_tab_button_base_by_id(tab_name_id) CommonButtonBase ¶
Returns the tab button matching the ID, if found
- Parameters:
tab_name_id (Name) –
- Return type:
- get_tab_count() int32 ¶
Get Tab Count
- Return type:
int32
- handle_tab_creation(tab_name_id, tab_button) None ¶
Handle Tab Creation
- Parameters:
tab_name_id (Name) –
tab_button (CommonButtonBase) –
- handle_tab_removal(tab_name_id, tab_button) None ¶
Handle Tab Removal
- Parameters:
tab_name_id (Name) –
tab_button (CommonButtonBase) –
- property next_tab_enhanced_input_action: InputAction¶
[Read-Only] The input action to listen for causing the next tab to be selected
- Type:
- property next_tab_input_action_data: DataTableRowHandle¶
[Read-Only] The input action to listen for causing the next tab to be selected
- Type:
- property on_tab_button_creation: OnTabButtonCreation¶
[Read-Write] Broadcasts when a new tab is created.
- Type:
(OnTabButtonCreation)
- property on_tab_button_removal: OnTabButtonRemoval¶
[Read-Write] Broadcasts when a new tab is created.
- Type:
(OnTabButtonRemoval)
- property on_tab_list_rebuilt: OnTabListRebuilt¶
[Read-Write] Broadcasts when the tab list has been rebuilt (after a new tab has been inserted rather than added to the end).
- Type:
(OnTabListRebuilt)
- property on_tab_selected: OnTabSelected¶
[Read-Write] Broadcasts when a new tab is selected.
- Type:
(OnTabSelected)
- property previous_tab_enhanced_input_action: InputAction¶
[Read-Only] The input action to listen for causing the previous tab to be selected
- Type:
- property previous_tab_input_action_data: DataTableRowHandle¶
[Read-Only] The input action to listen for causing the previous tab to be selected
- Type:
- select_tab_by_id(tab_name_id, suppress_click_feedback=False) bool ¶
Selects the tab registered under the provided name ID
- set_linked_switcher(common_switcher) None ¶
Establishes the activatable widget switcher instance that this tab list should interact with
- Parameters:
common_switcher (CommonAnimatedSwitcher) – The switcher that this tab list should be associated with and manipulate
- set_listening_for_input(should_listen) None ¶
Set Listening for Input
- Parameters:
should_listen (bool) –
- set_tab_enabled(tab_name_id, enable) None ¶
Sets whether the tab associated with the given ID is enabled/disabled
- set_tab_interaction_enabled(tab_name_id, enable) None ¶
Sets whether the tab associated with the given ID is interactable
- set_tab_visibility(tab_name_id, new_visibility) None ¶
Sets the visibility of the tab associated with the given ID
- Parameters:
tab_name_id (Name) –
new_visibility (SlateVisibility) –