UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
SScrollBox::FSlot Class Reference

#include <SScrollBox.h>

+ Inheritance diagram for SScrollBox::FSlot:

Public Member Functions

 SLATE_SLOT_BEGIN_ARGS_OneMixin (FSlot, TBasicLayoutWidgetSlot< FSlot >, TResizingWidgetSlotMixin< FSlot >) FSlotArguments &AutoSize()
 
FSlotArgumentsFillSize (TAttribute< float > InStretchCoefficient)
 
FSlotArgumentsFillContentSize (TAttribute< float > InStretchCoefficient, TAttribute< float > InShrinkStretchCoefficient=TAttribute< float >())
 
FSlotArgumentsMinSize (TAttribute< float > InMinHeight)
 
FSlotArgumentsMaxSize (TAttribute< float > InMaxHeight)
 
 FSlot ()
 
SLATE_API void Construct (const FChildren &SlotOwner, FSlotArguments &&InArgs)
 
- Public Member Functions inherited from TBasicLayoutWidgetSlot< FSlot >
 TBasicLayoutWidgetSlot ()
 
 TBasicLayoutWidgetSlot (FChildren &InOwner)
 
 TBasicLayoutWidgetSlot (const EHorizontalAlignment InHAlign, const EVerticalAlignment InVAlign)
 
 TBasicLayoutWidgetSlot (FChildren &InOwner, const EHorizontalAlignment InHAlign, const EVerticalAlignment InVAlign)
 
 SLATE_SLOT_BEGIN_ARGS_TwoMixins (TBasicLayoutWidgetSlot, TSlotBase< FSlot >, TPaddingWidgetSlotMixin< FSlot >, TAlignmentWidgetSlotMixin< FSlot >) void Construct(const FChildren &SlotOwner
 
 TPaddingWidgetSlotMixin (SlotOwner, MoveTemp(InArgs))
 
 TAlignmentWidgetSlotMixin (SlotOwner, MoveTemp(InArgs))
 
- Public Member Functions inherited from TWidgetSlotWithAttributeSupport< SlotType >
virtual ~TWidgetSlotWithAttributeSupport ()
 
void Construct (const FChildren &SlotOwner, typename Super::FSlotArguments &&InArgs)
 
void RequestSortAttribute ()
 
virtual SWidgetGetContainerWidget () const override
 
virtual FName GetContainerName () const override
 
virtual uint32 GetContainerSortOrder () const override
 
- Public Member Functions inherited from TSlotBase< SlotType >
SlotType & operator[] (TSharedRef< SWidget > &&InChildWidget)
 
SlotType & operator[] (const TSharedRef< SWidget > &InChildWidget)
 
SlotType & Expose (SlotType *&OutVarToInit)
 
void Construct (const FChildren &SlotOwner, FSlotArguments &&InArgs)
 
SLATECORE_API FSlotBase ()
 
SLATECORE_API FSlotBase (const FChildren &InParent)
 
SLATECORE_API FSlotBase (const TSharedRef< SWidget > &InWidget)
 
 FSlotBase (const FSlotBase &)=delete
 
- Public Member Functions inherited from FSlotBase
SLATECORE_API FSlotBase ()
 
SLATECORE_API FSlotBase (const FChildren &InParent)
 
SLATECORE_API FSlotBase (const TSharedRef< SWidget > &InWidget)
 
FSlotBaseoperator= (const FSlotBase &)=delete
 
 FSlotBase (const FSlotBase &)=delete
 
virtual SLATECORE_API ~FSlotBase ()
 
const FChildrenGetOwner () const
 
SLATECORE_API SWidgetGetOwnerWidget () const
 
SLATECORE_API void SetOwner (const FChildren &Children)
 
void AttachWidget (TSharedRef< SWidget > &&InWidget)
 
void AttachWidget (const TSharedRef< SWidget > &InWidget)
 
const TSharedRef< SWidget > & GetWidget () const
 
SLATECORE_API const TSharedPtr< SWidgetDetachWidget ()
 
SLATECORE_API void Invalidate (EInvalidateWidgetReason InvalidateReason)
 
- Public Member Functions inherited from TPaddingWidgetSlotMixin< MixedIntoType >
 TPaddingWidgetSlotMixin ()
 
 TPaddingWidgetSlotMixin (const FMargin &Margin)
 
void SetPadding (TAttribute< FMargin > InPadding)
 
FMargin GetPadding () const
 
- Public Member Functions inherited from TAlignmentWidgetSlotMixin< MixedIntoType >
 TAlignmentWidgetSlotMixin ()
 
 TAlignmentWidgetSlotMixin (const EHorizontalAlignment InHAlign, const EVerticalAlignment InVAlign)
 
void SetHorizontalAlignment (EHorizontalAlignment Alignment)
 
EHorizontalAlignment GetHorizontalAlignment () const
 
void SetVerticalAlignment (EVerticalAlignment Alignment)
 
EVerticalAlignment GetVerticalAlignment () const
 
- Public Member Functions inherited from TResizingWidgetSlotMixin< FSlot >
 TResizingWidgetSlotMixin ()
 
FSizeParam::ESizeRule GetSizeRule () const
 
float GetSizeValue () const
 
float GetShrinkSizeValue () const
 
void SetSizeParam (FSizeParam InSizeParam)
 
void SetSizeToAuto ()
 
void SetSizeToStretch (TAttribute< float > InStretchCoefficient)
 
void SetSizeToStretchContent (TAttribute< float > InStretchCoefficient, TAttribute< float > InShrinkStretchCoefficient=TAttribute< float >())
 
float GetMinSize () const
 
void SetMinSize (TAttribute< float > InMinSize)
 
float GetMaxSize () const
 
void SetMaxSize (TAttribute< float > InMaxSize)
 

Static Public Member Functions

static SLATE_API void RegisterAttributes (FSlateWidgetSlotAttributeInitializer &AttributeInitializer)
 
- Static Public Member Functions inherited from TBasicLayoutWidgetSlot< FSlot >
static void RegisterAttributes (FSlateWidgetSlotAttributeInitializer &AttributeInitializer)
 
- Static Public Member Functions inherited from TWidgetSlotWithAttributeSupport< SlotType >
static void RegisterAttributes (FSlateWidgetSlotAttributeInitializer &AttributeInitializer)
 

Additional Inherited Members

- Public Types inherited from TSlotBase< SlotType >
enum  EConstructSlotIsFChildren { ConstructSlotIsFChildren }
 
- Public Attributes inherited from TBasicLayoutWidgetSlot< FSlot >
FSlotArguments && InArgs
 
- Protected Types inherited from TResizingWidgetSlotMixin< FSlot >
using TSlateSlotAttribute = ::SlateAttributePrivate::TSlateContainedAttribute< InObjectType, ::SlateAttributePrivate::FSlateAttributeNoInvalidationReason, TSlateAttributeComparePredicate<> >
 
- Protected Member Functions inherited from FSlotBase
template<typename TargetValueType , typename SourceValueType >
bool SetAttribute (TAttribute< TargetValueType > &TargetValue, const TAttribute< SourceValueType > &SourceValue, EInvalidateWidgetReason BaseInvalidationReason)
 
- Protected Member Functions inherited from SlateAttributePrivate::ISlateAttributeContainer
SLATECORE_API void RemoveContainerWidget (SWidget &Widget)
 
SLATECORE_API void UpdateContainerSortOrder (SWidget &Widget)
 
- Protected Member Functions inherited from TPaddingWidgetSlotMixin< MixedIntoType >
void ConstructMixin (const FChildren &SlotOwner, FSlotArgumentsMixin &&InArgs)
 
- Protected Member Functions inherited from TAlignmentWidgetSlotMixin< MixedIntoType >
void ConstructMixin (const FChildren &SlotOwner, FSlotArgumentsMixin &&InArgs)
 
- Protected Member Functions inherited from TResizingWidgetSlotMixin< FSlot >
void ConstructMixin (const FChildren &SlotOwner, FSlotArgumentsMixin &&InArgs)
 
- Static Protected Member Functions inherited from TPaddingWidgetSlotMixin< MixedIntoType >
static void RegisterAttributesMixin (FSlateWidgetSlotAttributeInitializer &AttributeInitializer)
 
- Static Protected Member Functions inherited from TResizingWidgetSlotMixin< FSlot >
static void RegisterAttributesMixin (FSlateWidgetSlotAttributeInitializer &AttributeInitializer)
 
- Protected Attributes inherited from TResizingWidgetSlotMixin< FSlot >
FSizeParam::ESizeRule SizeRule
 
TSlateSlotAttribute< floatSizeValue
 
TSlateSlotAttribute< floatShrinkSizeValue
 
TSlateSlotAttribute< floatMinSize
 
TSlateSlotAttribute< floatMaxSize
 

Detailed Description

A Slot that provides layout options for the contents of a scrollable box.

Constructor & Destructor Documentation

◆ FSlot()

SScrollBox::FSlot::FSlot ( )
inline

Default values for a slot.

Member Function Documentation

◆ Construct()

void SScrollBox::FSlot::Construct ( const FChildren SlotOwner,
FSlotArguments &&  InArgs 
)

◆ FillContentSize()

FSlotArguments & SScrollBox::FSlot::FillContentSize ( TAttribute< float InStretchCoefficient,
TAttribute< float InShrinkStretchCoefficient = TAttribute<float>() 
)
inline

The widget's content size is adjusted proportionally to fit the available space. The slots size starts at DesiredSize, and a slot with coefficient of 2 will get adjusted twice as much as slot with coefficient 1 to fit the available space.

Parameters
InStretchCoefficientStretch coefficient for this slot.
InShrinkStretchCoefficientIf specified, this stretch coefficient is used when the slots is shrinking below desired size. Otherwise InStretchCoefficient is used for both shrink and grow.

◆ FillSize()

FSlotArguments & SScrollBox::FSlot::FillSize ( TAttribute< float InStretchCoefficient)
inline

The available space will be distributed proportionately.

◆ MaxSize()

FSlotArguments & SScrollBox::FSlot::MaxSize ( TAttribute< float InMaxHeight)
inline

Set the max size in SlateUnit this slot can be.

◆ MinSize()

FSlotArguments & SScrollBox::FSlot::MinSize ( TAttribute< float InMinHeight)
inline

Set the min size in SlateUnit this slot can be.

◆ RegisterAttributes()

void SScrollBox::FSlot::RegisterAttributes ( FSlateWidgetSlotAttributeInitializer AttributeInitializer)
static

◆ SLATE_SLOT_BEGIN_ARGS_OneMixin()

SScrollBox::FSlot::SLATE_SLOT_BEGIN_ARGS_OneMixin ( FSlot  ,
TBasicLayoutWidgetSlot< FSlot ,
TResizingWidgetSlotMixin< FSlot  
) &
inline

The widget's DesiredSize will be used as the space required.


The documentation for this class was generated from the following files: