unreal.CommonTabListWidgetBase

class unreal.CommonTabListWidgetBase(outer=None, name='None')

Bases: unreal.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 construction

  • 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.

  • 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 widget

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

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

  • foreground_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 user

  • is_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_input_action_data (DataTableRowHandle): [Read-Write] The input action to listen for causing the next tab to be selected

  • on_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_selected (OnTabSelected): [Read-Write] Broadcasts when a new tab is selected.

  • on_visibility_changed (OnVisibilityChangedEvent): [Read-Write] Called when the visibility has changed

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

  • override_cursor (bool): [Read-Write] Override Cursor

  • 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_input_action_data (DataTableRowHandle): [Read-Write] The input action to listen for causing the previous tab to be selected

  • priority (int32): [Read-Write] Priority

  • 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.

  • 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] Stop Action

  • 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 only

  • 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

property auto_listen_for_input

[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

Parameters
  • tab_name_id (Name) –

  • reason (Text) –

get_active_tab()Name
Returns

The currently active (selected) tab

Return type

Name

get_linked_switcher()CommonAnimatedSwitcher
Returns

The switcher that this tab list is associated with and manipulates

Return type

CommonAnimatedSwitcher

get_selected_tab_id()Name

Get Selected Tab Id

Returns

Return type

Name

get_tab_button_base_by_id(tab_name_id)CommonButtonBase

Returns the tab button matching the ID, if found

Parameters

tab_name_id (Name) –

Returns

Return type

CommonButtonBase

get_tab_count()int32

Get Tab Count

Returns

Return type

int32

get_tab_id_at_index(index)Name

Get Tab Id at Index

Parameters

index (int32) –

Returns

Return type

Name

handle_post_linked_switcher_changed_bp()None

Handle Post Linked Switcher Changed BP

handle_pre_linked_switcher_changed_bp()None

Handle Pre Linked Switcher Changed BP

handle_tab_creation(tab_name_id, tab_button)None

Handle Tab Creation

Parameters
handle_tab_removal(tab_name_id, tab_button)None

Handle Tab Removal

Parameters
property next_tab_input_action_data

[Read-Only] The input action to listen for causing the next tab to be selected

Type

(DataTableRowHandle)

property on_tab_button_creation

[Read-Write] Broadcasts when a new tab is created.

Type

(OnTabButtonCreation)

property on_tab_button_removal

[Read-Write] Broadcasts when a new tab is created.

Type

(OnTabButtonRemoval)

property on_tab_selected

[Read-Write] Broadcasts when a new tab is selected.

Type

(OnTabSelected)

property previous_tab_input_action_data

[Read-Only] The input action to listen for causing the previous tab to be selected

Type

(DataTableRowHandle)

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.

Parameters
  • tab_name_id (Name) –

  • button_widget_type (type(Class)) – The widget type to create for this tab

  • content_widget (Widget) – The widget to associate with the registered tab

Returns

True if the new tab registered successfully and there were no name ID conflicts

Return type

bool

remove_all_tabs()None

Remove All Tabs

remove_tab(tab_name_id)bool

Remove Tab

Parameters

tab_name_id (Name) –

Returns

Return type

bool

select_tab_by_id(tab_name_id, suppress_click_feedback=False)bool

Selects the tab registered under the provided name ID

Parameters
  • tab_name_id (Name) – The name ID for the tab given when registered

  • suppress_click_feedback (bool) –

Returns

Return type

bool

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

Parameters
  • tab_name_id (Name) –

  • enable (bool) –

set_tab_interaction_enabled(tab_name_id, enable)None

Sets whether the tab associated with the given ID is interactable

Parameters
  • tab_name_id (Name) –

  • enable (bool) –

set_tab_visibility(tab_name_id, new_visibility)None

Sets the visibility of the tab associated with the given ID

Parameters