SColorThemes.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/DragAndDrop.h"
#include "Input/Reply.h"
#include "Layout/Visibility.h"
#include "Widgets/DeclarativeSyntaxSupport.h"
#include "Styling/SlateColor.h"
#include "Layout/Children.h"
#include "Framework/MultiBox/MultiBox.h"
#include "Widgets/SCompoundWidget.h"
#include "Widgets/SPanel.h"
#include "Widgets/SOverlay.h"
#include "Widgets/Views/STableViewBase.h"
#include "Widgets/Views/STableRow.h"
#include "Widgets/Colors/SColorBlock.h"
 
class FArrangedChildren;
class SEditableTextBox;
class SErrorText;
class STextBlock;
class SThemeColorBlocksBar;
class UToolMenu;
 
struct FColorInfo
{
    TSharedPtr<FLinearColor> Color;
 
    FText Label;
 
    FColorInfo(TSharedPtr<FLinearColor> InColor)
    {
        Color = InColor;
        Label = FText();
    }
 
    FColorInfo(TSharedPtr<FLinearColor> InColor, FText InLabel)
    {
        Color = InColor;
        Label = InLabel;
    }
};
 
class FColorTheme
{
public:
 
    FColorTheme(const FString& InName = TEXT(""), const TArray< TSharedPtr<FColorInfo> >& InColors = TArray< TSharedPtr<FColorInfo> >());
 
    const TArray< TSharedPtr<FColorInfo> >& GetColors() const
    {
        return Colors;
    }
 
    void InsertNewColor(TSharedPtr<FLinearColor> InColor, int32 InsertPosition);
    void InsertNewColor(TSharedPtr<FColorInfo> InColor, int32 InsertPosition);
 
    int32 FindApproxColor(const FLinearColor& InColor, float Tolerance = KINDA_SMALL_NUMBER) const;
 
    void RemoveAll();
 
    int32 RemoveColor(const TSharedPtr<FLinearColor> InColor);
    
    FString Name;
 
    DECLARE_EVENT( FColorTheme, FRefreshEvent );
    FRefreshEvent& OnRefresh()
    {
        return RefreshEvent;
    }
 
private:
 
    TArray< TSharedPtr<FColorInfo> > Colors;
 
