unreal.Border
¶
- class unreal.Border(outer: Optional[Object] = None, name: Union[Name, str] = 'None')¶
Bases:
ContentWidget
A border is a container widget that can contain one child widget, providing an opportunity to surround it with a background image and adjustable padding.
Single Child
Image
C++ Source:
Module: UMG
File: Border.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 backgroundbrush_color
(LinearColor): [Read-Write] Brush Colorcan_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] Clippingcontent_color_and_opacity
(LinearColor): [Read-Write] Content Color and Opacitycursor
(MouseCursor): [Read-Write] Cursordesired_size_scale
(Vector2D): [Read-Write] Desired Size Scaleflip_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 RightToLeftflow_direction_preference
(FlowDirectionPreference): [Read-Write] Flow Direction Preferencehorizontal_alignment
(HorizontalAlignment): [Read-Write] Horizontal Alignmentis_enabled
(bool): [Read-Write] Is Enabledis_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.on_mouse_button_down_event
(OnPointerEvent): [Read-Write] On Mouse Button Down Eventon_mouse_button_up_event
(OnPointerEvent): [Read-Write] On Mouse Button Up Eventon_mouse_double_click_event
(OnPointerEvent): [Read-Write] On Mouse Double Click Eventon_mouse_move_event
(OnPointerEvent): [Read-Write] On Mouse Move Eventoverride_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 Cursorpadding
(Margin): [Read-Write] Paddingrender_opacity
(float): [Read-Write] Render Opacityrender_transform
(WidgetTransform): [Read-Write] Render Transformrender_transform_pivot
(Vector2D): [Read-Write] Render Transform Pivotshow_effect_when_disabled
(bool): [Read-Write] Show Effect when Disabledslot
(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 Texttool_tip_widget
(Widget): [Read-Only] Tool Tip Widgetvertical_alignment
(VerticalAlignment): [Read-Write] Vertical Alignmentvisibility
(SlateVisibility): [Read-Write] Visibility
- property background: SlateBrush¶
[Read-Only] Background: Brush to drag as the background
- Type:
- property brush_color: LinearColor¶
[Read-Write] Brush Color
- Type:
- property content_color_and_opacity: LinearColor¶
[Read-Write] Content Color and Opacity
- Type:
- get_dynamic_material() MaterialInstanceDynamic ¶
Get Dynamic Material
- Return type:
- property horizontal_alignment: HorizontalAlignment¶
[Read-Write] Horizontal Alignment
- Type:
- set_brush(brush) None ¶
Set Brush
- Parameters:
brush (SlateBrush) –
- set_brush_color(brush_color) None ¶
Set Brush Color
- Parameters:
brush_color (LinearColor) –
- set_brush_from_asset(asset) None ¶
Set Brush from Asset
- Parameters:
asset (SlateBrushAsset) –
- set_brush_from_material(material) None ¶
Set Brush from Material
- Parameters:
material (MaterialInterface) –
- set_content_color_and_opacity(content_color_and_opacity) None ¶
Set Content Color and Opacity
- Parameters:
content_color_and_opacity (LinearColor) –
- set_desired_size_scale(scale) None ¶
Sets the DesiredSizeScale of this border.
- Parameters:
scale (Vector2D) – The X and Y multipliers for the desired size
- set_horizontal_alignment(horizontal_alignment) None ¶
Set Horizontal Alignment
- Parameters:
horizontal_alignment (HorizontalAlignment) –
- set_show_effect_when_disabled(show_effect_when_disabled) None ¶
Set Show Effect when Disabled
- Parameters:
show_effect_when_disabled (bool) –
- set_vertical_alignment(vertical_alignment) None ¶
Set Vertical Alignment
- Parameters:
vertical_alignment (VerticalAlignment) –
- property vertical_alignment: VerticalAlignment¶
[Read-Write] Vertical Alignment
- Type: