unreal.DynamicEntryBox

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

Bases: DynamicEntryBoxBase

A special box panel that auto-generates its entries at both design-time and runtime. Useful for cases where you can have a varying number of entries, but it isn’t worth the effort or conceptual overhead to set up a list/tile view. Note that entries here are not virtualized as they are in the list views, so generally this should be avoided if you intend to scroll through lots of items.

No children can be manually added in the designer - all are auto-generated based on the given entry class.

C++ Source:

  • Module: UMG

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

  • 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

  • entry_box_type (DynamicBoxType): [Read-Write] Entry Box Type: The type of box panel into which created entries are added. Some differences in functionality exist between each type.

  • entry_horizontal_alignment (HorizontalAlignment): [Read-Write] Entry Horizontal Alignment: Horizontal alignment of generated entries. Horizontal/Vertical/Wrap boxes only.

  • entry_size_rule (SlateChildSize): [Read-Write] Entry Size Rule: Sizing rule to apply to generated entries. Horizontal/Vertical boxes only.

  • entry_spacing (Vector2D): [Read-Write] Entry Spacing: The padding to apply between entries in the box. Note horizontal boxes only use the X and vertical boxes only use Y. Value is also ignored for the first entry in the box. Wrap and Overlay types use both X and Y for spacing.

  • entry_vertical_alignment (VerticalAlignment): [Read-Write] Entry Vertical Alignment: Vertical alignment of generated entries. Horizontal/Vertical/Wrap boxes only.

  • entry_widget_class (type(Class)): [Read-Write] Entry Widget Class: The class of widget to create entries of. If natively binding this widget, use the EntryClass UPROPERTY metadata to specify the desired entry widget base class.

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

  • max_element_size (int32): [Read-Write] Max Element Size: The maximum size of each entry in the dominant axis of the box. Vertical/Horizontal boxes only.

  • 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

  • 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

  • radial_box_settings (RadialBoxSettings): [Read-Write] Radial Box Settings: Settings only relevant to RadialBox

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

  • spacing_pattern (Array[Vector2D]): [Read-Write] Spacing Pattern: The looping sequence of entry paddings to apply as entries are created. Overlay boxes only. Ignores EntrySpacing if not empty.

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

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

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

bp_create_entry() → UserWidget

Creates and establishes a new dynamic entry in the box

Return type:

UserWidget

bp_create_entry_of_class(entry_class) → UserWidget

Creates and establishes a new dynamic entry in the box using the specified class instead of the default.

Parameters:

entry_class (type(Class)) –

Return type:

UserWidget

property entry_widget_class: Class

[Read-Only] Entry Widget Class: The class of widget to create entries of. If natively binding this widget, use the EntryClass UPROPERTY metadata to specify the desired entry widget base class.

Type:

(type(Class))

remove_entry(entry_widget) → None

Remove Entry

Parameters:

entry_widget (UserWidget) –

reset(delete_widgets=False) → None

Clear out the box entries, optionally deleting the underlying Slate widgets entirely as well.

Parameters:

delete_widgets (bool) –