    FRefreshEvent RefreshEvent;
};
 
 
class UE_DEPRECATED(5.6, "SColorTrash is deprecated. SThemeColorBlocksBar now uses a simple SButton for its delete button.") SColorTrash
    : public SCompoundWidget
{
public:
 
    SLATE_BEGIN_ARGS(SColorTrash)
        : _UsesSmallIcon(false)
    { }
 
        SLATE_ATTRIBUTE(bool, UsesSmallIcon)
    SLATE_END_ARGS()
 
    void Construct( const FArguments& InArgs );
 
protected:  
 
    virtual void OnDragEnter( const FGeometry& MyGeometry, const FDragDropEvent& DragDropEvent ) override;
 
    virtual void OnDragLeave( const FDragDropEvent& DragDropEvent ) override;
 
    virtual FReply OnDrop( const FGeometry& MyGeometry, const FDragDropEvent& DragDropEvent ) override;
    
    const FSlateBrush* GetBorderStyle() const;
 
private:
 
    bool bBorderActivated;
};
 
 
class SThemeColorBlock
    : public SCompoundWidget
{
public:
 
    SLATE_BEGIN_ARGS(SThemeColorBlock)
        : _Color()
        , _ColorInfo()
        , _OnSelectColor()
        , _Parent()
        , _ShowTrashCallback()
        , _HideTrashCallback()
        , _UseSRGB()
        , _UseAlpha()
        , _SupportsDrag(true)
    { }
 
        SLATE_ATTRIBUTE(TSharedPtr<FLinearColor>, Color)
 
        
        SLATE_ATTRIBUTE(TSharedPtr<FColorInfo>, ColorInfo)
        
        
        SLATE_EVENT(FOnLinearColorValueChanged, OnSelectColor)
 
        
        SLATE_ATTRIBUTE(TSharedPtr<SThemeColorBlocksBar>, Parent)
        
        
        SLATE_EVENT(FSimpleDelegate, ShowTrashCallback)
        
        
        SLATE_EVENT(FSimpleDelegate, HideTrashCallback)
        
        
        SLATE_ATTRIBUTE(bool, UseSRGB)
 
        
        SLATE_ATTRIBUTE(bool, UseAlpha)
 
        
        SLATE_ATTRIBUTE(bool, SupportsDrag)
 
    SLATE_END_ARGS()
 
    
    void Construct(const FArguments& InArgs );
    
    
private:
    void OnColorBlockRename();
    FText GetLabel() const;
    void SetLabel(const FText& NewColorLabel, ETextCommit::Type CommitInfo);
    virtual FReply OnMouseButtonDown( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent ) override;
    virtual FReply OnMouseButtonUp( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent ) override;
    virtual FReply OnDragDetected( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent ) override;
 
    FLinearColor GetColor() const;
 
    FText GetRedText() const;
    FText GetGreenText() const;
    FText GetBlueText() const;
    FText GetAlphaText() const;
    FText GetHueText() const;
    FText GetSaturationText() const;
    FText GetValueText() const;
 
    FText FormatToolTipText(const FText& ColorIdentifier, float Value) const;
    
    EColorBlockAlphaDisplayMode OnGetAlphaDisplayMode() const;
    bool OnReadShowBackgroundForAlpha() const;
    EVisibility OnGetAlphaVisibility() const;
 
    EVisibility OnGetLabelVisibility() const;
 
    TWeakPtr<FLinearColor> ColorPtr;
 
    TSharedPtr<FColorInfo> ColorInfo;
    
    TWeakPtr<SThemeColorBlocksBar> ParentPtr;
    
    FOnLinearColorValueChanged OnSelectColor;
 
    FSimpleDelegate ShowTrashCallback;
 
    FSimpleDelegate HideTrashCallback;
    
    TAttribute<bool> bUseSRGB;
 
    TAttribute<bool> bUseAlpha;
 
    TAttribute<bool> bSupportsDrag;
};
 
 
DECLARE_DELEGATE_OneParam(FOnCurrentThemeChanged, TSharedPtr<FColorTheme>)
 
 
class UE_DEPRECATED(5.6, "SColorThemeBar is deprecated. SColorThemesViewer now displays a standard menu with a list of available themes.") SColorThemeBar
    : public SCompoundWidget
{
public:
    SLATE_BEGIN_ARGS(SColorThemeBar)
        : _ColorTheme()
        , _OnCurrentThemeChanged()
        , _ShowTrashCallback()
        , _HideTrashCallback()
        , _UseSRGB()
        , _UseAlpha()
    { }
 
        SLATE_ATTRIBUTE(TSharedPtr<FColorTheme>, ColorTheme)
 
        
        SLATE_EVENT(FOnCurrentThemeChanged, OnCurrentThemeChanged)
 
        
        SLATE_EVENT(FSimpleDelegate, ShowTrashCallback)
        SLATE_EVENT(FSimpleDelegate, HideTrashCallback)
        
        
        SLATE_ATTRIBUTE(bool, UseSRGB)
 
        
        SLATE_ATTRIBUTE(bool, UseAlpha)
 
    SLATE_END_ARGS()
 
    void Construct(const FArguments& InArgs);
    
    virtual FReply OnMouseButtonDown( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent );
    
private:
 
    FText GetThemeName() const;
 
    TSharedPtr<STextBlock> ThemeNameText;
 
    TWeakPtr<FColorTheme> ColorTheme;
 
    FOnCurrentThemeChanged OnCurrentThemeChanged;
 
    FSimpleDelegate ShowTrashCallback;
 
    FSimpleDelegate HideTrashCallback;
    
    TAttribute<bool> bUseSRGB;
 
    TAttribute<bool> bUseAlpha;
};
 
 
class SColorThemesViewer : public SCompoundWidget
{
public:
 
    SLATE_BEGIN_ARGS(SColorThemesViewer)
    { }
 
        SLATE_ATTRIBUTE_DEPRECATED(bool, UseAlpha, 5.6, "UseAlpha is deprecated. Set the UseAlpha attribute of SThemeColorBlocksBar to control the opacity of theme colors.")
 
    SLATE_END_ARGS()
    
    void Construct(const FArguments& InArgs);
    
    TSharedPtr<FColorTheme> GetCurrentColorTheme() const;
 
    TSharedPtr<FColorTheme> GetRecents() const;
 
    UE_DEPRECATED(5.6, "SetUseAlpha is deprecated. Set the UseAlpha attribute of SThemeColorBlocksBar to control the opacity of theme colors.")
    void SetUseAlpha(const TAttribute<bool>& InUseAlpha);
 
    static void LoadColorThemesFromIni();
 
    static void SaveColorThemesToIni();
    
    DECLARE_EVENT( SColorThemesViewer, FCurrentThemeChangedEvent );
    FCurrentThemeChangedEvent& OnCurrentThemeChanged()
    {
        return CurrentThemeChangedEvent;
    }
 
