SBorder

A border is an widget that can be used to contain other widgets.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Slate

Header

/Engine/Source/Runtime/Slate/Public/Widgets/Layout/SBorder.h

Include

#include "Widgets/Layout/SBorder.h"

Syntax

class SBorder : public SCompoundWidget

Remarks

A border is an widget that can be used to contain other widgets. It has a BorderImage property, which allows it to take on different appearances. Border also has a Content() slot as well as some parameters controlling the arrangement of said content.

Variables

Name Description

Protected variable

bool

 

bFlipForRightToLeftFlowDirection

Flips the image if the localization's flow direction is RightToLeft

Protected variable

TAttribute < FSl ...

 

BorderBackgroundColor

Protected variable

FInvalidatableB ...

 

BorderImage

Protected variable

TAttribute < FVe ...

 

DesiredSizeScale

Protected variable

TAttribute < boo ...

 

ShowDisabledEffect

Whether or not to show the disabled effect when this border is disabled

Constructors

Name Description

Public function

SBorder()

Default constructor.

Functions

Name Description

Public function

void

 

ClearContent()

Clears out the content for the border

Public function

void

 

Construct

(
    const FArguments & InArgs
)

Construct this widget

Public function Const

const TShare ...

 

GetContent()

Gets the content for this border

Public function

void

 

SetBorderBackgroundColor

(
    const TAttribute < FSlateColor >& I...
)

Sets the color and opacity of the background image of this border.

Public function

void

 

SetBorderImage

(
    const TAttribute < const FSlateBrush ...
)

See BorderImage attribute

Public function Virtual

void

 

SetContent

(
    TSharedRef < SWidget > InContent
)

Sets the content for this border

Public function

void

 

SetDesiredSizeScale

(
    const TAttribute < FVector2D >& InD...
)

Set the desired size scale multiplier

Public function

void

 

SetHAlign

(
    EHorizontalAlignment HAlign
)

See HAlign argument

Public function

void

 

SetPadding

(
    const TAttribute < FMargin >& InPad...
)

See Padding attribute

Public function

void

 

SetShowEffectWhenDisabled

(
    const TAttribute < bool >& InShowEf...
)

See ShowEffectWhenDisabled attribute

Public function

void

 

SetVAlign

(
    EVerticalAlignment VAlign
)

See VAlign argument

Overridden from SWidget

Name Description

Protected function Virtual Const

FVector2D

 

ComputeDesiredSize

(
    float LayoutScaleMultiplier
)

Compute the ideal size necessary to display this widget.

Public function Virtual Const

bool

 

ComputeVolatility()

Recomputes the volatility of the widget.

Public function Virtual Const

int32

 

OnPaint

(
    const FPaintArgs & Args,
    const FGeometry & AllottedGeometry,
    const FSlateRect & MyCullingRect,
    FSlateWindowElementList & OutDrawEl...,
    int32 LayerId,
    const FWidgetStyle & InWidgetStyle,
    bool bParentEnabled
)

The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children.

Classes

Name

Description

Public struct

FArguments

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback