1. Epic GamesDeveloper
  3. USizeBoxComponent

USizeBoxComponent

This is a class for a Component that wraps the Owner widget with a Size Box.

API > API/Runtime > API/Runtime/UMG

This is a class for a Component that wraps the Owner widget with a Size Box.

   
Name USizeBoxComponent
Type class
Header File /Engine/Source/Runtime/UMG/Public/Components/SizeBoxComponent.h
Include Path #include "Components/SizeBoxComponent.h"

Syntax

UCLASS (MinimalAPI, Experimental)  
class USizeBoxComponent : public UUIComponent

Inheritance Hierarchy

Implements Interfaces

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bOverride_HeightOverride uint8   Components/SizeBoxComponent.h
  • EditAnywhere
  • Category="Child Layout"
  • Meta=(InlineEditConditionToggle, AllowPrivateAccess=true)
bOverride_MaxAspectRatio uint8   Components/SizeBoxComponent.h
  • EditAnywhere
  • Category="Child Layout"
  • Meta=(InlineEditConditionToggle, AllowPrivateAccess=true)
bOverride_MaxDesiredHeight uint8   Components/SizeBoxComponent.h
  • EditAnywhere
  • Category="Child Layout"
  • Meta=(InlineEditConditionToggle, AllowPrivateAccess=true)
bOverride_MaxDesiredWidth uint8   Components/SizeBoxComponent.h
  • EditAnywhere
  • Category="Child Layout"
  • Meta=(InlineEditConditionToggle, AllowPrivateAccess=true)
bOverride_MinAspectRatio uint8   Components/SizeBoxComponent.h
  • EditAnywhere
  • Category="Child Layout"
  • Meta=(InlineEditConditionToggle, AllowPrivateAccess=true)
bOverride_MinDesiredHeight uint8   Components/SizeBoxComponent.h
  • EditAnywhere
  • Category="Child Layout"
  • Meta=(InlineEditConditionToggle, AllowPrivateAccess=true)
bOverride_MinDesiredWidth uint8   Components/SizeBoxComponent.h
  • EditAnywhere
  • Category="Child Layout"
  • Meta=(InlineEditConditionToggle, AllowPrivateAccess=true)
bOverride_WidthOverride uint8   Components/SizeBoxComponent.h
  • EditAnywhere
  • Category="Child Layout"
  • Meta=(InlineEditConditionToggle, AllowPrivateAccess=true)
HeightOverride float When specified, ignore the content's desired size and report the HeightOverride as the Box's desired height. Components/SizeBoxComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category="Child Layout"
  • Meta=(editcondition="bOverride_HeightOverride", AllowPrivateAccess=true)
HorizontalAlignment TEnumAsByte< EHorizontalAlignment > This property is for the Widget that owns this Component. The alignment of the object horizontally. Components/SizeBoxComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category="Size Box Slot"
  • Meta=(AllowPrivateAccess=true)
MaxAspectRatio float   Components/SizeBoxComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category="Child Layout"
  • Meta=(editcondition="bOverride_MaxAspectRatio", AllowPrivateAccess=true)
MaxDesiredHeight float When specified, will report the MaxDesiredHeight if smaller than the content's desired height. Components/SizeBoxComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category="Child Layout"
  • Meta=(editcondition="bOverride_MaxDesiredHeight", AllowPrivateAccess=true)
MaxDesiredWidth float When specified, will report the MaxDesiredWidth if smaller than the content's desired width. Components/SizeBoxComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category="Child Layout"
  • Meta=(editcondition="bOverride_MaxDesiredWidth", AllowPrivateAccess=true)
MinAspectRatio float   Components/SizeBoxComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category="Child Layout"
  • Meta=(editcondition="bOverride_MinAspectRatio", AllowPrivateAccess=true)
MinDesiredHeight float When specified, will report the MinDesiredHeight if larger than the content's desired height. Components/SizeBoxComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category="Child Layout"
  • Meta=(editcondition="bOverride_MinDesiredHeight", AllowPrivateAccess=true)
MinDesiredWidth float When specified, will report the MinDesiredWidth if larger than the content's desired width. Components/SizeBoxComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category="Child Layout"
  • Meta=(editcondition="bOverride_MinDesiredWidth", AllowPrivateAccess=true)
MySizeBox TWeakPtr< SBox >   Components/SizeBoxComponent.h  
Padding FMargin This property is for the Widget that owns this Component. Components/SizeBoxComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category="Size Box Slot"
  • Meta=(AllowPrivateAccess=true)
VerticalAlignment TEnumAsByte< EVerticalAlignment > This property is for the Widget that owns this Component. The alignment of the object vertically. Components/SizeBoxComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category="Size Box Slot"
  • Meta=(AllowPrivateAccess=true)