    UE_DEPRECATED(5.6, "bSRGBEnabled is deprecated. Set the UseSRGB attribute of SThemeColorBlocksBar to control the sRGB display of theme colors.")
    static bool bSRGBEnabled;
 
    UE_DEPRECATED(5.6, "MenuToStandardNoReturn is deprecated. SColorThemesViewer completely manages its own ToolsMenu.")
    void MenuToStandardNoReturn();
 
    bool IsRecentsThemeActive() const;
 
private:
    void BuildMenu(FMenuBuilder& MenuBuilder);
 
    void StartRename();
 
    void StopRename();
 
    void RefreshMenuWidget();
 
    void NewColorTheme();
    void DuplicateColorTheme();
    void DeleteColorTheme();
 
    void CommitThemeName(const FText& InText, ETextCommit::Type InCommitType);
    void UpdateThemeNameFromTextBox();
    
    void SetCurrentColorTheme(TSharedPtr<FColorTheme> NewTheme);
 
    void OnMenuOpenChanged(bool bIsOpen);
 
    const FSlateBrush* GetComboButtonImage() const;
 
    static TSharedPtr<FColorTheme> GetDefaultColorTheme(bool bCreateNew = false);
    static TSharedPtr<FColorTheme> GetColorTheme(const FString& ThemeName);
    static TSharedPtr<FColorTheme> IsColorTheme(const FString& ThemeName);
    static FString MakeUniqueThemeName(const FString& ThemeName);
    static TSharedPtr<FColorTheme> NewColorTheme(const FString& ThemeName, const TArray< TSharedPtr<FColorInfo> >& ThemeColors = TArray< TSharedPtr<FColorInfo> >());
 
private:
    TSharedPtr<SMultiBoxWidget> MultiBoxWidget;
 
    TSharedPtr<SEditableTextBox> RenameTextBox;
 
    FCurrentThemeChangedEvent CurrentThemeChangedEvent;
 
    TAttribute<bool> bUseAlpha;
 
    static TArray<TSharedPtr<FColorTheme>> ColorThemes;
 
    static TSharedPtr<FColorTheme> Recents;
 
    static TWeakPtr<FColorTheme> CurrentlySelectedThemePtr;
};
 
 
class SThemeColorBlocksBar : public SPanel
{
public:
 
    DECLARE_DELEGATE_RetVal(FLinearColor, FOnGetActiveColor);
 
    SLATE_BEGIN_ARGS(SThemeColorBlocksBar)
        : _OnSelectColor()
        , _OnGetActiveColor()
        , _UseSRGB()
        , _UseAlpha()
        { }
 
        SLATE_ATTRIBUTE_DEPRECATED(TSharedPtr<FColorTheme>, ColorTheme, 5.6, "ColorTheme Attribute is deprecated. This widget owns a SColorThemesViewer which supplies the current color theme.")
 
        
        SLATE_EVENT(FOnLinearColorValueChanged, OnSelectColor)
 
        SLATE_EVENT(FOnGetActiveColor, OnGetActiveColor)
 
        UE_DEPRECATED(5.6, "ShowTrashCallback is deprecated. Visibility of the delete button is managed by this widget internally.")
        SLATE_EVENT(FSimpleDelegate, ShowTrashCallback)
 
        UE_DEPRECATED(5.6, "HideTrashCallback is deprecated. Visibility of the delete button is managed by this widget internally.")
        SLATE_EVENT(FSimpleDelegate, HideTrashCallback)
 
        SLATE_ARGUMENT_DEPRECATED(FText, EmptyText, 5.6, "EmptyText is deprecated. This widget no longer displays any text when no themes have been created.")
 
        SLATE_ATTRIBUTE(bool, UseSRGB)
 
        SLATE_ATTRIBUTE(bool, UseAlpha)
 
    SLATE_END_ARGS()
 
    SThemeColorBlocksBar();
 
    void Construct(const FArguments& InArgs);
 
    // Begin SWidget overrides
    virtual void OnArrangeChildren(const FGeometry& AllottedGeometry, FArrangedChildren& ArrangedChildren) const override;
    virtual FVector2D ComputeDesiredSize(float) const override;
    virtual FChildren* GetChildren() override;
    virtual void OnDragEnter(const FGeometry& MyGeometry, const FDragDropEvent& DragDropEvent) override;
    virtual void OnDragLeave(const FDragDropEvent& DragDropEvent) override;
    virtual FReply OnDragOver(const FGeometry& MyGeometry, const FDragDropEvent& DragDropEvent) override;
    virtual FReply OnDrop(const FGeometry& MyGeometry, const FDragDropEvent& DragDropEvent) override;
    // End SWidget overrides
 
