unreal.WidgetSwitcher

class unreal.WidgetSwitcher(outer: Optional[Object] = None, name: Union[Name, str] = 'None')

Bases: PanelWidget

A widget switcher is like a tab control, but without tabs. At most one widget is visible at time.

C++ Source:

  • Module: UMG

  • File: WidgetSwitcher.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.

  • active_widget_index (int32): [Read-Write] Active Widget Index: The slot index to display

  • 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

  • cursor (MouseCursor): [Read-Write] Cursor

  • flow_direction_preference (FlowDirectionPreference): [Read-Write] Flow Direction Preference

  • is_enabled (bool): [Read-Write] Is Enabled

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

  • 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

  • render_opacity (float): [Read-Write] Render Opacity

  • render_transform (WidgetTransform): [Read-Write] Render Transform

  • render_transform_pivot (Vector2D): [Read-Write] Render Transform Pivot

  • slot (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 Text

  • tool_tip_widget (Widget): [Read-Only] Tool Tip Widget

  • visibility (SlateVisibility): [Read-Write] Visibility

property active_widget_index: int

[Read-Only] Active Widget Index: The slot index to display

Type:

(int32)

get_active_widget() → Widget

Get the reference of the currently active widget

Return type:

Widget

get_active_widget_index() → int32

Gets the slot index of the currently active widget

Return type:

int32

get_num_widgets() → int32

Gets the number of widgets that this switcher manages.

Return type:

int32

get_widget_at_index(index) → Widget

Get a widget at the provided index

Parameters:

index (int32) –

Return type:

Widget

set_active_widget(widget) → None

Activates the widget and makes it the active index.

Parameters:

widget (Widget) –

set_active_widget_index(index) → None

Activates the widget at the specified index.

Parameters:

index (int32) –