ISlateStyle.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "CoreMinimal.h"
#include "Styling/SlateColor.h"
#include "Fonts/SlateFontInfo.h"
#include "Styling/StyleDefaults.h"
 
class Error;
class UTexture2D;
struct FSlateDynamicImageBrush;
struct FSlateWidgetStyle;
 
class ISlateStyle
{
public:
    ISlateStyle()
    {}
 
    virtual ~ISlateStyle()
    {}
 
    virtual const FName& GetStyleSetName() const = 0;
 
    virtual void GetResources( TArray< const FSlateBrush* >& OutResources ) const = 0;
    virtual FString GetContentRootDir() const = 0;
 
    virtual TArray<FName> GetEntriesUsingBrush(const FName BrushName) const = 0;
 
    template< typename WidgetStyleType >            
    const WidgetStyleType& GetWidgetStyle( FName PropertyName, const ANSICHAR* Specifier, const WidgetStyleType* DefaultValue, bool bWarnIfNotFound ) const 
    {
        const FSlateWidgetStyle* ExistingStyle = GetWidgetStyleInternal(WidgetStyleType::TypeName, Join( PropertyName, Specifier ), DefaultValue, bWarnIfNotFound);
 
        if ( ExistingStyle == nullptr )
        {
            return WidgetStyleType::GetDefault();
        }
 
        return *static_cast< const WidgetStyleType* >( ExistingStyle );
    }
 
    template< typename WidgetStyleType >
    const WidgetStyleType& GetWidgetStyle( FName PropertyName, const ANSICHAR* Specifier = nullptr, const WidgetStyleType* DefaultValue = nullptr ) const
    {
        return GetWidgetStyle< WidgetStyleType >( PropertyName, Specifier, DefaultValue, DefaultValue == nullptr );
    }
 
    template< typename WidgetStyleType >            
    bool HasWidgetStyle( FName PropertyName, const ANSICHAR* Specifier = nullptr ) const
    {
        const bool bWarnIfNotFound = false;
        return GetWidgetStyleInternal( WidgetStyleType::TypeName, Join( PropertyName, Specifier ), nullptr, bWarnIfNotFound) != nullptr;
    }
    
    const FSlateWidgetStyle* GetWidgetStyle( const FName& WidgetStyleTypeName, FName PropertyName, const ANSICHAR* Specifier = nullptr, const FSlateWidgetStyle* DefaultValue = nullptr, bool bWarnIfNotFound = true ) const 
    {
        const FSlateWidgetStyle* ExistingStyle = GetWidgetStyleInternal(WidgetStyleTypeName, Join( PropertyName, Specifier ), DefaultValue, bWarnIfNotFound);
 
        if ( ExistingStyle == nullptr )
        {
            return DefaultValue;
        }
 
        return ExistingStyle ? ExistingStyle : DefaultValue;
    }
 
    virtual float GetFloat(const FName PropertyName, const ANSICHAR* Specifier = nullptr, float DefaultValue = FStyleDefaults::GetFloat(), const ISlateStyle* RequestingStyle = nullptr) const = 0;
 
    virtual UE::Slate::FDeprecateVector2DResult GetVector(const FName PropertyName, const ANSICHAR* Specifier = nullptr, UE::Slate::FDeprecateVector2DParameter DefaultValue = FStyleDefaults::GetVector2D(), const ISlateStyle* RequestingStyle = nullptr) const = 0;
 
    virtual const FLinearColor& GetColor(const FName PropertyName, const ANSICHAR* Specifier = nullptr, const FLinearColor& DefaultValue = FStyleDefaults::GetColor(), const ISlateStyle* RequestingStyle = nullptr) const = 0;
 
    virtual const FSlateColor GetSlateColor(const FName PropertyName, const ANSICHAR* Specifier = nullptr, const FSlateColor& DefaultValue = FStyleDefaults::GetSlateColor(), const ISlateStyle* RequestingStyle = nullptr) const = 0;
 
    virtual const FMargin& GetMargin(const FName PropertyName, const ANSICHAR* Specifier = nullptr, const FMargin& DefaultValue = FStyleDefaults::GetMargin(), const ISlateStyle* RequestingStyle = nullptr) const = 0;
 
    virtual const FSlateBrush* GetBrush( const FName PropertyName, const ANSICHAR* Specifier = nullptr, const ISlateStyle* RequestingStyle = nullptr) const = 0;
 
    virtual const FSlateBrush* GetOptionalBrush( const FName PropertyName, const ANSICHAR* Specifier = nullptr, const FSlateBrush* const DefaultBrush = FStyleDefaults::GetNoBrush()) const = 0;
 
    virtual const TSharedPtr< FSlateDynamicImageBrush > GetDynamicImageBrush( const FName BrushTemplate, const FName TextureName, const ANSICHAR* Specifier = nullptr, const ISlateStyle* RequestingStyle = nullptr ) const = 0;
 
    virtual const TSharedPtr< FSlateDynamicImageBrush > GetDynamicImageBrush( const FName BrushTemplate, const ANSICHAR* Specifier, UTexture2D* TextureResource, const FName TextureName, const ISlateStyle* RequestingStyle = nullptr ) const = 0;
 
    virtual const TSharedPtr< FSlateDynamicImageBrush > GetDynamicImageBrush( const FName BrushTemplate, UTexture2D* TextureResource, const FName TextureName, const ISlateStyle* RequestingStyle = nullptr ) const = 0;
 
    virtual FSlateBrush* GetDefaultBrush() const = 0;
 
    virtual const FSlateSound& GetSound( const FName PropertyName, const ANSICHAR* Specifier = nullptr , const ISlateStyle* RequestingStyle = nullptr) const = 0;
 
    virtual FSlateFontInfo GetFontStyle( const FName PropertyName, const ANSICHAR* Specifier = nullptr ) const = 0;
 
    static FName Join( FName A, const ANSICHAR* B )
    {
        if( B == nullptr )
        {
            return A;
        }
        else
        {
            return FName( *( A.ToString() + B ) );
        }
    }
 
    virtual TSet<FName> GetStyleKeys() const = 0;
 
    virtual const TSet<FName>& GetWidgetStyleNames() const
    {
        static TSet<FName> Dummy;
        return Dummy;
    }
protected:
 
    enum class EStyleMessageSeverity : uint8
    {
        CriticalError UE_DEPRECATED(5.1, "CriticalError was removed because it can't trigger an assert at the callsite. Use 'checkf' instead.") = 0,
        Error = 1,
        PerformanceWarning = 2,
        Warning = 3,
        Info = 4,   // Should be last
    };
 
 
protected:
 
    friend class FSlateStyleSet;
    friend class ISlateStyle;
 
    virtual const FSlateWidgetStyle* GetWidgetStyleInternal( const FName DesiredTypeName, const FName StyleName, const FSlateWidgetStyle* DefaultStyle, bool bWarnIfNotFound) const = 0;
 
    virtual void Log( EStyleMessageSeverity Severity, const FText& Message ) const = 0;
    
    virtual void LogMissingResource(EStyleMessageSeverity Severity, const FText& Message, const FName& MissingResource) const = 0;
 
    virtual const TSharedPtr< FSlateDynamicImageBrush > MakeDynamicImageBrush( const FName BrushTemplate, UTexture2D* TextureResource, const FName TextureName ) const = 0;
};