Navigation
API > API/Runtime > API/Runtime/UMG
A stack box widget is a layout panel allowing child widgets to be automatically laid out vertically or horizontally.
- Many Children
- Flows Vertical or Horizontal
| Name | UStackBox |
| Type | class |
| Header File | /Engine/Source/Runtime/UMG/Public/Components/StackBox.h |
| Include Path | #include "Components/StackBox.h" |
Syntax
UCLASS (
Meta=(ShortTooltip="A layout panel for automatically laying child widgets out vertically or horizontally"),
MinimalAPI)
class UStackBox : public UPanelWidget
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UVisual → UWidget → UPanelWidget → UStackBox
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UStackBox() |
Components/StackBox.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| MyBox | TSharedPtr< SStackBox > | Components/StackBox.h | ||
| Orientation | TEnumAsByte< EOrientation > | The orientation of the stack box. | Components/StackBox.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UStackBoxSlot * AddChildToStackBox
(
UWidget* Content |
Adds a new child widget to the container. | Components/StackBox.h |
|
EOrientation GetOrientation() |
Get the orientation of the stack box. | Components/StackBox.h | |
bool ReplaceStackBoxChildAt
(
int32 Index, |
Replace the widget at the given index it with a different widget. | Components/StackBox.h |
|
void SetOrientation
(
EOrientation InType |
Set the orientation of the stack box. The existing elements will be rearranged. | Components/StackBox.h |
Overridden from UWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const FText GetPaletteCategory() |
Gets the palette category of the widget | Components/StackBox.h |
Protected
Overridden from UPanelWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual UClass * GetSlotClass() |
Components/StackBox.h | ||
virtual void OnSlotAdded
(
UPanelSlot* Slot |
Components/StackBox.h | ||
virtual void OnSlotRemoved
(
UPanelSlot* Slot |
Components/StackBox.h |
Overridden from UWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TSharedRef< SWidget > RebuildWidget() |
Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed. | Components/StackBox.h | |
virtual void SynchronizeProperties () |
Applies all properties to the native widget if possible. | Components/StackBox.h |
Overridden from UVisual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ReleaseSlateResources
(
bool bReleaseChildren |
Components/StackBox.h |