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

#include <SPrioritizedWrapBox.h>

+ Inheritance diagram for SPrioritizedWrapBox::FSlot:

Public Member Functions

SLATE_SLOT_BEGIN_ARGS_OneMixin(FSlot, TBasicLayoutWidgetSlot< FSlot >, TResizingWidgetSlotMixin< FSlot >) SLATE_ARGUMENT_DEFAULT(UE SLATE_ARGUMENT_DEFAULT (bool, ForceNewLine)
 
 SLATE_ARGUMENT_DEFAULT (bool, ExcludeIfFirstOrLast)
 
 FSlot ()
 
void Construct (const FChildren &SlotOwner, FSlotArguments &&InArgs)
 
bool GetAllowWrapping () const
 
int32 GetWrapPriority () const
 
void SetWrapPriority (int32 InPriority)
 
UE::Slate::PrioritizedWrapBox::EWrapMode GetWrapMode () const
 
UE::Slate::PrioritizedWrapBox::EVerticalOverflowBehavior GetVerticalOverflowBehavior () const
 
const TOptional< float > & GetVerticalExpansionThreshold () const
 
const bool GetForceNewLine () const
 
bool GetExcludeIfFirstOrLast () const
 
- 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 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
 

Constructor & Destructor Documentation

◆ FSlot()

SPrioritizedWrapBox::FSlot::FSlot ( )

Member Function Documentation

◆ Construct()

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

◆ GetAllowWrapping()

bool SPrioritizedWrapBox::FSlot::GetAllowWrapping ( ) const
inline

If false, this will always remain on the first line.

◆ GetExcludeIfFirstOrLast()

bool SPrioritizedWrapBox::FSlot::GetExcludeIfFirstOrLast ( ) const
inline

If, after wrapping, this slot is the first or last in the line, it will be excluded from the result if this is true.

◆ GetForceNewLine()

const bool SPrioritizedWrapBox::FSlot::GetForceNewLine ( ) const
inline

If true, this will forcibly place this slot on a new line, regardless of the wrapping behavior. This affects all slots after this one with the same or higher wrapping priorities. When AllowWrapping is false, this will only ever be placed on the line it's forcibly wrapped to.

◆ GetVerticalExpansionThreshold()

const TOptional< float > & SPrioritizedWrapBox::FSlot::GetVerticalExpansionThreshold ( ) const
inline

If the vertical overflow behavior requires expansion, this optionally specifies the height at which the slot should vertically expand.

◆ GetVerticalOverflowBehavior()

UE::Slate::PrioritizedWrapBox::EVerticalOverflowBehavior SPrioritizedWrapBox::FSlot::GetVerticalOverflowBehavior ( ) const
inline

Get the vertical overflow behavior, specifying how a slot, and it's widget should behave when they need to wrap.

◆ GetWrapMode()

UE::Slate::PrioritizedWrapBox::EWrapMode SPrioritizedWrapBox::FSlot::GetWrapMode ( ) const
inline

Get the WrapMode, which determines at what reference length the slot wraps.

◆ GetWrapPriority()

int32 SPrioritizedWrapBox::FSlot::GetWrapPriority ( ) const
inline

Higher values will wrap first. Default is 0.

◆ RegisterAttributes()

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

◆ SetWrapPriority()

void SPrioritizedWrapBox::FSlot::SetWrapPriority ( int32  InPriority)
inline

Higher values will wrap first. Default is 0.

◆ SLATE_ARGUMENT_DEFAULT() [1/2]

SPrioritizedWrapBox::FSlot::SLATE_ARGUMENT_DEFAULT ( bool  ,
ExcludeIfFirstOrLast   
)

◆ SLATE_ARGUMENT_DEFAULT() [2/2]

SLATE_SLOT_BEGIN_ARGS_OneMixin(FSlot, TBasicLayoutWidgetSlot< FSlot >, TResizingWidgetSlotMixin< FSlot >) SLATE_ARGUMENT_DEFAULT(UE SPrioritizedWrapBox::FSlot::SLATE_ARGUMENT_DEFAULT ( bool  ,
ForceNewLine   
)

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