- class unreal.CommonTabListWidgetBase(outer=None, name='None')¶
Base class for a list of selectable tabs that correspondingly activate and display an arbitrary widget in a linked switcher
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.
auto_listen_for_input(bool): [Read-Write] Auto Listen for Input: Whether to register to handle tab list input immediately upon construction
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] Clipping: 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] Color and Opacity: The color and opacity of this widget. Tints all child widgets.
consume_pointer_input(bool): [Read-Write] Consume Pointer Input: Set this to true if you don’t want any pointer (mouse and touch) input to bubble past this widget
cursor(MouseCursor): [Read-Write] Cursor: The cursor to show when the mouse is over the widget
display_in_action_bar(bool): [Read-Write] Display in Action Bar: True to generally display this widget’s actions in the action bar, assuming it has actions.
flow_direction_preference(FlowDirectionPreference): [Read-Write] Flow Direction Preference: Allows you to set a new flow direction
foreground_color(SlateColor): [Read-Write] Foreground Color: 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] Is Enabled: Sets whether this widget can be modified interactively by the user
is_focusable(bool): [Read-Write] Is Focusable: Setting this flag to true, allows this widget to accept focus when clicked, or when navigated to.
is_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.
navigation(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.
next_tab_input_action_data(DataTableRowHandle): [Read-Write] Next Tab Input Action Data: The input action to listen for causing the next tab to be selected
on_tab_button_creation(OnTabButtonCreation): [Read-Write] On Tab Button Creation: Broadcasts when a new tab is created.
on_tab_button_removal(OnTabButtonRemoval): [Read-Write] On Tab Button Removal: Broadcasts when a new tab is created.
on_tab_selected(OnTabSelected): [Read-Write] On Tab Selected: Broadcasts when a new tab is selected.
on_visibility_changed(OnVisibilityChangedEvent): [Read-Write] On Visibility Changed: Called when the visibility has changed
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 Cursor
padding(Margin): [Read-Write] Padding: The padding area around the content.
preview_background(Texture2D): [Read-Write] Preview Background: 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_input_action_data(DataTableRowHandle): [Read-Write] Previous Tab Input Action Data: The input action to listen for causing the previous tab to be selected
priority(int32): [Read-Write] Priority
render_opacity(float): [Read-Write] Render Opacity: The opacity of the widget
render_transform(WidgetTransform): [Read-Write] Render Transform: The render transform of the widget allows for arbitrary 2D transforms to be applied to the widget.
render_transform_pivot(Vector2D): [Read-Write] Render Transform Pivot: 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] Slot: The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.
stop_action(bool): [Read-Write] Stop Action
tick_frequency(WidgetTickFrequency): [Read-Write] Tick Frequency: 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 only
tool_tip_text(Text): [Read-Write] Tool Tip Text: Tooltip text to show when the user hovers over the widget with the mouse
tool_tip_widget(Widget): [Read-Only] Tool Tip Widget: Tooltip widget to show when the user hovers over the widget with the mouse
visibility(SlateVisibility): [Read-Write] Visibility: The visibility of the widget
- property auto_listen_for_input¶
[Read-Only] Auto Listen for Input: Whether to register to handle tab list input immediately upon construction
- disable_tab_with_reason(tab_name_id, reason) None ¶
Disables the tab associated with the given ID with a reason
The switcher that this tab list is associated with and manipulates
- Return type
Returns the tab button matching the ID, if found
- get_tab_count() int32 ¶
Get Tab Count
- Return type
Handle Post Linked Switcher Changed BP
Handle Pre Linked Switcher Changed BP
- handle_tab_creation(tab_name_id, tab_button) None ¶
Handle Tab Creation
- handle_tab_removal(tab_name_id, tab_button) None ¶
Handle Tab Removal
- property next_tab_input_action_data¶
[Read-Only] Next Tab Input Action Data: The input action to listen for causing the next tab to be selected
[Read-Write] On Tab Button Creation: Broadcasts when a new tab is created.
[Read-Write] On Tab Button Removal: Broadcasts when a new tab is created.
- property on_tab_selected¶
[Read-Write] On Tab Selected: Broadcasts when a new tab is selected.
- property previous_tab_input_action_data¶
[Read-Only] Previous Tab Input Action Data: The input action to listen for causing the previous tab to be selected
- register_tab(tab_name_id, button_widget_type, content_widget) bool ¶
Registers and adds a new tab to the list that corresponds to a given widget instance. If not present in the linked switcher, it will be added.
- select_tab_by_id(tab_name_id, suppress_click_feedback=False) bool ¶
Selects the tab registered under the provided name ID
Establishes the activatable widget switcher instance that this tab list should interact with
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
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