SBorder.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 "Styling/SlateColor.h"
#include "Widgets/DeclarativeSyntaxSupport.h"
#include "Widgets/SWidget.h"
#include "Layout/Margin.h"
#include "Widgets/SCompoundWidget.h"
#include "Styling/CoreStyle.h"
#include "Styling/SlateTypes.h"
 
class FPaintArgs;
class FSlateWindowElementList;
 
template <>
struct TWidgetTypeTraits<class SBorder>
{
    static constexpr bool SupportsInvalidation() { return true; }
};
 
class SBorder : public SCompoundWidget
{
    SLATE_DECLARE_WIDGET_API(SBorder, SCompoundWidget, SLATE_API)
 
public:
 
    SLATE_BEGIN_ARGS(SBorder)
        : _Content()
        , _HAlign( HAlign_Fill )
        , _VAlign( VAlign_Fill )
        , _Padding( FMargin(2.0f) )
        , _OnMouseButtonDown()
        , _OnMouseButtonUp()
        , _OnMouseMove()
        , _OnMouseDoubleClick()
        , _BorderImage( FCoreStyle::Get().GetBrush( "Border" ) )
        , _ContentScale( FVector2D(1,1) )
        , _DesiredSizeScale( FVector2D(1,1) )
        , _ColorAndOpacity( FLinearColor(1,1,1,1) )
        , _BorderBackgroundColor( FLinearColor::White )
        , _ForegroundColor( FSlateColor::UseForeground() )
        , _ShowEffectWhenDisabled( true )
        , _FlipForRightToLeftFlowDirection(false)
        {}
 
        SLATE_DEFAULT_SLOT( FArguments, Content )
 
        SLATE_ARGUMENT( EHorizontalAlignment, HAlign )
        SLATE_ARGUMENT( EVerticalAlignment, VAlign )
        SLATE_ATTRIBUTE( FMargin, Padding )
        
        SLATE_EVENT( FPointerEventHandler, OnMouseButtonDown )
        SLATE_EVENT( FPointerEventHandler, OnMouseButtonUp )
        SLATE_EVENT( FPointerEventHandler, OnMouseMove )
        SLATE_EVENT( FPointerEventHandler, OnMouseDoubleClick )
 
        SLATE_ATTRIBUTE( const FSlateBrush*, BorderImage )
 
        SLATE_ATTRIBUTE( FVector2D, ContentScale )
 
        SLATE_ATTRIBUTE( FVector2D, DesiredSizeScale )
 
        
        SLATE_ATTRIBUTE( FLinearColor, ColorAndOpacity )
        SLATE_ATTRIBUTE( FSlateColor, BorderBackgroundColor )
        SLATE_ATTRIBUTE( FSlateColor, ForegroundColor )
        SLATE_ATTRIBUTE( bool, ShowEffectWhenDisabled )
 
        
        SLATE_ARGUMENT(bool, FlipForRightToLeftFlowDirection)
 
        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 SBorder();
    SLATE_API virtual ~SBorder();
 
    SLATE_API void Construct( const FArguments& InArgs );
 
    SLATE_API virtual void SetContent( TSharedRef< SWidget > InContent );
 
    SLATE_API const TSharedRef< SWidget >& GetContent() const;
 
    SLATE_API void ClearContent();
 
    SLATE_API void SetBorderBackgroundColor(TAttribute<FSlateColor> InColorAndOpacity);
 
    FSlateColor GetBorderBackgroundColor() const { return BorderBackgroundColorAttribute.Get(); }
 
    SLATE_API void SetDesiredSizeScale(TAttribute<FVector2D> InDesiredSizeScale);
    
    SLATE_API void SetHAlign(EHorizontalAlignment HAlign);
 
    SLATE_API void SetVAlign(EVerticalAlignment VAlign);
 
    SLATE_API void SetPadding(TAttribute<FMargin> InPadding);
 
    SLATE_API void SetShowEffectWhenDisabled(TAttribute<bool> InShowEffectWhenDisabled);
 
    SLATE_API void SetBorderImage(TAttribute<const FSlateBrush*> InBorderImage);
 
    const FSlateBrush* GetBorderImage() const { return BorderImageAttribute.Get(); }
 
public:
    // SWidget interface
    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;
    // End of SWidget interface
 
protected:
    //~Begin SWidget overrides.
    SLATE_API virtual FVector2D ComputeDesiredSize(float) const override;
    //~End SWidget overrides.
 
    bool GetShowDisabledEffect() const { return ShowDisabledEffectAttribute.Get(); }
 
    FVector2D GetDesiredSizeScale() const { return DesiredSizeScaleAttribute.Get(); }
 
    TSlateAttributeRef<const FSlateBrush*> GetBorderImageAttribute() const { return TSlateAttributeRef<const FSlateBrush*>(SharedThis(this), BorderImageAttribute); }
    TSlateAttributeRef<FSlateColor> GetBorderBackgroundColorAttribute() const { return TSlateAttributeRef<FSlateColor>(SharedThis(this), BorderBackgroundColorAttribute); }
    TSlateAttributeRef<FVector2D> GetDesiredSizeScaleAttribute() const { return TSlateAttributeRef<FVector2D>(SharedThis(this), DesiredSizeScaleAttribute); }
    TSlateAttributeRef<bool> GetShowDisabledEffectAttribute() const { return TSlateAttributeRef<bool>(SharedThis(this), ShowDisabledEffectAttribute); }
 
 private:
    TSlateAttribute<const FSlateBrush*> BorderImageAttribute;
    TSlateAttribute<FSlateColor> BorderBackgroundColorAttribute;
    TSlateAttribute<FVector2D> DesiredSizeScaleAttribute;
    TSlateAttribute<bool> ShowDisabledEffectAttribute;
 
    bool bFlipForRightToLeftFlowDirection;
 };