UWrapBox

Arranges widgets left-to-right or top-to-bottom dependently of the orientation.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

UMG

Header

/Engine/Source/Runtime/UMG/Public/Components/WrapBox.h

Include

#include "Components/WrapBox.h"

Syntax

class UWrapBox : public UPanelWidget

Remarks

Arranges widgets left-to-right or top-to-bottom dependently of the orientation. When the widgets exceed the wrapSize it will place widgets on the next line.

Many Children Flows Wraps

Variables

Name Description

Public variable

bool

 

bExplicitWrapSize

Use explicit wrap size whenever possible.

Public variable

TEnumAsByte< EH...

 

HorizontalAlignment

The alignment of each line of wrapped content.

Public variable

FVector2D

 

InnerSlotPadding

The inner slot padding goes between slots sharing borders

Protected variable

TSharedPtr< cla...

 

MyWrapBox

Public variable

TEnumAsByte< EO...

 

Orientation

Determines if the Wrap Box should arranges the widgets left-to-right or top-to-bottom

Public variable

float

 

WrapSize

When this size is exceeded, elements will start appearing on the next line.

Constructors

Name Description

Public function

UWrapBox

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

UWrapBoxSlot...

 

AddChildToWrapBox

(
    UWidget* Content
)

Public function

void

 

SetHorizontalAlignment

(
    EHorizontalAlignment InHorizontalAl...
)

Public function

void

 

SetInnerSlotPadding

(
    FVector2D InPadding
)

Sets the inner slot padding goes between slots sharing borders

Overridden from UPanelWidget

Name Description

Protected function Virtual Const

UClass *

 

GetSlotClass()

UPanelWidget.

Protected function Virtual

void

 

OnSlotAdded

(
    UPanelSlot* Slot
)

Protected function Virtual

void

 

OnSlotRemoved

(
    UPanelSlot* Slot
)

Overridden from UWidget

Name Description

Public function Virtual

const FText

 

GetPaletteCategory()

Gets the palette category of the widget

Protected function Virtual

TSharedRef< ...

 

RebuildWidget()

Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.

Protected function Virtual

void

 

SynchronizeProperties()

Applies all properties to the native widget if possible.

Overridden from UVisual

Name Description

Protected function Virtual

void

 

ReleaseSlateResources

(
    bool bReleaseChildren
)

Overridden from UObject

Name Description

Public function Virtual

void

 

PostLoad()

Begin UObject.

Deprecated Variables

Name Description

Public variable

bool

 

bExplicitWrapWidth_DEPRECATED

DEPRECATED value replaced by bExplicitWrapSize, Use explicit wrap width whenever possible.

Public variable

float

 

WrapWidth_DEPRECATED

DEPRECATED value replaced by WrapSize, When this width is exceeded, elements will start appearing on the next line.

Deprecated Functions

Name Description

Public function

UWrapBoxSlot...

 

AddChildWrapBox

(
    UWidget* Content
)

Deprecated, please use AddChildToWrapBox() instead