1. Epic GamesDeveloper
  3. UWrapBox

UWrapBox

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

API > API/Runtime > API/Runtime/UMG

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
   
Name UWrapBox
Type class
Header File /Engine/Source/Runtime/UMG/Public/Components/WrapBox.h
Include Path #include "Components/WrapBox.h"

Syntax

UCLASS (MinimalAPI)  
class UWrapBox : public UPanelWidget

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UWrapBox ( const FObjectInitializer& ObjectInitializer
)

   Components/WrapBox.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bExplicitWrapSize bool Use explicit wrap size whenever possible. Components/WrapBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter="UseExplicitWrapSize"
  • Setter="SetExplicitWrapSize"
  • Category="Content Layout"
HorizontalAlignment TEnumAsByte< EHorizontalAlignment > The alignment of each line of wrapped content. Components/WrapBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter="SetHorizontalAlignment"
  • Category="Content Layout"
  • Meta=(EditCondition="Orientation == EOrientation::Orient_Horizontal")
InnerSlotPadding FVector2D The inner slot padding goes between slots sharing borders Components/WrapBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter="SetInnerSlotPadding"
  • Category="Content Layout"
Orientation TEnumAsByte< EOrientation > Determines if the Wrap Box should arranges the widgets left-to-right or top-to-bottom Components/WrapBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category="Content Layout"
WrapSize float When this size is exceeded, elements will start appearing on the next line. Components/WrapBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category="Content Layout"
  • Meta=(EditCondition="bExplicitWrapSize")

Functions

Public

Name Remarks Include Path Unreal Specifiers

UWrapBoxSlot * AddChildToWrapBox ( UWidget* Content
)

   Components/WrapBox.h
  • BlueprintCallable
  • Category="Panel"

EHorizontalAlignment GetHorizontalAlignment()

   Components/WrapBox.h  

FVector2D GetInnerSlotPadding()

 Gets the inner slot padding goes between slots sharing borders Components/WrapBox.h  

EOrientation GetOrientation()

   Components/WrapBox.h  

float GetWrapSize()

   Components/WrapBox.h  

void SetExplicitWrapSize ( bool bInExplicitWrapSize
)

   Components/WrapBox.h  

void SetHorizontalAlignment ( EHorizontalAlignment InHorizontalAlignment
)

   Components/WrapBox.h
  • BlueprintCallable
  • Category="Content Layout"

void SetInnerSlotPadding ( FVector2D InPadding
)

 Sets the inner slot padding goes between slots sharing borders Components/WrapBox.h
  • BlueprintCallable
  • Category="Content Layout"

void SetOrientation ( EOrientation InOrientation
)

   Components/WrapBox.h  

void SetWrapSize ( float InWrapSize
)

   Components/WrapBox.h  

bool UseExplicitWrapSize()

   Components/WrapBox.h  

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual const FText GetPaletteCategory()

 Gets the palette category of the widget Components/WrapBox.h  

Protected

Overridden from UPanelWidget

Name Remarks Include Path Unreal Specifiers

virtual UClass * GetSlotClass()

   Components/WrapBox.h  

virtual void OnSlotAdded ( UPanelSlot* Slot
)

   Components/WrapBox.h  

virtual void OnSlotRemoved ( UPanelSlot* Slot
)

   Components/WrapBox.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/WrapBox.h  

virtual void SynchronizeProperties ()

 Applies all properties to the native widget if possible. Components/WrapBox.h  

Overridden from UVisual

Name Remarks Include Path Unreal Specifiers

virtual void ReleaseSlateResources ( bool bReleaseChildren
)

   Components/WrapBox.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page