SBox.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Misc/Attribute.h"
#include "Layout/Visibility.h"
#include "Widgets/DeclarativeSyntaxSupport.h"
#include "Widgets/SWidget.h"
#include "Layout/Margin.h"
#include "Layout/Children.h"
#include "Types/SlateStructs.h"
#include "Widgets/SPanel.h"
 
class FArrangedChildren;
class FPaintArgs;
class FSlateWindowElementList;
 
template <>
struct TWidgetTypeTraits<class SBox>
{
    static constexpr bool SupportsInvalidation() { return true; }
};
 
class SBox : public SPanel
{
    SLATE_DECLARE_WIDGET_API(SBox, SPanel, SLATE_API)
 
public:
    SLATE_BEGIN_ARGS(SBox)
        : _HAlign(HAlign_Fill)
        , _VAlign(VAlign_Fill)
        , _Padding(0.0f)
        , _Content()
        , _WidthOverride(FOptionalSize())
        , _HeightOverride(FOptionalSize())
        , _MinDesiredWidth(FOptionalSize())
        , _MinDesiredHeight(FOptionalSize())
        , _MaxDesiredWidth(FOptionalSize())
        , _MaxDesiredHeight(FOptionalSize())
    {
        _Visibility = EVisibility::SelfHitTestInvisible;
    }
 
    SLATE_ARGUMENT(EHorizontalAlignment, HAlign)
 
    
    SLATE_ARGUMENT(EVerticalAlignment, VAlign)
 
    
    SLATE_ATTRIBUTE(FMargin, Padding)
 
    
    SLATE_DEFAULT_SLOT(FArguments, Content)
 
    
    SLATE_ATTRIBUTE(FOptionalSize, WidthOverride)
 
    
    SLATE_ATTRIBUTE(FOptionalSize, HeightOverride)
 
    
    SLATE_ATTRIBUTE(FOptionalSize, MinDesiredWidth)
 
    
    SLATE_ATTRIBUTE(FOptionalSize, MinDesiredHeight)
 
    
    SLATE_ATTRIBUTE(FOptionalSize, MaxDesiredWidth)
 
    
    SLATE_ATTRIBUTE(FOptionalSize, MaxDesiredHeight)
 
    SLATE_ATTRIBUTE(FOptionalSize, MinAspectRatio)
 
    SLATE_ATTRIBUTE(FOptionalSize, MaxAspectRatio)
    
    FArguments& Padding(float Uniform)
    {
        _Padding = FMargin(Uniform);
        return *this;
    }
 
    FArguments& Padding(float Horizontal, float Vertical)
    {
        _Padding = FMargin(Horizontal, Vertical);
        return *this;
    }
 
    FArguments& Padding(float Left, float Top, float Right, float Bottom)
    {
        _Padding = FMargin(Left, Top, Right, Bottom);
        return *this;
    }
 
    SLATE_END_ARGS()
 
    SLATE_API SBox();
    SLATE_API virtual ~SBox();
 
    SLATE_API void Construct(const FArguments& InArgs);
 
    SLATE_API virtual void OnArrangeChildren(const FGeometry& AllottedGeometry, FArrangedChildren& ArrangedChildren) const override;
    SLATE_API virtual FChildren* GetChildren() override;
    SLATE_API virtual int32 OnPaint(const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawElements, int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled) const override;
 
    SLATE_API void SetContent(const TSharedRef< SWidget >& InContent);
 
    SLATE_API void SetHAlign(EHorizontalAlignment HAlign);
 
    SLATE_API void SetVAlign(EVerticalAlignment VAlign);
 
    SLATE_API void SetPadding(TAttribute<FMargin> InPadding);
 
    SLATE_API void SetWidthOverride(TAttribute<FOptionalSize> InWidthOverride);
 
    SLATE_API void SetHeightOverride(TAttribute<FOptionalSize> InHeightOverride);
 
    SLATE_API void SetMinDesiredWidth(TAttribute<FOptionalSize> InMinDesiredWidth);
 
    SLATE_API void SetMinDesiredHeight(TAttribute<FOptionalSize> InMinDesiredHeight);
 
    SLATE_API void SetMaxDesiredWidth(TAttribute<FOptionalSize> InMaxDesiredWidth);
 
    SLATE_API void SetMaxDesiredHeight(TAttribute<FOptionalSize> InMaxDesiredHeight);
 
    SLATE_API void SetMinAspectRatio(TAttribute<FOptionalSize> InMinAspectRatio);
 
    SLATE_API void SetMaxAspectRatio(TAttribute<FOptionalSize> InMaxAspectRatio);
 
protected:
    // Begin SWidget overrides.
    SLATE_API virtual FVector2D ComputeDesiredSize(float) const override;
    SLATE_API float ComputeDesiredWidth() const;
    SLATE_API float ComputeDesiredHeight() const;
    // End SWidget overrides.
 
protected:
 
    struct FBoxOneChildSlot : ::TSingleWidgetChildrenWithBasicLayoutSlot<EInvalidateWidgetReason::None> // we want to add it to the Attribute descriptor
    {
        friend SBox;
        using ::TSingleWidgetChildrenWithBasicLayoutSlot<EInvalidateWidgetReason::None>::TSingleWidgetChildrenWithBasicLayoutSlot;
    };
    FBoxOneChildSlot ChildSlot;
 
private:
    TSlateAttribute<FOptionalSize> WidthOverride;
 
    TSlateAttribute<FOptionalSize> HeightOverride;
 
    TSlateAttribute<FOptionalSize> MinDesiredWidth;
 
    TSlateAttribute<FOptionalSize> MinDesiredHeight;
 
    TSlateAttribute<FOptionalSize> MaxDesiredWidth;
 
    TSlateAttribute<FOptionalSize> MaxDesiredHeight;
 
    TSlateAttribute<FOptionalSize> MinAspectRatio;
 
    TSlateAttribute<FOptionalSize> MaxAspectRatio;
};