unreal.ScrollBox

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

Bases: PanelWidget

An arbitrary scrollable collection of widgets. Great for presenting 10-100 widgets in a list. Doesn’t support virtualization.

C++ Source:

  • Module: UMG

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

  • allow_overscroll (bool): [Read-Write] Allow Overscroll: Disable to stop scrollbars from activating inertial overscrolling

  • allow_right_click_drag_scrolling (bool): [Read-Write] Allow Right Click Drag Scrolling: Option to disable right-click-drag scrolling

  • always_show_scrollbar (bool): [Read-Write] Always Show Scrollbar

  • always_show_scrollbar_track (bool): [Read-Write] Always Show Scrollbar Track

  • animate_wheel_scrolling (bool): [Read-Write] Animate Wheel Scrolling: True to lerp smoothly when wheel scrolling along the scroll box

  • back_pad_scrolling (bool): [Read-Write] Back Pad Scrolling: Whether to back pad this scroll box, allowing user to scroll backward until child contents are no longer visible

  • 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

  • consume_mouse_wheel (ConsumeMouseWheel): [Read-Write] Consume Mouse Wheel: When mouse wheel events should be consumed.

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

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

  • front_pad_scrolling (bool): [Read-Write] Front Pad Scrolling: Whether to front pad this scroll box, allowing user to scroll forward until child contents are no longer visible

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

  • navigation_destination (DescendantScrollDestination): [Read-Write] Navigation Destination: Sets where to scroll a widget to when using explicit navigation or if ScrollWhenFocusChanges is enabled

  • navigation_scroll_padding (float): [Read-Write] Navigation Scroll Padding: The amount of padding to ensure exists between the item being navigated to, at the edge of the scrollbox. Use this if you want to ensure there’s a preview of the next item the user could scroll to.

  • on_user_scrolled (OnUserScrolledEvent): [Read-Write] On User Scrolled: Called when the scroll has changed

  • orientation (Orientation): [Read-Write] Orientation: The orientation of the scrolling and stacking in the box.

  • 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

  • scroll_bar_visibility (SlateVisibility): [Read-Write] Scroll Bar Visibility: Visibility

  • scroll_when_focus_changes (ScrollWhenFocusChanges): [Read-Write] Scroll when Focus Changes: Scroll behavior when user focus is given to a child widget

  • scrollbar_padding (Margin): [Read-Write] Scrollbar Padding: The margin around the scrollbar

  • scrollbar_thickness (Vector2D): [Read-Write] Scrollbar Thickness: The thickness of the scrollbar thumb

  • 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

  • wheel_scroll_multiplier (float): [Read-Write] Wheel Scroll Multiplier: The multiplier to apply when wheel scrolling

  • widget_bar_style (ScrollBarStyle): [Read-Write] Widget Bar Style: The bar style

  • widget_style (ScrollBoxStyle): [Read-Write] Widget Style: The style

property allow_overscroll: bool

[Read-Only] Allow Overscroll: Disable to stop scrollbars from activating inertial overscrolling

Type:

(bool)

property allow_right_click_drag_scrolling: bool

[Read-Only] Allow Right Click Drag Scrolling: Option to disable right-click-drag scrolling

Type:

(bool)

property always_show_scrollbar: bool

[Read-Only] Always Show Scrollbar

Type:

(bool)

property always_show_scrollbar_track: bool

[Read-Only] Always Show Scrollbar Track

Type:

(bool)

property animate_wheel_scrolling: bool

[Read-Only] Animate Wheel Scrolling: True to lerp smoothly when wheel scrolling along the scroll box

Type:

(bool)

property back_pad_scrolling: bool

[Read-Only] Back Pad Scrolling: Whether to back pad this scroll box, allowing user to scroll backward until child contents are no longer visible

Type:

(bool)

property consume_mouse_wheel: ConsumeMouseWheel

[Read-Only] Consume Mouse Wheel: When mouse wheel events should be consumed.

Type:

(ConsumeMouseWheel)

end_inertial_scrolling() → None

Instantly stops any inertial scrolling that is currently in progress

property front_pad_scrolling: bool

[Read-Only] Front Pad Scrolling: Whether to front pad this scroll box, allowing user to scroll forward until child contents are no longer visible

Type:

(bool)

get_scroll_offset() → float

Gets the scroll offset of the scrollbox in Slate Units.

Return type:

float

get_scroll_offset_of_end() → float

Gets the scroll offset of the bottom of the ScrollBox in Slate Units.

