1. Epic GamesDeveloper
  3. USizeBox

USizeBox

A widget that allows you to specify the size it reports to have and desire.

Unreal Engine C++ API Reference > Runtime > UMG > Components

Inheritance Hierarchy

References

   
Module UMG
Header /Engine/Source/Runtime/UMG/Public/Components/SizeBox.h
Include #include "Components/SizeBox.h"

Syntax

UCLASS (MinimalAPI)  
class USizeBox : public UContentWidget

Remarks

A widget that allows you to specify the size it reports to have and desire. Not all widgets report a desired size that you actually desire. Wrapping them in a SizeBox lets you have the Size Box force them to be a particular size.

  • Single Child
  • Fixed Size

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bOverride_HeightOverride  
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bOverride_MaxAspectRatio  
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bOverride_MaxDesiredHeight  
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bOverride_MaxDesiredWidth  
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bOverride_MinAspectRatio  
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bOverride_MinDesiredHeight  
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bOverride_MinDesiredWidth  
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bOverride_WidthOverride  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter, getter, setter float HeightOverride When specified, ignore the content's desired size and report the HeightOverride as the Box's desired height.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter, getter, setter float MaxAspectRatio  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter, getter, setter float MaxDesiredHeight When specified, will report the MaxDesiredHeight if smaller than the content's desired height.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter, getter, setter float MaxDesiredWidth When specified, will report the MaxDesiredWidth if smaller than the content's desired width.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter, getter, setter float MinAspectRatio  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter, getter, setter float MinDesiredHeight When specified, will report the MinDesiredHeight if larger than the content's desired height.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter, getter, setter float MinDesiredWidth When specified, will report the MinDesiredWidth if larger than the content's desired width.
Protected variable TSharedPtr< SBox > MySizeBox  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter, getter, setter float WidthOverride When specified, ignore the content's desired size and report the WidthOverride as the Box's desired width.

Constructors

  Type Name Description
Public function  

USizeBox ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void  
Public function Const float  
Public function Const float  
Public function Const float  
Public function Const float  
Public function Const float  
Public function Const float  
Public function Const float  
Public function Const float  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function UFunction BlueprintCallable, Category void

SetHeightOverride ( float InHeightOverride
)

 When specified, ignore the content's desired size and report the HeightOverride as the Box's desired height.
Public function UFunction BlueprintCallable, Category void

SetMaxAspectRatio ( float InMaxAspectRatio
)

  
Public function UFunction BlueprintCallable, Category void

SetMaxDesiredHeight ( float InMaxDesiredHeight
)

 When specified, will report the MaxDesiredHeight if smaller than the content's desired height.
Public function UFunction BlueprintCallable, Category void

SetMaxDesiredWidth ( float InMaxDesiredWidth
)

 When specified, will report the MaxDesiredWidth if smaller than the content's desired width.
Public function UFunction BlueprintCallable, Category void

SetMinAspectRatio ( float InMinAspectRatio
)

  
Public function UFunction BlueprintCallable, Category void

SetMinDesiredHeight ( float InMinDesiredHeight
)

 When specified, will report the MinDesiredHeight if larger than the content's desired height.
Public function UFunction BlueprintCallable, Category void

SetMinDesiredWidth ( float InMinDesiredWidth
)

 When specified, will report the MinDesiredWidth if larger than the content's desired width.
Public function UFunction BlueprintCallable, Category void

SetWidthOverride ( float InWidthOverride
)

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

Overridden from UPanelWidget

  Type Name Description
Protected function Virtual Const UClass * UPanelWidget.
Protected function Virtual void  
Protected function Virtual void  

Overridden from UWidget

  Type Name Description
Public function Virtual const FText Gets the palette category of the widget
Protected function Virtual TSharedRef< SWidget > Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
Public function Virtual void Applies all properties to the native widget if possible.

Overridden from UVisual

  Type Name Description
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page