Navigation
API > API/Runtime > API/Runtime/Slate
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.
| Name | SBorder |
| Type | class |
| Header File | /Engine/Source/Runtime/Slate/Public/Widgets/Layout/SBorder.h |
| Include Path | #include "Widgets/Layout/SBorder.h" |
Syntax
class SBorder : public SCompoundWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SBorder
- FSlateControlledConstruction → SWidget → SCompoundWidget → SBorder
Derived Classes
SBorder derived class hierarchy
- SButton
- SDockTab
- SEditableTextBox
- SErrorText
- SExpandableButton
- SGraphEditorActionMenuAI
- SHeaderRow
- SMultiLineEditableTextBox
- SNiagaraGraphActionMenu
- SNotificationBackground
- SRigVMActionMenu
- SScrollBar
- SSeparator
- STableRow
- STextureGraphInsightBlobView
- STextureGraphInsightDeviceBufferView
- SWarningOrErrorBox
- SCarouselNavigationButton::SPeekBorder
- SGraphPin
- SGraphEditorActionMenu
- SRCProtocolMaskTriplet
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
SBorder() |
Default constructor. | Widgets/Layout/SBorder.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~SBorder() |
Widgets/Layout/SBorder.h |
Structs
| Name | Remarks |
|---|---|
| FArguments |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| PrivateParentType | SCompoundWidget | Widgets/Layout/SBorder.h | |
| PrivateThisType | SBorder | Widgets/Layout/SBorder.h | |
| Super | SCompoundWidget | Widgets/Layout/SBorder.h | |
| ThisClass | SBorder | Widgets/Layout/SBorder.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bFlipForRightToLeftFlowDirection | bool | Flips the image if the localization's flow direction is RightToLeft | Widgets/Layout/SBorder.h | |
| BorderBackgroundColorAttribute | TSlateAttribute< FSlateColor > | Widgets/Layout/SBorder.h | ||
| BorderImageAttribute | TSlateAttribute< const FSlateBrush * > | Widgets/Layout/SBorder.h | ||
| DesiredSizeScaleAttribute | TSlateAttribute< FVector2D > | Widgets/Layout/SBorder.h | ||
| ShowDisabledEffectAttribute | TSlateAttribute< bool > | Whether or not to show the disabled effect when this border is disabled | Widgets/Layout/SBorder.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ClearContent() |
Clears out the content for the border | Widgets/Layout/SBorder.h | |
void Construct
(
const FArguments& InArgs |
Construct this widget | Widgets/Layout/SBorder.h | |
FSlateColor GetBorderBackgroundColor() |
Gets the color and opacity of the background image of this border. | Widgets/Layout/SBorder.h | |
const FSlateBrush * GetBorderImage() |
Get the image to draw for this border. | Widgets/Layout/SBorder.h | |
const TSharedRef< SWidget > & GetContent() |
Gets the content for this border | Widgets/Layout/SBorder.h | |
void SetBorderBackgroundColor
(
TAttribute< FSlateColor > InColorAndOpacity |
Sets the color and opacity of the background image of this border. | Widgets/Layout/SBorder.h | |
void SetBorderImage
(
TAttribute< const FSlateBrush* > InBorderImage |
Set the image to draw for this border. | Widgets/Layout/SBorder.h | |
virtual void SetContent
(
TSharedRef< SWidget > InContent |
Sets the content for this border | Widgets/Layout/SBorder.h | |
void SetDesiredSizeScale
(
TAttribute< FVector2D > InDesiredSizeScale |
Set the desired size scale multiplier | Widgets/Layout/SBorder.h | |
void SetHAlign
(
EHorizontalAlignment HAlign |
See HAlign argument | Widgets/Layout/SBorder.h | |
void SetPadding
(
TAttribute< FMargin > InPadding |
See Padding attribute | Widgets/Layout/SBorder.h | |
void SetShowEffectWhenDisabled
(
TAttribute< bool > InShowEffectWhenDisabled |
Set whether or not to show the disabled effect when this border is disabled | Widgets/Layout/SBorder.h | |
void SetVAlign
(
EVerticalAlignment VAlign |
See VAlign argument | Widgets/Layout/SBorder.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual int32 OnPaint
(
const FPaintArgs& Args, |
Widgets/Layout/SBorder.h |
Overridden from FSlateControlledConstruction
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const FSlateWidgetClassData & GetWidgetClass() |
Widgets/Layout/SBorder.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSlateAttributeRef< FSlateColor > GetBorderBackgroundColorAttribute() |
Widgets/Layout/SBorder.h | ||
TSlateAttributeRef< const FSlateBrush * > GetBorderImageAttribute() |
Widgets/Layout/SBorder.h | ||
FVector2D GetDesiredSizeScale() |
Get the desired size scale multiplier | Widgets/Layout/SBorder.h | |
TSlateAttributeRef< FVector2D > GetDesiredSizeScaleAttribute() |
Widgets/Layout/SBorder.h | ||
bool GetShowDisabledEffect() |
Get whether or not to show the disabled effect when this border is disabled | Widgets/Layout/SBorder.h | |
TSlateAttributeRef< bool > GetShowDisabledEffectAttribute() |
Widgets/Layout/SBorder.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FVector2D ComputeDesiredSize
(
float |
Widgets/Layout/SBorder.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const FSlateWidgetClassData & GetPrivateWidgetClass() |
Widgets/Layout/SBorder.h | ||
static SLATE_API void PrivateRegisterAttributes
(
FSlateAttributeInitializer& |
Widgets/Layout/SBorder.h | ||
static const FSlateWidgetClassData & StaticWidgetClass() |
Widgets/Layout/SBorder.h |