SBoxPanel

A BoxPanel contains one child and describes how that child should be arranged on the screen.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

SlateCore

Header

/Engine/Source/Runtime/SlateCore/Public/Widgets/SBoxPanel.h

Include

#include "Widgets/SBoxPanel.h"

Syntax

class SBoxPanel : public SPanel

Remarks

A BoxPanel contains one child and describes how that child should be arranged on the screen.

Variables

Name Description

Protected variable

TPanelChildren<...

 

Children

The Box Panel's children.

Protected variable

const EOrientat...

 

Orientation

The Box Panel's orientation; determined at construct time.

Constructors

Name Description

Protected function

SBoxPanel

(
    EOrientation InOrientation
)

A Box Panel's orientation cannot be changed once it is constructed..

Functions

Name Description

Public function

void

 

ClearChildren()

Removes all children from the box.

Public function Const

bool

 

IsValidSlotIndex

(
    int32 Index
)

Public function Const

int32

 

NumSlots()

Public function

int32

 

RemoveSlot

(
    const TSharedRef< SWidget >& SlotW...
)

Removes a slot from this box panel which contains the specified SWidget

Public function Static

const FSlate...

 

StaticWidgetClass()

Overridden from SWidget

Name Description

Protected function Virtual Const

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.

Public function Virtual

FChildren &#...

 

GetChildren()

All widgets must provide a way to access their children in a layout-agnostic way.

Public function Virtual Const

void

 

OnArrangeChildren

(
    const FGeometry& AllottedGeometry,
    FArrangedChildren& ArrangedChildre...
)

Panels arrange their children in a space described by the AllottedGeometry parameter.

Overridden from FSlateControlledConstruction

Name Description

Public function Virtual Const

const FSlate...

 

GetWidgetClass()

Classes

Name

Description

Protected struct

FScopedWidgetSlotArguments

Public class

FSlot

Protected class

TSlot

A BoxPanel contains one BoxPanel child and describes how that child should be arranged on the screen.

Typedefs