WidthOverride float When specified, ignore the content's desired size and report the WidthOverride as the Box's desired width. Components/SizeBoxComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category="Child Layout"
  • Meta=(editcondition="bOverride_WidthOverride", AllowPrivateAccess=true)

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ClearHeightOverride()

   Components/SizeBoxComponent.h
  • BlueprintCallable
  • Category="Layout|Size Box"

void ClearMaxAspectRatio()

   Components/SizeBoxComponent.h
  • BlueprintCallable
  • Category="Layout|Size Box"

void ClearMaxDesiredHeight()

   Components/SizeBoxComponent.h
  • BlueprintCallable
  • Category="Layout|Size Box"

void ClearMaxDesiredWidth()

   Components/SizeBoxComponent.h
  • BlueprintCallable
  • Category="Layout|Size Box"

void ClearMinAspectRatio()

   Components/SizeBoxComponent.h
  • BlueprintCallable
  • Category="Layout|Size Box"

void ClearMinDesiredHeight()

   Components/SizeBoxComponent.h
  • BlueprintCallable
  • Category="Layout|Size Box"

void ClearMinDesiredWidth()

   Components/SizeBoxComponent.h
  • BlueprintCallable
  • Category="Layout|Size Box"

void ClearWidthOverride()

   Components/SizeBoxComponent.h
  • BlueprintCallable
  • Category="Layout|Size Box"

float GetHeightOverride()

   Components/SizeBoxComponent.h  

EHorizontalAlignment GetHorizontalAlignment()

   Components/SizeBoxComponent.h  

float GetMaxAspectRatio()

   Components/SizeBoxComponent.h  

float GetMaxDesiredHeight()

   Components/SizeBoxComponent.h  

float GetMaxDesiredWidth()

   Components/SizeBoxComponent.h  

float GetMinAspectRatio()

   Components/SizeBoxComponent.h  

float GetMinDesiredHeight()

   Components/SizeBoxComponent.h  

float GetMinDesiredWidth()

   Components/SizeBoxComponent.h  

FMargin GetPadding()

   Components/SizeBoxComponent.h  

EVerticalAlignment GetVerticalAlignment()

   Components/SizeBoxComponent.h  

float GetWidthOverride()

   Components/SizeBoxComponent.h  

bool IsHeightOverride()

   Components/SizeBoxComponent.h  

bool IsMaxAspectRatioOverride()

   Components/SizeBoxComponent.h  

bool IsMaxDesiredHeightOverride()

   Components/SizeBoxComponent.h  

bool IsMaxDesiredWidthOverride()

   Components/SizeBoxComponent.h  

bool IsMinAspectRatioOverride()

   Components/SizeBoxComponent.h  

bool IsMinDesiredHeightOverride()

   Components/SizeBoxComponent.h  

bool IsMinDesiredWidthOverride()

   Components/SizeBoxComponent.h  

bool IsWidthOverride()

   Components/SizeBoxComponent.h  

void SetHeightOverride ( float InHeightOverride
)

 When specified, ignore the content's desired size and report the HeightOverride as the Box's desired height. Components/SizeBoxComponent.h  

void SetHorizontalAlignment ( EHorizontalAlignment InHorizontalAlignment
)

   Components/SizeBoxComponent.h  

void SetMaxAspectRatio ( float InMaxAspectRatio
)

   Components/SizeBoxComponent.h  

void SetMaxDesiredHeight ( float InMaxDesiredHeight
)

 When specified, will report the MaxDesiredHeight if smaller than the content's desired height. Components/SizeBoxComponent.h  

void SetMaxDesiredWidth ( float InMaxDesiredWidth
)

 When specified, will report the MaxDesiredWidth if smaller than the content's desired width. Components/SizeBoxComponent.h  

void SetMinAspectRatio ( float InMinAspectRatio
)

   Components/SizeBoxComponent.h  

void SetMinDesiredHeight ( float InMinDesiredHeight
)

 When specified, will report the MinDesiredHeight if larger than the content's desired height. Components/SizeBoxComponent.h  

void SetMinDesiredWidth ( float InMinDesiredWidth
)

 When specified, will report the MinDesiredWidth if larger than the content's desired width. Components/SizeBoxComponent.h  

void SetPadding ( FMargin InPadding
)

   Components/SizeBoxComponent.h  

void SetVerticalAlignment ( EVerticalAlignment InVerticalAlignment
)

   Components/SizeBoxComponent.h  

void SetWidthOverride ( float InWidthOverride
)

 When specified, ignore the content's desired size and report the WidthOverride as the Box's desired width. Components/SizeBoxComponent.h  

Overridden from UUIComponent

Name Remarks Include Path Unreal Specifiers

virtual TSharedRef< SWidget > RebuildWidgetWithContent ( const TSharedRef< SWidget > Content
)

 Called when the OwnerWidget is Rebuilt to allow to build a more complex hierarchy between the owner parents and the Owner widget. Components/SizeBoxComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Components/SizeBoxComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page