unreal.TreeView

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

Bases: ListView

Similar to ListView, but can display a hierarchical tree of elements. The base items source for the tree identifies the root items, each of which can have n associated child items. There is no hard limit to the nesting - child items can have children and so on

To make a widget usable as an entry in a TreeView, it must inherit from the IUserObjectListEntry interface.

C++ Source:

  • Module: UMG

  • File: TreeView.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_dragging (bool): [Read-Write] Allow Dragging: True to allow dragging of row widgets in the list

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

  • bp_on_entry_generated (OnListEntryGeneratedDynamic): [Read-Write] BP on Entry Generated: Called when a row widget is generated for a list item

  • bp_on_entry_initialized (OnListEntryInitializedDynamic): [Read-Write] BP on Entry Initialized: Called when a row widget is generated for a list item

  • bp_on_entry_released (OnListEntryReleasedDynamic): [Read-Write] BP on Entry Released: Called when a row widget is released by the list (i.e. when it no longer represents a list item)

  • bp_on_get_item_children (OnGetItemChildrenDynamic): [Read-Write] BP on Get Item Children: Called to get the list of children (if any) that correspond to the given item. Only called if the native C++ version of the event is not bound.

  • bp_on_item_clicked (SimpleListItemEventDynamic): [Read-Write] BP on Item Clicked

  • bp_on_item_double_clicked (SimpleListItemEventDynamic): [Read-Write] BP on Item Double Clicked

  • bp_on_item_expansion_changed (OnItemExpansionChangedDynamic): [Read-Write] BP on Item Expansion Changed

  • bp_on_item_is_hovered_changed (OnItemIsHoveredChangedDynamic): [Read-Write] BP on Item Is Hovered Changed

  • bp_on_item_scrolled_into_view (OnListItemScrolledIntoViewDynamic): [Read-Write] BP on Item Scrolled Into View

  • bp_on_item_selection_changed (OnListItemSelectionChangedDynamic): [Read-Write] BP on Item Selection Changed

  • can_children_be_accessible (bool): [Read-Write] Can Children be Accessible: Whether or not children of this widget can appear as distinct accessible widgets.

  • clear_selection_on_click (bool): [Read-Write] Clear Selection on Click

  • clipping (WidgetClipping): [Read-Write] Clipping

  • consume_mouse_wheel (ConsumeMouseWheel): [Read-Write] Consume Mouse Wheel

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

  • enable_fixed_line_offset (bool): [Read-Write] Enable Fixed Line Offset

  • enable_right_click_scrolling (bool): [Read-Write] Enable Right Click Scrolling: True to allow right click drag scrolling.

  • enable_scroll_animation (bool): [Read-Write] Enable Scroll Animation: True to enable lerped animation when scrolling through the list

  • entry_spacing (float): [Read-Write] Entry Spacing

  • entry_widget_class (type(Class)): [Read-Write] Entry Widget Class: The type of widget to create for each entry displayed in the list.

  • fixed_line_scroll_offset (float): [Read-Write] Fixed Line Scroll Offset: Optional fixed offset (in lines) to always apply to the top/left (depending on orientation) of the list. If provided, all non-inertial means of scrolling will settle with exactly this offset of the topmost entry. Ex: A value of 0.25 would cause the topmost full entry to be offset down by a quarter length of the preceeding entry.

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

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

  • is_focusable (bool): [Read-Write] Is Focusable

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

  • num_designer_preview_entries (int32): [Read-Write] Num Designer Preview Entries: The number of dummy item entry widgets to preview in the widget designer

  • orientation (Orientation): [Read-Write] Orientation: The scroll & layout orientation of the list. ListView and TileView only. Vertical will scroll vertically and arrange tiles into rows. Horizontal will scroll horizontally and arrange tiles into columns.

  • 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

  • return_focus_to_selection (bool): [Read-Write] Return Focus to Selection

  • scroll_bar_style (ScrollBarStyle): [Read-Write] Scroll Bar Style

  • selection_mode (SelectionMode): [Read-Write] Selection Mode

  • 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_style (TableViewStyle): [Read-Write] Widget Style

property bp_on_item_expansion_changed: OnItemExpansionChangedDynamic

[Read-Write] BP on Item Expansion Changed

Type:

(OnItemExpansionChangedDynamic)

collapse_all() → None

Collapses all currently expanded items

expand_all() → None

Expands all items with children

set_item_expansion(item, expand_item) → None

Attempts to expand/collapse the given item (only relevant if the item has children)

Parameters: