unreal.CommonBorder

class unreal.CommonBorder(outer=None, name='None')

Bases: unreal.Border

Uses the border style template defined in CommonUI project settings by default

C++ Source:

  • Plugin: CommonUI

  • Module: CommonUI

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

  • background (SlateBrush): [Read-Write] Background: Brush to drag as the background

  • brush_color (LinearColor): [Read-Write] Brush Color: Color and opacity of the actual border image

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

  • content_color_and_opacity (LinearColor): [Read-Write] Content Color and Opacity: Color and opacity multiplier of content in the border

  • cursor (MouseCursor): [Read-Write] Cursor: The cursor to show when the mouse is over the widget

  • desired_size_scale (Vector2D): [Read-Write] Desired Size Scale: Scales the computed desired size of this border and its contents. Useful for making things that slide open without having to hard-code their size. Note: if the parent widget is set up to ignore this widget’s desired size, then changing this value will have no effect.

  • flip_for_right_to_left_flow_direction (bool): [Read-Write] Flip for Right to Left Flow Direction: Flips the background image if the localization’s flow direction is RightToLeft

  • flow_direction_preference (FlowDirectionPreference): [Read-Write] Flow Direction Preference: Allows you to set a new flow direction

  • horizontal_alignment (HorizontalAlignment): [Read-Write] Horizontal Alignment: The alignment of the content horizontally.

  • is_enabled (bool): [Read-Write] Is Enabled: Sets whether this widget can be modified interactively by the user

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

  • minimum_padding (Margin): [Read-Write] Minimum Padding: The minimum padding we will reduce to when the safezone grows

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

  • on_mouse_button_down_event (OnPointerEvent): [Read-Write] On Mouse Button Down Event

  • on_mouse_button_up_event (OnPointerEvent): [Read-Write] On Mouse Button Up Event

  • on_mouse_double_click_event (OnPointerEvent): [Read-Write] On Mouse Double Click Event

  • on_mouse_move_event (OnPointerEvent): [Read-Write] On Mouse Move Event

  • 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 padding area between the slot and the content it contains.

  • reduce_padding_by_safezone (bool): [Read-Write] Reduce Padding by Safezone: Turning this on will cause the safe zone size to be removed from this borders content padding down to the minimum specified

  • render_opacity (float): [Read-Write] Render Opacity: The opacity of the widget

  • render_transform (WidgetTransform): [Read-Write] Render Transform: The render transform of the widget allows for arbitrary 2D transforms to be applied to the widget.

  • render_transform_pivot (Vector2D): [Read-Write] Render Transform Pivot: 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.

  • show_effect_when_disabled (bool): [Read-Write] Show Effect when Disabled: Whether or not to show the disabled effect when this border is disabled

  • slot (PanelSlot): [Read-Write] Slot: The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.

  • style (type(Class)): [Read-Write] Style: References the border style to use

  • tool_tip_text (Text): [Read-Write] Tool Tip Text: Tooltip text to show when the user hovers over the widget with the mouse

  • tool_tip_widget (Widget): [Read-Only] Tool Tip Widget: Tooltip widget to show when the user hovers over the widget with the mouse

  • vertical_alignment (VerticalAlignment): [Read-Write] Vertical Alignment: The alignment of the content vertically.

  • visibility (SlateVisibility): [Read-Write] Visibility: The visibility of the widget

property minimum_padding

[Read-Only] Minimum Padding: The minimum padding we will reduce to when the safezone grows

Type

(Margin)

property reduce_padding_by_safezone

[Read-Only] Reduce Padding by Safezone: Turning this on will cause the safe zone size to be removed from this borders content padding down to the minimum specified

Type

(bool)

set_style(style) → None

Set Style

Parameters

style (type(Class)) –

property style

[Read-Only] Style: References the border style to use

Type

(type(Class))