unreal.ScrollBox
¶
-
class
unreal.
ScrollBox
(outer=None, name='None')¶ Bases:
unreal.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] 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.allow_overscroll
(bool): [Read-Write] Disable to stop scrollbars from activating inertial overscrollingallow_right_click_drag_scrolling
(bool): [Read-Write] Option to disable right-click-drag scrollingalways_show_scrollbar
(bool): [Read-Write] Always Show Scrollbaralways_show_scrollbar_track
(bool): [Read-Write] Always Show Scrollbar Trackanimate_wheel_scrolling
(bool): [Read-Write] True to lerp smoothly when wheel scrolling along the scroll boxcan_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.
consume_mouse_wheel
(ConsumeMouseWheel): [Read-Write] When mouse wheel events should be consumed.cursor
(MouseCursor): [Read-Write] The cursor to show when the mouse is over the widgetflow_direction_preference
(FlowDirectionPreference): [Read-Write] Allows you to set a new flow directionis_enabled
(bool): [Read-Write] Sets whether this widget can be modified interactively by the useris_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.navigation_destination
(DescendantScrollDestination): [Read-Write] Sets where to scroll a widget to when using explicit navigation or if ScrollWhenFocusChanges is enablednavigation_scroll_padding
(float): [Read-Write] 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] Called when the scroll has changedorientation
(Orientation): [Read-Write] The orientation of the scrolling and stacking in the box.override_accessible_defaults
(bool): [Read-Write] Override all of the default accessibility behavior and text for this widget.override_cursor
(bool): [Read-Write] Override Cursorrender_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.scroll_bar_visibility
(SlateVisibility): [Read-Write] Visibilityscroll_when_focus_changes
(ScrollWhenFocusChanges): [Read-Write] Scroll behavior when user focus is given to a child widgetscrollbar_padding
(Margin): [Read-Write] The margin around the scrollbarscrollbar_thickness
(Vector2D): [Read-Write] The thickness of the scrollbar thumbslot
(PanelSlot): [Read-Write] The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.tool_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 widgetwheel_scroll_multiplier
(float): [Read-Write] The multiplier to apply when wheel scrollingwidget_bar_style
(ScrollBarStyle): [Read-Write] The bar stylewidget_style
(ScrollBoxStyle): [Read-Write] The style
-
property
allow_overscroll
¶ [Read-Only] Disable to stop scrollbars from activating inertial overscrolling
- Type
(bool)
-
property
allow_right_click_drag_scrolling
¶ [Read-Only] Option to disable right-click-drag scrolling
- Type
(bool)
-
property
animate_wheel_scrolling
¶ [Read-Only] True to lerp smoothly when wheel scrolling along the scroll box
- Type
(bool)
-
property
consume_mouse_wheel
¶ [Read-Only] When mouse wheel events should be consumed.
- Type
-
end_inertial_scrolling
() → None¶ Instantly stops any inertial scrolling that is currently in progress
-
get_scroll_offset
() → float¶ Gets the scroll offset of the scrollbox in Slate Units.
- Returns
- Return type
-
get_scroll_offset_of_end
() → float¶ Gets the scroll offset of the bottom of the ScrollBox in Slate Units.
- Returns
- Return type
[Read-Only] Sets where to scroll a widget to when using explicit navigation or if ScrollWhenFocusChanges is enabled
- Type
[Read-Only] 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
¶ [Read-Write] Called when the scroll has changed
- Type
-
property
orientation
¶ [Read-Only] The orientation of the scrolling and stacking in the box.
- Type
-
property
scroll_bar_visibility
¶ [Read-Only] Visibility
- Type
-
property
scroll_when_focus_changes
¶ [Read-Only] Scroll behavior when user focus is given to a child widget
- Type
-
scroll_widget_into_view
(widget_to_find, animate_scroll=True, scroll_destination=DescendantScrollDestination.INTO_VIEW, padding=0.0) → None¶ Scrolls the ScrollBox to the widget during the next layout pass.
- Parameters
widget_to_find (Widget) –
animate_scroll (bool) –
scroll_destination (DescendantScrollDestination) –
padding (float) –
-
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_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_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
¶ [Read-Only] The multiplier to apply when wheel scrolling
- Type
(float)
-
property
widget_bar_style
¶ [Read-Write] The bar style
- Type
-
property
widget_style
¶ [Read-Write] The style
- Type