Navigation
API > API/Runtime > API/Runtime/SlateCore
A BoxPanel contains one child and describes how that child should be arranged on the screen.
| Name | SBoxPanel |
| Type | class |
| Header File | /Engine/Source/Runtime/SlateCore/Public/Widgets/SBoxPanel.h |
| Include Path | #include "Widgets/SBoxPanel.h" |
Syntax
class SBoxPanel : public SPanel
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SPanel → SBoxPanel
- FSlateControlledConstruction → SWidget → SPanel → SBoxPanel
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
SBoxPanel () |
Widgets/SBoxPanel.h | ||
SBoxPanel
(
EOrientation InOrientation |
A Box Panel's orientation. | Widgets/SBoxPanel.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~SBoxPanel() |
Widgets/SBoxPanel.h |
Classes
| Name | Remarks |
|---|---|
| FSlot | |
| TSlot | A BoxPanel contains one BoxPanel child and describes how that child should be arranged on the screen. |
Structs
| Name | Remarks |
|---|---|
| FScopedWidgetSlotArguments |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| PrivateParentType | SPanel | Widgets/SBoxPanel.h | |
| PrivateThisType | SBoxPanel | Widgets/SBoxPanel.h | |
| Super | SPanel | Widgets/SBoxPanel.h | |
| ThisClass | SBoxPanel | Widgets/SBoxPanel.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ClearChildren() |
Removes all children from the box. | Widgets/SBoxPanel.h | |
bool IsValidSlotIndex
(
int32 Index |
Widgets/SBoxPanel.h | ||
int32 NumSlots() |
Widgets/SBoxPanel.h | ||
int32 RemoveSlot
(
const TSharedRef< SWidget >& SlotWidget |
Removes a slot from this box panel which contains the specified SWidget | Widgets/SBoxPanel.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FChildren * GetChildren () |
All widgets must provide a way to access their children in a layout-agnostic way. | Widgets/SBoxPanel.h | |
virtual void OnArrangeChildren
(
const FGeometry& AllottedGeometry, |
Panels arrange their children in a space described by the AllottedGeometry parameter. | Widgets/SBoxPanel.h |
Overridden from FSlateControlledConstruction
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const FSlateWidgetClassData & GetWidgetClass() |
Widgets/SBoxPanel.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
EOrientation GetOrientation() |
Widgets/SBoxPanel.h | ||
void SetOrientation
(
EOrientation InOrientation |
Set the orientation of the Box. It will do a full invalidation of the widget. | Widgets/SBoxPanel.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FVector2D ComputeDesiredSize
(
float |
A Panel's desired size in the space required to arrange of its children on the screen while respecting all of the children's desired sizes and any layout-related options specified by the user. | Widgets/SBoxPanel.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const FSlateWidgetClassData & GetPrivateWidgetClass() |
Widgets/SBoxPanel.h | ||
static void PrivateRegisterAttributes
(
FSlateAttributeInitializer& |
Widgets/SBoxPanel.h | ||
static const FSlateWidgetClassData & StaticWidgetClass() |
Widgets/SBoxPanel.h |