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

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
   
Name UBorder
Type class
Header File /Engine/Source/Runtime/UMG/Public/Components/Border.h
Include Path #include "Components/Border.h"

Syntax

UCLASS (MinimalAPI)  
class UBorder : public UContentWidget

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UBorder ( const FObjectInitializer& ObjectInitializer
)

   Components/Border.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Background FSlateBrush Brush to drag as the background Components/Border.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Appearance
  • Meta=(DisplayName="Brush")
BackgroundDelegate FGetSlateBrush A bindable delegate for the Brush. Components/Border.h  
bFlipForRightToLeftFlowDirection bool Flips the background image if the localization's flow direction is RightToLeft Components/Border.h
  • EditAnywhere
  • Category="Localization"
BrushColor FLinearColor Color and opacity of the actual border image Components/Border.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter="SetBrushColor"
  • Category="Appearance"
  • Meta=(sRGB="true")
BrushColorDelegate FGetLinearColor A bindable delegate for the BrushColor. Components/Border.h  
bShowEffectWhenDisabled uint8 Whether or not to show the disabled effect when this border is disabled Components/Border.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter="GetShowEffectWhenDisabled"
  • Setter="SetShowEffectWhenDisabled"
  • BlueprintSetter="SetShowEffectWhenDisabled"
  • Category="Appearance"
  • AdvancedDisplay
ContentColorAndOpacity FLinearColor Color and opacity multiplier of content in the border Components/Border.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter="SetContentColorAndOpacity"
  • Category="Content"
  • Meta=(sRGB="true")
ContentColorAndOpacityDelegate FGetLinearColor A bindable delegate for the ContentColorAndOpacity. Components/Border.h  
DesiredSizeScale FVector2D Scales the computed desired size of this border and its contents. Components/Border.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter="SetDesiredSizeScale"
  • Category="Appearance"
HorizontalAlignment TEnumAsByte< EHorizontalAlignment > The alignment of the content horizontally. Components/Border.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter="SetHorizontalAlignment"
  • Category="Content"
OnMouseButtonDownEvent FOnPointerEvent   Components/Border.h
  • EditAnywhere
  • Category=Events
  • Meta=(IsBindableEvent="True")
OnMouseButtonUpEvent FOnPointerEvent   Components/Border.h
  • EditAnywhere
  • Category=Events
  • Meta=(IsBindableEvent="True")
OnMouseDoubleClickEvent FOnPointerEvent   Components/Border.h
  • EditAnywhere
  • Category=Events
  • Meta=(IsBindableEvent="True")
OnMouseMoveEvent FOnPointerEvent   Components/Border.h
  • EditAnywhere
  • Category=Events
  • Meta=(IsBindableEvent="True")
Padding FMargin The padding area between the slot and the content it contains. Components/Border.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter="SetPadding"
  • Category="Content"
VerticalAlignment TEnumAsByte< EVerticalAlignment > The alignment of the content vertically. Components/Border.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter="SetVerticalAlignment"
  • Category="Content"

Functions

Public

Name Remarks Include Path Unreal Specifiers

FLinearColor GetBrushColor()

   Components/Border.h  

FLinearColor GetContentColorAndOpacity()

   Components/Border.h  

FVector2D GetDesiredSizeScale()

 Gets the DesiredSizeScale of this border. Components/Border.h  

UMaterialInstanceDynamic * GetDynamicMaterial()

   Components/Border.h
  • BlueprintCallable
  • Category="Appearance"

EHorizontalAlignment GetHorizontalAlignment()

   Components/Border.h  

FMargin GetPadding()

   Components/Border.h  

bool GetShowEffectWhenDisabled()

   Components/Border.h  

EVerticalAlignment GetVerticalAlignment()

   Components/Border.h  

void SetBrush ( const FSlateBrush& InBrush
)

   Components/Border.h
  • BlueprintCallable
  • Category="Appearance"

void SetBrushColor ( FLinearColor InBrushColor
)

   Components/Border.h
  • BlueprintCallable
  • Category="Appearance"

void SetBrushFromAsset ( USlateBrushAsset* Asset
)

   Components/Border.h
  • BlueprintCallable
  • Category="Appearance"

void SetBrushFromMaterial ( UMaterialInterface* Material
)

   Components/Border.h
  • BlueprintCallable
  • Category="Appearance"

void SetBrushFromTexture ( UTexture2D* Texture
)

   Components/Border.h
  • BlueprintCallable
  • Category="Appearance"

void SetContentColorAndOpacity ( FLinearColor InContentColorAndOpacity
)

   Components/Border.h
  • BlueprintCallable
  • Category="Appearance"

void SetDesiredSizeScale ( FVector2D InScale
)

 Sets the DesiredSizeScale of this border. Components/Border.h
  • BlueprintCallable
  • Category="Appearance"

void SetHorizontalAlignment ( EHorizontalAlignment InHorizontalAlignment
)

   Components/Border.h
  • BlueprintCallable
  • Category="Appearance"

void SetPadding ( FMargin InPadding
)

   Components/Border.h
  • BlueprintCallable
  • Category="Appearance"

void SetShowEffectWhenDisabled ( bool bInShowEffectWhenDisabled
)

   Components/Border.h
  • BlueprintCallable
  • Category="Appearance"

void SetVerticalAlignment ( EVerticalAlignment InVerticalAlignment
)

   Components/Border.h
  • BlueprintCallable
  • Category="Appearance"

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual const FText GetPaletteCategory()

 Gets the palette category of the widget Components/Border.h  

virtual void SynchronizeProperties ()

 Applies all properties to the native widget if possible. Components/Border.h  

Overridden from UVisual

Name Remarks Include Path Unreal Specifiers

virtual void ReleaseSlateResources ( bool bReleaseChildren
)

   Components/Border.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Components/Border.h  

virtual void PostLoad()

 Begin UObject. Components/Border.h  

Protected

Name Remarks Include Path Unreal Specifiers

const FSlateBrush * ConvertImage ( TAttribute< FSlateBrush > InImageAsset
) const

 Translates the bound brush data and assigns it to the cached brush used by this widget. Components/Border.h  

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

   Components/Border.h  

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

   Components/Border.h  

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

   Components/Border.h  

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

   Components/Border.h  

FLinearColor K2_Gate_ContentColorAndOpacity()

   Components/Border.h  

Overridden from UPanelWidget

Name Remarks Include Path Unreal Specifiers

virtual UClass * GetSlotClass()

 UPanelWidget. Components/Border.h  

virtual void OnSlotAdded ( UPanelSlot* Slot
)

   Components/Border.h  

virtual void OnSlotRemoved ( UPanelSlot* Slot
)

   Components/Border.h  

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual TSharedRef< SWidget > RebuildWidget()

 Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed. Components/Border.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page