Navigation
API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Widgets > API/Runtime/Slate/Widgets/Layout
Inheritance Hierarchy
- FSlateControlledConstruction
- TSharedFromThis
- SWidget
- SCompoundWidget
- SBorder
- SButton
- SButtonCommandWidget
- SHyperlink
- SRichTextHyperlink
- SHyperlinkWithTextHighlight
- SPrimaryButton
- SSimpleButton
- SCarouselNavigationButton::SPeekBorder
- SDockTab
- SLiveLinkCurveDebugUITab
- SEditableTextBox
- SSearchBox
- SErrorText
- SExpandableButton
- SGraphEditorActionMenu
- SGraphEditorActionMenuAI
- SGraphPin
- SGraphPinAI
- SGraphPinBool
- SGraphPinColor
- SGraphPinEnum
- SGraphPinExec
- SGraphPinKnot
- SGraphPinMaterialInput
- SGraphPinNameList
- SGraphPinDataTableRowName
- SGraphPinNum
- SGraphPinInteger
- SGraphPinObject
- SGraphPinClass
- SGraphPinString
- SGraphPinStructInstance
- SGraphPinVector
- SGraphPinVector2D
- SGraphPinVector4
- SRigVMGraphPinCurveFloat
- SRigVMGraphPinNameList
- SRigVMGraphPinUserDataNameSpace
- SRigVMGraphPinUserDataPath
- SRigVMGraphPinVariableBinding
- SRigVMGraphPinVariableName
- SHeaderRow
- SMultiLineEditableTextBox
- STemplateStringEditableTextBox
- SNiagaraGraphActionMenu
- SNotificationBackground
- SRCProtocolMaskTriplet
- SRCProtocolMask
- SScrollBar
- SLinkableScrollBar
- SSeparator
- STableRow
- SAssetTagItemTableRow
- SComboRow
- SDatabaseAssetListItem
- SIKRigSolverStackItem
- SItemSelector::SItemSelectorItemTableRow
- SMLDeformerBonePickerTreeRowWidget
- SMLDeformerCurvePickerRowWidget
- SMLDeformerInputBoneTreeRowWidget
- SMLDeformerInputCurveListRowWidget
- SMultiColumnTableRow
- ISequencerTreeViewRow
- SOutlinerViewRow
- SAnimAttributeEntry
- SAssetColumnViewRow
- SAssetListViewRow
- SBoneMappingListRow
- SBonePairRow
- SCollectionSpreadSheetRow
- SDMXReadOnlyFixturePatchListRow
- SEventItem
- SIKRetargetChainMapRow
- SIKRetargetHierarchyRow
- SIKRigRetargetChainRow
- SIKRigSkeletonRow
- SLiveLinkCurveDebugUIListItem
- SOptionTableRow
- SSceneOutlinerPinnedTreeRow
- SSceneOutlinerTreeRow
- SSCS_RowWidget
- SSCS_RowWidget_ActorRoot
- SSCS_RowWidget_Separator
- SSelectionViewRow
- SSubobject_RowWidget
- SUsdTreeRow
- SUsdStagePreviewTreeRow
- SMultiSelectTableRow
- SNeuralMorphBoneGroupsTreeRowWidget
- SNeuralMorphCurveGroupsTreeRowWidget
- SRigStackItem
- SRigVMGraphFunctionLocalizationTableRow
- SRigVMVariableMappingTreeRow
- SWarningOrErrorBox
- SRichTextWarningOrErrorBox
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.
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
SBorder () |
Default constructor. |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | ClearContent () |
Clears out the content for the border |
 |
void | Construct
(
const FArguments& InArgs |
Construct this widget |
  |
FSlateColor | Gets the color and opacity of the background image of this border. | |
  |
TSlateAttributeRef< FSlateColor > | ||
  |
const FSlateBrush * | Get the image to draw for this border. | |
  |
TSlateAttributeRef< const FSlateBrush * > | ||
  |
const TSharedRef< SWidget > & | GetContent () |
Gets the content for this border |
  |
FVector2D | Get the desired size scale multiplier | |
  |
TSlateAttributeRef< FVector2D > | ||
  |
bool | Get whether or not to show the disabled effect when this border is disabled | |
  |
TSlateAttributeRef< bool > | ||
 |
void | SetBorderBackgroundColor
(
TAttribute< FSlateColor > InColorAndOpacity |
Sets the color and opacity of the background image of this border. |
 |
void | SetBorderImage
(
TAttribute< const FSlateBrush* > InBorderImage |
Set the image to draw for this border. |
  |
void | SetContent
(
TSharedRef< SWidget > InContent |
Sets the content for this border |
 |
void | SetDesiredSizeScale
(
TAttribute< FVector2D > InDesiredSizeScale |
Set the desired size scale multiplier |
 |
void | SetHAlign
(
EHorizontalAlignment HAlign |
See HAlign argument |
 |
void | SetPadding
(
TAttribute< FMargin > InPadding |
See Padding attribute |
 |
void | SetShowEffectWhenDisabled
(
TAttribute< bool > InShowEffectWhenDisabled |
Set whether or not to show the disabled effect when this border is disabled |
 |
void | SetVAlign
(
EVerticalAlignment VAlign |
See VAlign argument |
  |
const FSlateWidgetClassData & |
Overridden from SWidget
| Type | Name | Description | |
|---|---|---|---|
   |
FVector2D | ComputeDesiredSize
(
float LayoutScaleMultiplier |
Compute the ideal size necessary to display this widget. |
   |
int32 | OnPaint
(
const FPaintArgs& Args, |
The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children. |
Overridden from FSlateControlledConstruction
| Type | Name | Description | |
|---|---|---|---|
   |
const FSlateWidgetClassData & |
Classes
| Type | Name | Description | |
|---|---|---|---|
 |
FArguments |
Typedefs
| Name | Description |
|---|---|
| PrivateParentType | |
| PrivateThisType | |
| Super | |
| ThisClass |
Deprecated Variables
| Type | Name | Description | |
|---|---|---|---|
 |
TSlateDeprecatedTAttribute< FSlateColor > | BorderBackgroundColor | Direct access to BorderBackgroundColor is now deprecated. Use the setter or getter. |
 |
FInvalidatableBrushAttribute | BorderImage | Direct access to BorderImage is now deprecated. Use the setter or getter. |
 |
TSlateDeprecatedTAttribute< FVector2D > | DesiredSizeScale | Direct access to DesiredSizeScale is now deprecated. Use the setter or getter. |
 |
TSlateDeprecatedTAttribute< bool > | ShowDisabledEffect | Direct access to ShowDisabledEffect is now deprecated. Use the setter or getter. |