#include <SlateStructs.h>

Inheritance diagram for FSizeParam:

Public Types
enum	ESizeRule { SizeRule_Auto , SizeRule_Stretch , SizeRule_StretchContent }

Public Attributes
ESizeRule	SizeRule

TAttribute< float >	Value

TAttribute< float >	ShrinkValue

Protected Member Functions
	FSizeParam (ESizeRule InTypeOfSize, const TAttribute< float > &InValue, const TAttribute< float > &InShrinkValue)

Detailed Description

Base structure for size parameters.

Describes a way in which a parent widget allocates available space to its child widgets.

When SizeRule is SizeRule_Auto, the required space is the widget's DesiredSize. When SizeRule is SizeRule_Stretch, the required space is the available space distributed proportionately between peer Widgets. When SizeRule is SizeRule_StretchContent, the required space is widget's content size adjusted proportionally to fit the available space.

Available space is space remaining after all the peers' SizeRule_Auto requirements have been satisfied. The available space is distributed proportionally between the peer widgets depending on the Value property.

FSizeParam cannot be constructed directly - see FStretch, FStretchContent, FAuto, and FAspectRatio

Examples: /work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

Member Enumeration Documentation

◆ ESizeRule

enum FSizeParam::ESizeRule

Enumerator
SizeRule_Auto
SizeRule_Stretch
SizeRule_StretchContent

Constructor & Destructor Documentation

◆ FSizeParam()

FSizeParam::FSizeParam	(	ESizeRule	InTypeOfSize,
		const TAttribute< float > &	InValue,
		const TAttribute< float > &	InShrinkValue
	)

inlineprotected

Hidden constructor.

Use FAspectRatio, FAuto, FStretch to instantiate size parameters.

See also: FAspectRatio, FAuto, FStretch

Member Data Documentation

◆ ShrinkValue

TAttribute<float> FSizeParam::ShrinkValue

The actual value this size parameter stores, used for shrinking. Treated as unused, if set to negative value.

This value can be driven by a delegate. It is only used for the StretchContent mode.

◆ SizeRule

ESizeRule FSizeParam::SizeRule

The sizing rule to use.

◆ Value

TAttribute<float> FSizeParam::Value

The actual value this size parameter stores.

This value can be driven by a delegate. It is only used for the Stretch and StretchContent modes.

The documentation for this struct was generated from the following file:

Engine/Source/Runtime/SlateCore/Public/Types/SlateStructs.h

Public Types

Public Attributes

Protected Member Functions