StyleColors.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "HAL/Platform.h"
#include "Internationalization/Text.h"
#include "Math/Color.h"
#include "Misc/Guid.h"
#include "SlateColor.h"
#include "UObject/Object.h"
#include "UObject/ObjectMacros.h"
#include "UObject/UObjectGlobals.h"
 
#include "StyleColors.generated.h"
 
struct FSlateColor;
 
#define ALLOW_THEMES WITH_EDITOR || IS_PROGRAM
 
// HEX Colors from sRGB Color space
#define COLOR( HexValue ) FLinearColor::FromSRGBColor(FColor::FromHex(HexValue))
 
UENUM()
enum class EStyleColor : uint8
{
    Black,
    Background,
    Title,
    WindowBorder,
    Foldout,
    Input,
    InputOutline,
    Recessed,
    Panel,
    Header,
    Dropdown,
    DropdownOutline,
    Hover,
    Hover2,
    White,
    White25,
    Highlight,
    Primary,
    PrimaryHover,
    PrimaryPress,
    Secondary, 
    Foreground,
    ForegroundHover,
    ForegroundInverted,
    ForegroundHeader,
    Select,
    SelectInactive,
    SelectParent,
    SelectHover,
    Notifications,
    AccentBlue,
    AccentPurple,
    AccentPink,
    AccentRed,
    AccentOrange,
    AccentYellow,
    AccentGreen,
    AccentBrown,
    AccentBlack,
    AccentGray,
    AccentWhite,
    AccentFolder,
    Warning,
    Error,
    Success,
 
    User1,
    User2,
    User3,
    User4,
    User5,
    User6,
    User7,
    User8,
    User9,
    User10,
    User11,
    User12,
    User13,
    User14,
    User15,
    User16,
 
    MAX
};
 
USTRUCT()
struct FStyleColorList
{
    GENERATED_BODY()
 
    UPROPERTY(EditAnywhere, Config, Category = Colors)
    FLinearColor StyleColors[(int32)EStyleColor::MAX] = {FLinearColor::Transparent};
 
    FText DisplayNames[(int32)EStyleColor::MAX];
};
 
USTRUCT()
struct FStyleTheme
{
    GENERATED_BODY()
 
    
    FGuid Id;
    FText DisplayName;
    FString Filename;
    TArray<FLinearColor> LoadedDefaultColors;
 
    bool operator==(const FStyleTheme& Other) const
    {
        return Id == Other.Id;
    }
 
    bool operator==(const FGuid& OtherId) const
    {
        return Id == OtherId;
    }
};
 
UCLASS(Config=EditorSettings, MinimalAPI)
class USlateThemeManager : public UObject 
{
    GENERATED_BODY()
public:
    static USlateThemeManager& Get()
    {
        return *GetMutableDefault<USlateThemeManager>();
    }
 
    const FLinearColor& GetColor(EStyleColor Color) const
    {
        return ActiveColors.StyleColors[static_cast<int32>(Color)];
    }
 
    const FGuid& GetCurrentThemeID() const
    {
        return CurrentThemeId; 
    }
 
    SLATECORE_API USlateThemeManager();
 
    SLATECORE_API void InitalizeDefaults();
 
    void SetDefaultColor(EStyleColor InColorId, FLinearColor InColor)
    {
#if ALLOW_THEMES
        DefaultColors[static_cast<int32>(InColorId)] = InColor;
#else
        ActiveColors.StyleColors[static_cast<int32>(InColorId)] = InColor;
#endif
    }
 
#if ALLOW_THEMES
 
    void SetColorDisplayName(EStyleColor InColorId, FText DisplayName)
    {
        ActiveColors.DisplayNames[static_cast<int32>(InColorId)] = DisplayName;
    }
 
    FText GetColorDisplayName(EStyleColor InColorId) const
    {
        return ActiveColors.DisplayNames[static_cast<int32>(InColorId)];
    }
 
    SLATECORE_API void LoadThemes();
 
    SLATECORE_API void SaveCurrentThemeAs(const FString& Filename);
 
    SLATECORE_API bool ExportCurrentThemeTo(const FString& Filename);
 
    SLATECORE_API void ApplyTheme(FGuid ThemeId);
 
    SLATECORE_API void ApplyDefaultTheme();
 
    SLATECORE_API bool IsEngineTheme() const;
 
    SLATECORE_API bool IsProjectTheme() const;
 
    SLATECORE_API void RemoveTheme(FGuid ThemeId);
 
    SLATECORE_API FGuid DuplicateActiveTheme();
 
    SLATECORE_API void SetCurrentThemeDisplayName(FText NewDisplayName);
 
    const FStyleTheme& GetCurrentTheme() const { return *Themes.FindByKey(CurrentThemeId); }
 
    const TArray<FStyleTheme>& GetThemes() const { return Themes; }
 
