unreal.ScrollBar

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

Bases: Widget

Scroll Bar

C++ Source:

  • Module: UMG

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

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

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

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

  • orientation (Orientation): [Read-Write] Orientation

  • 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 margin around the scrollbar

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

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

  • tool_tip_text (Text): [Read-Write] Tool Tip Text

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

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

  • widget_style (ScrollBarStyle): [Read-Write] Widget Style: Style of the scrollbar

set_state(offset_fraction, thumb_size_fraction) → None

Set the offset and size of the track’s thumb. Note that the maximum offset is 1.0-ThumbSizeFraction. If the user can view 1/3 of the items in a single page, the maximum offset will be ~0.667f

Parameters:

  • offset_fraction (float) – Offset of the thumbnail from the top as a fraction of the total available scroll space.

  • thumb_size_fraction (float) – Size of thumbnail as a fraction of the total available scroll space.

property widget_style: ScrollBarStyle

[Read-Write] Widget Style: Style of the scrollbar

Type:

(ScrollBarStyle)