UCommonBorder

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

CommonUI

Header

/Engine/Plugins/Experimental/CommonUI/Source/CommonUI/Public/CommonBorder.h

Include

#include "CommonBorder.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=CommonUI, defaultconfig, ClassGroup=UI,
       Meta=(Category="Common UI", DisplayName="Common Border"))
class UCommonBorder : public UBorder

Variables

Name Description

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

bool

 

bReducePaddingBySafezone

Turning this on will cause the safe zone size to be removed from this borders content padding down to the minimum specified

Public variable UProperty

bool

 

bStyleNoLongerNeedsConversion

Used to track widgets that were created before changing the default style pointer to null

Protected variable

TOptional< FVec...

 

DesignerSize

The editor-only size constraint passed in by UMG Designer

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly

FMargin

 

MinimumPadding

The minimum padding we will reduce to when the safezone grows

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly

TSubclassOf< UC...

 

Style

References the border style to use

Constructors

Name Description

Public function

UCommonBorder

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Protected function

void

 

DebugSafeAreaUpdated

(
    const FMargin& NewSafeZone,
    bool bShouldRecacheMetrics
)

Protected function

void

 

SafeAreaUpdated()

Public function UFunction BlueprintCallable, Category

void

 

SetStyle

(
    TSubclassOf< UCommonBorderStyle > I...
)

Overridden from UWidget

Name Description

Protected function Virtual

const FText

 

GetPaletteCategory()

Gets the palette category of the widget

Protected function Virtual

void

 

OnCreationFromPalette()

Called by the palette after constructing a new widget, allows the widget to perform interesting default setup that we don't want to be UObject Defaults.

Protected function Virtual

void

 

OnDesignerChanged

(
    const FDesignerChangedEventArgs& E...
)

Protected function Virtual

TSharedRef< ...

 

RebuildWidget()

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

Protected function Virtual

void

 

SynchronizeProperties()

Applies all properties to the native widget if possible.

Overridden from UVisual

Name Description

Protected function Virtual

void

 

ReleaseSlateResources

(
    bool bReleaseChildren
)

Overridden from UObject

Name Description

Protected function Virtual

void

 

PostLoad()

Begin UObject.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss