Navigation
API > API/Runtime > API/Runtime/UMG > API/Runtime/UMG/Components
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UVisual
- UWidget
- UPanelWidget
- UContentWidget
- USizeBox
- UCommonVisualAttachment
References
| Module | UMG |
| Header | /Engine/Source/Runtime/UMG/Public/Components/SizeBox.h |
| Include | #include "Components/SizeBox.h" |
Syntax
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 | |
|---|---|---|---|
| TSharedPtr< SBox > | MySizeBox |
Constructors
| Type | Name | Description | |
|---|---|---|---|
USizeBox
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | |||
| void | |||
| void | |||
| void | |||
| void | |||
| void | |||
| void | |||
| void | |||
| float | |||
| float | |||
| float | |||
| float | |||
| float | |||
| float | |||
| float | |||
| float | |||
| void | SetHeightOverride
(
float InHeightOverride |
When specified, ignore the content's desired size and report the HeightOverride as the Box's desired height. | |
| void | SetMaxAspectRatio
(
float InMaxAspectRatio |
||
| void | SetMaxDesiredHeight
(
float InMaxDesiredHeight |
When specified, will report the MaxDesiredHeight if smaller than the content's desired height. | |
| void | SetMaxDesiredWidth
(
float InMaxDesiredWidth |
When specified, will report the MaxDesiredWidth if smaller than the content's desired width. | |
| void | SetMinAspectRatio
(
float InMinAspectRatio |
||
| void | SetMinDesiredHeight
(
float InMinDesiredHeight |
When specified, will report the MinDesiredHeight if larger than the content's desired height. | |
| void | SetMinDesiredWidth
(
float InMinDesiredWidth |
When specified, will report the MinDesiredWidth if larger than the content's desired width. | |
| 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 | |
|---|---|---|---|
| UClass * | GetSlotClass () |
UPanelWidget. | |
| void | OnSlotAdded
(
UPanelSlot* Slot |
||
| void | OnSlotRemoved
(
UPanelSlot* Slot |
Overridden from UWidget
| Type | Name | Description | |
|---|---|---|---|
| const FText | Gets the palette category of the widget | ||
| TSharedRef< SWidget > | Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed. | ||
| void | Applies all properties to the native widget if possible. |
Overridden from UVisual
| Type | Name | Description | |
|---|---|---|---|
| void | ReleaseSlateResources
(
bool bReleaseChildren |
Deprecated Variables
| Type | Name | Description | |
|---|---|---|---|
| uint8: 1 | bOverride_HeightOverride | Direct access to bOverride_HeightOverride is deprecated. Please use the SetHeightOverride or ClearHeightOverride. | |
| uint8: 1 | bOverride_MaxAspectRatio | Direct access to bOverride_MaxAspectRatio is deprecated. Please use the SetMaxAspectRatio or ClearMaxAspectRatio . | |
| uint8: 1 | bOverride_MaxDesiredHeight | Direct access to bOverride_MaxDesiredHeight is deprecated. Please use the SetMaxDesiredHeight or ClearMaxDesiredHeight. | |
| uint8: 1 | bOverride_MaxDesiredWidth | Direct access to bOverride_MaxDesiredWidth is deprecated. Please use the SetMaxDesiredWidth or ClearMaxDesiredWidth. | |
| uint8: 1 | bOverride_MinAspectRatio | Direct access to bOverride_MinAspectRatio is deprecated. Please use the SetMinAspectRatio or ClearMinAspectRatio. | |
| uint8: 1 | bOverride_MinDesiredHeight | Direct access to bOverride_MinDesiredHeight is deprecated. Please use the SetMinDesiredHeight or ClearMinDesiredHeight. | |
| uint8: 1 | bOverride_MinDesiredWidth | Direct access to bOverride_MinDesiredWidth is deprecated. Please use the SetMinDesiredWidth or ClearMinDesiredWidth. | |
| uint8: 1 | bOverride_WidthOverride | Direct access to bOverride_WidthOverride is deprecated. Please use the SetWidthOverride or ClearWidthOverride. | |
| float | HeightOverride | Direct access to HeightOverride is deprecated. Please use the getter or setter. | |
| float | MaxAspectRatio | Direct access to MaxAspectRatio is deprecated. Please use the getter or setter. | |
| float | MaxDesiredHeight | Direct access to MaxDesiredHeight is deprecated. Please use the getter or setter. | |
| float | MaxDesiredWidth | Direct access to MaxDesiredWidth is deprecated. Please use the getter or setter. | |
| float | MinAspectRatio | Direct access to MinAspectRatio is deprecated. Please use the getter or setter. | |
| float | MinDesiredHeight | Direct access to MinDesiredHeight is deprecated. Please use the getter or setter. | |
| float | MinDesiredWidth | Direct access to MinDesiredWidth is deprecated. Please use the getter or setter. | |
| float | WidthOverride | Direct access to WidthOverride is deprecated. Please use the getter or setter. |