SImage.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 "Input/Reply.h"
#include "Widgets/DeclarativeSyntaxSupport.h"
#include "Styling/SlateColor.h"
#include "Styling/CoreStyle.h"
#include "Widgets/SLeafWidget.h"
#include "Styling/SlateTypes.h"
 
class FPaintArgs;
class FSlateWindowElementList;
 
template <>
struct TWidgetTypeTraits<class SImage>
{
    static constexpr bool SupportsInvalidation() { return true; }
};
 
 
class SImage
    : public SLeafWidget
{
    SLATE_DECLARE_WIDGET_API(SImage, SLeafWidget, SLATECORE_API)
 
public:
    SLATE_BEGIN_ARGS( SImage )
        : _Image( FCoreStyle::Get().GetDefaultBrush() )
        , _ColorAndOpacity( FLinearColor::White )
        , _FlipForRightToLeftFlowDirection( false )
        { }
 
        SLATE_ATTRIBUTE(const FSlateBrush*, Image)
 
        
        SLATE_ATTRIBUTE(FSlateColor, ColorAndOpacity)
 
        
        SLATE_ATTRIBUTE(TOptional<FVector2D>, DesiredSizeOverride)
 
        
        SLATE_ARGUMENT( bool, FlipForRightToLeftFlowDirection )
 
        
        SLATE_EVENT(FPointerEventHandler, OnMouseButtonDown)
    SLATE_END_ARGS()
 
    
    SLATECORE_API SImage();
    SLATECORE_API virtual ~SImage();
 
    SLATECORE_API void Construct( const FArguments& InArgs );
 
public:
 
    SLATECORE_API void SetColorAndOpacity(TAttribute<FSlateColor> InColorAndOpacity);
 
    SLATECORE_API void SetColorAndOpacity( FLinearColor InColorAndOpacity );
 
    SLATECORE_API void SetImage(TAttribute<const FSlateBrush*> InImage);
 
    SLATECORE_API void InvalidateImage();
 
    SLATECORE_API void SetDesiredSizeOverride(TAttribute<TOptional<FVector2D>> InDesiredSizeOverride);
 
    SLATECORE_API void FlipForRightToLeftFlowDirection(bool InbFlipForRightToLeftFlowDirection);
 
public:
 
    // SWidget overrides
    SLATECORE_API virtual int32 OnPaint( const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawElements, int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled ) const override;
#if WITH_ACCESSIBILITY
    SLATECORE_API virtual TSharedRef<FSlateAccessibleWidget> CreateAccessibleWidget() override;
#endif
 
protected:
    // Begin SWidget overrides.
    SLATECORE_API virtual FVector2D ComputeDesiredSize(float) const override;
    // End SWidget overrides.
 
    TSlateAttributeRef<const FSlateBrush*> GetImageAttribute() const { return TSlateAttributeRef<FSlateBrush const*>(SharedThis(this), ImageAttribute); }
 
    TSlateAttributeRef<FSlateColor> GetColorAndOpacityAttribute() const { return TSlateAttributeRef<FSlateColor>(SharedThis(this), ColorAndOpacityAttribute); }
 
    TSlateAttributeRef<TOptional<FVector2D>> GetDesiredSizeOverrideAttribute() const { return TSlateAttributeRef<TOptional<FVector2D>>(SharedThis(this), DesiredSizeOverrideAttribute); }
 
private:
    TSlateAttribute<const FSlateBrush*> ImageAttribute;
 
    TSlateAttribute<FSlateColor> ColorAndOpacityAttribute;
 
    TSlateAttribute<TOptional<FVector2D>> DesiredSizeOverrideAttribute;
 
protected:
    bool bFlipForRightToLeftFlowDirection;
};