    void AddNewColorBlock(FLinearColor Color, int32 InsertPosition, bool bAllowRepeat = false);
 
    void AddToRecents(FLinearColor Color);
 
    bool IsRecentsThemeActive() const;
 
    int32 RemoveColorBlock(TSharedPtr<FLinearColor> ColorToRemove);
 
    UE_DEPRECATED(5.6, "RemoveRefreshCallback is deprecated. Color theme changes are handled by this widget internally")
    void RemoveRefreshCallback();
 
    UE_DEPRECATED(5.6, "RemoveRefreshCallback is deprecated. Color theme changes are handled by this widget internally")
    void AddRefreshCallback();
 
    void Refresh();
 
    UE_DEPRECATED(5.6, "SetPlaceholderGrabOffset is deprecated. The Placeholder position is managed by this widget internally.")
    void SetPlaceholderGrabOffset(FVector2D GrabOffset);
 
    void ShowDeleteButton();
 
    void HideDeleteButton();
 
private:
    FReply OnAddButtonClicked();
 
    void OnThemeChanged();
 
    EVisibility GetAddButtonVisibility() const;
 
    EVisibility GetDeleteButtonVisibility() const;
 
    TSlotlessChildren<SWidget> Children;
 
    TArray<TSharedPtr<SThemeColorBlock>> ColorBlocks;
 
    TSharedPtr<FColorTheme> ColorTheme;
 
    FOnLinearColorValueChanged OnSelectColor;
 
    FOnGetActiveColor OnGetActiveColor;
 
    FSimpleDelegate RefreshCallback;
 
    FDelegateHandle RefreshCallbackHandle;
 
    TAttribute<bool> bUseSRGB;
 
    TAttribute<bool> bUseAlpha;
 
    bool bShowDeleteButton = false;
 
    TSharedPtr<SBorder> DragShadow;
 
    TSharedPtr<SOverlay> AddDeleteOverlay;
 
    TSharedPtr<SColorThemesViewer> ThemesViewer;
 
    TOptional<int32> PlaceholderIndex;
};
 
 
class FColorDragDrop : public FDragDropOperation
{
public:
 
    DRAG_DROP_OPERATOR_TYPE(FColorDragDrop, FDragDropOperation)
 
    FColorDragDrop(FLinearColor InColor, bool bInUseSRGB, bool bInUseAlpha, FSimpleDelegate InTrashShowCallback, FSimpleDelegate InTrashHideCallback);
 
    // Begin FDragDropOperation overrides
    virtual void OnDrop( bool bDropWasHandled, const FPointerEvent& MouseEvent ) override;
    virtual void OnDragged( const class FDragDropEvent& DragDropEvent ) override;
    virtual TSharedPtr<SWidget> GetDefaultDecorator() const override;
    // End FDragDropOperation overrides
 
    void MarkForAdd();
 
    void MarkForDelete();
 
    static TSharedRef<FColorDragDrop> New(FLinearColor InColor, bool bSRGB, bool bUseAlpha,
        FSimpleDelegate TrashShowCallback = FSimpleDelegate(), FSimpleDelegate TrashHideCallback = FSimpleDelegate(),
        TSharedPtr<SThemeColorBlocksBar> Origin = TSharedPtr<SThemeColorBlocksBar>(), int32 OriginPosition = 0);
 
    FLinearColor Color;
 
    bool bUseSRGB;
 
    bool bUseAlpha;
 
    UE_DEPRECATED(5.6, "OriginBar is deprecated. This operation no longer needs direct access to the SThemeColorBlocksBar widget.")
    TWeakPtr<SThemeColorBlocksBar> OriginBar;
 
    UE_DEPRECATED(5.6, "OriginBarPosition is deprecated. This operation no longer needs to know its position in the SThemeColorBlocksBar widget.")
    int32 OriginBarPosition;
 
    FSimpleDelegate ShowTrash;
 
    FSimpleDelegate HideTrash;
 
    UE_DEPRECATED(5.6, "bSetForDeletion is deprecated. This operation no longer deletes any color blocks from the SThemeColorBlocksBar widget.")
    bool bSetForDeletion;
 
    UE_DEPRECATED(5.6, "BlockSize is deprecated. This operation now uses the size of the cursor decorator window internally.")
    FVector2D BlockSize;
};