1. Epic GamesDeveloper
  3. UBorder

UBorder

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.

API > API/Runtime > API/Runtime/UMG > API/Runtime/UMG/Components

Inheritance Hierarchy

References

   
Module UMG
Header /Engine/Source/Runtime/UMG/Public/Components/Border.h
Include #include "Components/Border.h"

Syntax

UCLASS (MinimalAPI)  
class UBorder : public UContentWidget

Remarks

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

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly FSlateBrush Background Brush to drag as the background
Public variable UProperty FGetSlateBrush BackgroundDelegate A bindable delegate for the Brush.
Public variable UProperty Category, EditAnywhere bool bFlipForRightToLeftFlowDirection Flips the background image if the localization's flow direction is RightToLeft
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter, getter, setter FLinearColor BrushColor Color and opacity of the actual border image
Public variable UProperty FGetLinearColor BrushColorDelegate A bindable delegate for the BrushColor.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite blueprintsetter, getter, setter uint8: 1 bShowEffectWhenDisabled Whether or not to show the disabled effect when this border is disabled
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter, getter, setter FLinearColor ContentColorAndOpacity Color and opacity multiplier of content in the border
Public variable UProperty FGetLinearColor ContentColorAndOpacityDelegate A bindable delegate for the ContentColorAndOpacity.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter FVector2D DesiredSizeScale Scales the computed desired size of this border and its contents.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter TEnumAsByte< EHorizontalAlignment > HorizontalAlignment The alignment of the content horizontally.
Protected variable FLinearColor K2_Cache_ContentColorAndOpacity  
Protected variable TSharedPtr< SBorder > MyBorder  
Public variable UProperty Category, EditAnywhere, Meta FOnPointerEvent OnMouseButtonDownEvent  
Public variable UProperty Category, EditAnywhere, Meta FOnPointerEvent OnMouseButtonUpEvent  
Public variable UProperty Category, EditAnywhere, Meta FOnPointerEvent OnMouseDoubleClickEvent  
Public variable UProperty Category, EditAnywhere, Meta FOnPointerEvent OnMouseMoveEvent  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter FMargin Padding The padding area between the slot and the content it contains.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter TEnumAsByte< EVerticalAlignment > VerticalAlignment The alignment of the content vertically.

Constructors

  Type Name Description
Public function  

UBorder ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function Const const FSlateBrush *

ConvertImage ( TAttribute< FSlateBrush > InImageAsset
)

 Translates the bound brush data and assigns it to the cached brush used by this widget.
Public function Const FLinearColor  
Public function Const FLinearColor  
Public function Const FVector2D Gets the DesiredSizeScale of this border.
Public function UFunction BlueprintCallable, Category UMaterialInstanceDynamic *  
Public function Const EHorizontalAlignment  
Public function Const FMargin  
Public function Const bool  
Public function Const EVerticalAlignment  
Protected function FReply

HandleMouseButtonDown ( const FGeometry& Geometry,
const FPointerEvent& MouseEvent
)

  
Protected function FReply

HandleMouseButtonUp ( const FGeometry& Geometry,
const FPointerEvent& MouseEvent
)

  
Protected function FReply

HandleMouseDoubleClick ( const FGeometry& Geometry,
const FPointerEvent& MouseEvent
)

  
Protected function FReply

HandleMouseMove ( const FGeometry& Geometry,
const FPointerEvent& MouseEvent
)

  
Protected function FLinearColor  
Public function UFunction BlueprintCallable, Category void

SetBrush ( const FSlateBrush& InBrush
)

  
Public function UFunction BlueprintCallable, Category void

SetBrushColor ( FLinearColor InBrushColor
)

  
Public function UFunction BlueprintCallable, Category void

SetBrushFromAsset ( USlateBrushAsset* Asset
)

  
Public function UFunction BlueprintCallable, Category void

SetBrushFromMaterial ( UMaterialInterface* Material
)

  
Public function UFunction BlueprintCallable, Category void

SetBrushFromTexture ( UTexture2D* Texture
)

  
Public function UFunction BlueprintCallable, Category void

SetContentColorAndOpacity ( FLinearColor InContentColorAndOpacity
)

  
Public function UFunction BlueprintCallable, Category void

SetDesiredSizeScale ( FVector2D InScale
)

 Sets the DesiredSizeScale of this border.
Public function UFunction BlueprintCallable, Category void

SetHorizontalAlignment ( EHorizontalAlignment InHorizontalAlignment
)

  
Public function UFunction BlueprintCallable, Category void

SetPadding ( FMargin InPadding
)

  
Public function UFunction BlueprintCallable, Category void

SetShowEffectWhenDisabled ( bool bInShowEffectWhenDisabled
)

  
Public function UFunction BlueprintCallable, Category void

SetVerticalAlignment ( EVerticalAlignment InVerticalAlignment
)

  

Overridden from UPanelWidget

  Type Name Description
Protected function Virtual Const UClass * UPanelWidget.
Protected function Virtual void  
Protected function Virtual void  
Public function Virtual void Begin UObject.

Overridden from UWidget

  Type Name Description
Public function Virtual const FText Gets the palette category of the widget
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Protected function Virtual TSharedRef< SWidget > Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
Public function Virtual void Applies all properties to the native widget if possible.

Overridden from UVisual

  Type Name Description
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page