SlateIcon.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
 
struct FSlateBrush;
 
struct FSlateIcon
{
    SLATECORE_API FSlateIcon();
 
    SLATECORE_API FSlateIcon(const FName InStyleSetName, const FName InStyleName, const FName InSmallStyleName = NAME_None, const FName InStatusOverlayStyleName = NAME_None);
 
public:
    
    friend bool operator==(const FSlateIcon& A, const FSlateIcon& B)
    {
        return A.IsSet() == B.IsSet()
            && A.StyleSetName == B.StyleSetName
            && A.StyleName == B.StyleName
            && A.SmallStyleName == B.SmallStyleName
            && A.StatusOverlayStyleName == B.StatusOverlayStyleName;
    }
 
    friend bool operator!=(const FSlateIcon& A, const FSlateIcon& B)
    {
        return !(A == B);
    }
 
public:
 
    SLATECORE_API const FSlateBrush* GetIcon( ) const;
 
    SLATECORE_API const FSlateBrush* GetOptionalIcon( ) const;
 
    SLATECORE_API const FSlateBrush* GetSmallIcon( ) const;
 
    SLATECORE_API const FSlateBrush* GetOptionalSmallIcon( ) const;
 
    SLATECORE_API const FSlateBrush* GetOverlayIcon() const;
 
    const FName& GetSmallStyleName() const
    {
        return SmallStyleName;
    }
 
    const FName& GetStyleName() const
    {
        return StyleName;
    }
 
    SLATECORE_API const class ISlateStyle* GetStyleSet() const;
 
    const FName& GetStyleSetName() const
    {
        return StyleSetName;
    }
 
    const bool IsSet() const
    {
        return StyleSetName != NAME_None && StyleName != NAME_None;
    }
 
private:
 
    // The name of the style set the icon can be found in.
    FName StyleSetName;
 
    // The name of the style for the icon.
    FName StyleName;
 
    // The name of the style for the small icon.
    FName SmallStyleName;
 
    // Name of the style for the status overlay icon
    FName StatusOverlayStyleName;
};