    SLATECORE_API void ResetActiveColorToDefault(EStyleColor Color);
 
    SLATECORE_API void ValidateActiveTheme();
 
    SLATECORE_API FString GetEngineThemeDir() const;
 
    SLATECORE_API FString GetProjectThemeDir() const;
 
    SLATECORE_API FString GetUserThemeDir() const;
        
    SLATECORE_API bool DoesThemeExist(const FGuid& ThemeID) const;
 
    DECLARE_EVENT_OneParam(USlateThemeManager, FThemeChangedEvent, FGuid);
    FThemeChangedEvent& OnThemeChanged() { return ThemeChangedEvent; }
 
private:
 
    FStyleTheme& GetMutableCurrentTheme() { return *Themes.FindByKey(CurrentThemeId); }
    SLATECORE_API void LoadThemesFromDirectory(const FString& Directory);
    SLATECORE_API bool ReadTheme(const FString& ThemeData, FStyleTheme& OutTheme);
    bool WriteCurrentTheme(FString& OutString);
    SLATECORE_API void EnsureValidCurrentTheme();
    SLATECORE_API void LoadThemeColors(FStyleTheme& Theme);
 
private:
    FStyleTheme DefaultDarkTheme;
    TArray<FStyleTheme> Themes;
    FLinearColor DefaultColors[(int32)EStyleColor::MAX];
 
    FThemeChangedEvent ThemeChangedEvent;
 
#endif // ALLOW_THEMES
 
    FLinearColor GetDefaultColor(EStyleColor InColorId)
    {
#if ALLOW_THEMES
        return DefaultColors[static_cast<int32>(InColorId)];
#else
        return ActiveColors.StyleColors[static_cast<int32>(InColorId)];
#endif
    }
 
    UPROPERTY(EditAnywhere, Config, Category=Colors)
    FGuid CurrentThemeId;
 
    UPROPERTY(EditAnywhere, transient, Category = Colors)
    FStyleColorList ActiveColors;
};
 
struct FStyleColors
{
    static SLATECORE_API const FSlateColor Transparent;
    static SLATECORE_API const FSlateColor Black;
    static SLATECORE_API const FSlateColor Title;
    static SLATECORE_API const FSlateColor WindowBorder;
    static SLATECORE_API const FSlateColor Foldout;
    static SLATECORE_API const FSlateColor Input;
    static SLATECORE_API const FSlateColor InputOutline;
    static SLATECORE_API const FSlateColor Recessed;
    static SLATECORE_API const FSlateColor Background;
    static SLATECORE_API const FSlateColor Panel;
    static SLATECORE_API const FSlateColor Header;
    static SLATECORE_API const FSlateColor Dropdown;
    static SLATECORE_API const FSlateColor DropdownOutline;
    static SLATECORE_API const FSlateColor Hover;
    static SLATECORE_API const FSlateColor Hover2;
    static SLATECORE_API const FSlateColor White;
    static SLATECORE_API const FSlateColor White25;
    static SLATECORE_API const FSlateColor Highlight;
 
    static SLATECORE_API const FSlateColor Primary;
    static SLATECORE_API const FSlateColor PrimaryHover;
    static SLATECORE_API const FSlateColor PrimaryPress;
    static SLATECORE_API const FSlateColor Secondary;
 
    static SLATECORE_API const FSlateColor Foreground;
    static SLATECORE_API const FSlateColor ForegroundHover;
    static SLATECORE_API const FSlateColor ForegroundInverted;
    static SLATECORE_API const FSlateColor ForegroundHeader;
 
    static SLATECORE_API const FSlateColor Select;
    static SLATECORE_API const FSlateColor SelectInactive;
    static SLATECORE_API const FSlateColor SelectParent;
    static SLATECORE_API const FSlateColor SelectHover;
 
    static SLATECORE_API const FSlateColor Notifications;
 
    static SLATECORE_API const FSlateColor AccentBlue;
    static SLATECORE_API const FSlateColor AccentPurple;
    static SLATECORE_API const FSlateColor AccentPink;
    static SLATECORE_API const FSlateColor AccentRed;
    static SLATECORE_API const FSlateColor AccentOrange;
    static SLATECORE_API const FSlateColor AccentYellow;
    static SLATECORE_API const FSlateColor AccentGreen;
    static SLATECORE_API const FSlateColor AccentBrown;
    static SLATECORE_API const FSlateColor AccentBlack;
    static SLATECORE_API const FSlateColor AccentGray;
    static SLATECORE_API const FSlateColor AccentWhite;
    static SLATECORE_API const FSlateColor AccentFolder;
 
    static SLATECORE_API const FSlateColor Warning;
    static SLATECORE_API const FSlateColor Error;
    static SLATECORE_API const FSlateColor Success;
};