Return type:

float

get_view_fraction() → float

Gets the fraction currently visible in the scrollbox

Return type:

float

get_view_offset_fraction() → float

Get View Offset Fraction

Return type:

float

property navigation_destination: DescendantScrollDestination

[Read-Only] Navigation Destination: Sets where to scroll a widget to when using explicit navigation or if ScrollWhenFocusChanges is enabled

Type:

(DescendantScrollDestination)

property navigation_scroll_padding: float

[Read-Only] Navigation Scroll Padding: The amount of padding to ensure exists between the item being navigated to, at the edge of the scrollbox. Use this if you want to ensure there’s a preview of the next item the user could scroll to.

Type:

(float)

property on_user_scrolled: OnUserScrolledEvent

[Read-Write] On User Scrolled: Called when the scroll has changed

Type:

(OnUserScrolledEvent)

property orientation: Orientation

[Read-Only] Orientation: The orientation of the scrolling and stacking in the box.

Type:

(Orientation)

property scroll_bar_visibility: SlateVisibility

[Read-Only] Scroll Bar Visibility: Visibility

Type:

(SlateVisibility)

scroll_to_end() → None

Scrolls the ScrollBox to the bottom instantly during the next layout pass.

scroll_to_start() → None

Scrolls the ScrollBox to the top instantly

property scroll_when_focus_changes: ScrollWhenFocusChanges

[Read-Only] Scroll when Focus Changes: Scroll behavior when user focus is given to a child widget

Type:

(ScrollWhenFocusChanges)

scroll_widget_into_view(widget_to_find, animate_scroll=True, scroll_destination=DescendantScrollDestination.INTO_VIEW, padding=0.000000) → None

Scrolls the ScrollBox to the widget during the next layout pass.

Parameters:
property scrollbar_padding: Margin

[Read-Only] Scrollbar Padding: The margin around the scrollbar

Type:

(Margin)

property scrollbar_thickness: Vector2D

[Read-Only] Scrollbar Thickness: The thickness of the scrollbar thumb

Type:

(Vector2D)

set_allow_overscroll(new_allow_overscroll) → None

Set Allow Overscroll

Parameters:

new_allow_overscroll (bool) –

set_always_show_scrollbar(new_always_show_scrollbar) → None

Set Always Show Scrollbar

Parameters:

new_always_show_scrollbar (bool) –

set_animate_wheel_scrolling(should_animate_wheel_scrolling) → None

Set Animate Wheel Scrolling

Parameters:

should_animate_wheel_scrolling (bool) –

set_consume_mouse_wheel(new_consume_mouse_wheel) → None

Set Consume Mouse Wheel

Parameters:

new_consume_mouse_wheel (ConsumeMouseWheel) –

set_navigation_destination(new_navigation_destination) → None

Set Navigation Destination

Parameters:

new_navigation_destination (DescendantScrollDestination) –

set_orientation(new_orientation) → None

Set Orientation

Parameters:

new_orientation (Orientation) –

set_scroll_bar_visibility(new_scroll_bar_visibility) → None

Set Scroll Bar Visibility

Parameters:

new_scroll_bar_visibility (SlateVisibility) –

set_scroll_offset(new_scroll_offset) → None

Updates the scroll offset of the scrollbox.

Parameters:

new_scroll_offset (float) – is in Slate Units.

set_scroll_when_focus_changes(new_scroll_when_focus_changes) → None

Set Scroll when Focus Changes

Parameters:

new_scroll_when_focus_changes (ScrollWhenFocusChanges) –

set_scrollbar_padding(new_scrollbar_padding) → None

Set Scrollbar Padding

Parameters:

new_scrollbar_padding (Margin) –

set_scrollbar_thickness(new_scrollbar_thickness) → None

Set Scrollbar Thickness

Parameters:

new_scrollbar_thickness (Vector2D) –

set_wheel_scroll_multiplier(new_wheel_scroll_multiplier) → None

Set Wheel Scroll Multiplier

Parameters:

new_wheel_scroll_multiplier (float) –

property wheel_scroll_multiplier: float

[Read-Only] Wheel Scroll Multiplier: The multiplier to apply when wheel scrolling

Type:

(float)

property widget_bar_style: ScrollBarStyle

[Read-Write] Widget Bar Style: The bar style

Type:

(ScrollBarStyle)

property widget_style: ScrollBoxStyle

[Read-Write] Widget Style: The style

Type:

(ScrollBoxStyle)