1. Epic GamesDeveloper
  3. FSlateStyleSet

FSlateStyleSet

A slate style chunk that contains a collection of named properties that guide the appearance of Slate.

API > API/Runtime > API/Runtime/SlateCore > API/Runtime/SlateCore/Styling

Inheritance Hierarchy

References

   
Module SlateCore
Header /Engine/Source/Runtime/SlateCore/Public/Styling/SlateStyle.h
Include #include "Styling/SlateStyle.h"

Syntax

class FSlateStyleSet : public ISlateStyle

Remarks

A slate style chunk that contains a collection of named properties that guide the appearance of Slate. At the moment, basically FAppStyle.

Variables

  Type Name Description
Protected variable TMap< FName, FSlateBrush * > BrushResources  
Protected variable TMap< FName, FLinearColor > ColorValues Color property storage.
Protected variable FString ContentRootDir This dir is Engine/Editor/Slate folder
Protected variable FString CoreContentRootDir This dir is Engine/Slate folder to share the items
Protected variable FSlateBrush * DefaultBrush FSlateBrush property storage
Protected variable TMap< FName, TWeakPtr< FSlateDynamicImageBrush > > DynamicBrushes A list of dynamic brushes
Protected variable TMap< FName, float > FloatValues Float property storage.
Protected variable TMap< FName, FSlateFontInfo > FontInfoResources FSlateFontInfo property storage.
Protected variable TMap< FName, FMargin > MarginValues FMargin property storage.
Protected variable TSet< FName > MissingResources A set of resources that were requested, but not found.
Protected variable FName ParentStyleName  
Protected variable TMap< FName, FSlateColor > SlateColorValues FSlateColor property storage.
Protected variable TMap< FName, FSlateSound > Sounds SlateSound property storage
Protected variable FName StyleSetName The name used to identity this style set
Protected variable TMap< FName, FVector2f > Vector2DValues FVector2D property storage.
Protected variable TMap< FName, TSharedRef< struct FSlateWidgetStyle > > WidgetStyleValues  

Constructors

  Type Name Description
Public function  

FSlateStyleSet ( const FName& InStyleSetName
)

 Construct a style chunk.
Public function    
Public function    

Destructors

  Type Name Description
Public function Virtual   Destructor.

Functions

  Type Name Description
Protected function Const const ISlateStyle *  
Protected function bool

IsBrushFromFile ( const FString& FilePath,
const FSlateBrush* Brush
)

  
Protected function Virtual void  
Public function Virtual FString

RootToContentDir ( const FString& RelativePath,
const TCHAR* Extension
)

  
Public function Virtual FString

RootToContentDir ( const WIDECHAR* RelativePath,
const TCHAR* Extension
)

  
Public function Virtual FString

RootToContentDir ( const ANSICHAR* RelativePath,
const TCHAR* Extension
)

  
Public function Virtual FString

RootToContentDir ( const FString& RelativePath
)

  
Public function Virtual FString

RootToContentDir ( const WIDECHAR* RelativePath
)

  
Public function Virtual FString

RootToContentDir ( const ANSICHAR* RelativePath
)

  
Public function Virtual FString

RootToCoreContentDir ( const ANSICHAR* RelativePath
)

  
Public function Virtual FString

RootToCoreContentDir ( const WIDECHAR* RelativePath
)

  
Public function Virtual FString

RootToCoreContentDir ( const FString& RelativePath
)

  
Public function Virtual FString

RootToCoreContentDir ( const ANSICHAR* RelativePath,
const TCHAR* Extension
)

  
Public function Virtual FString

RootToCoreContentDir ( const WIDECHAR* RelativePath,
const TCHAR* Extension
)

  
Public function Virtual FString

RootToCoreContentDir ( const FString& RelativePath,
const TCHAR* Extension
)

  
Public function FORCENOINLINE void

Set ( FName PropertyName,
const FSlateSound& InSound
)

 Set FSlateSound properties
Public function FORCENOINLINE void

Set ( const FName PropertyName,
BrushType* InBrush
)

 Add a FSlateBrush property to this style's collection
Public function FORCENOINLINE void

Set ( const FName PropertyName,
const FMargin& InMargin
)

 Add a FMargin property to this style's collection.
Public function FORCENOINLINE void

Set ( const FName PropertyName,
const FSlateColor& InColor
)

 Add a FSlateLinearColor property to this style's collection.
Public function FORCENOINLINE void

Set ( const FName PropertyName,
const FColor& InColor
)

  
Public function FORCENOINLINE void

Set ( const FName PropertyName,
const FLinearColor& InColor
)

 Set FLinearColor property.
Public function FORCENOINLINE void

Set ( const FName PropertyName,
const FVector2f& InVector
)

  
Public function FORCENOINLINE void

Set ( const FName PropertyName,
const DefinitionType& InStyleDefintion
)

  
Public function FORCENOINLINE void

Set ( const FName PropertyName,
const FVector2D& InVector
)

 Add a FVector2D property to this style's collection.
Public function FORCENOINLINE void

Set ( const FName PropertyName,
const float InFloat
)

 Set float properties
Public function FORCENOINLINE void

Set ( const FName PropertyName,
const UE::Slate::FDeprecateVector2DResult& InVector
)

  
Public function FORCENOINLINE void

Set ( FName PropertyName,
const FSlateFontInfo& InFontInfo
)

 Set FSlateFontInfo properties
Public function Virtual void

SetContentRoot ( const FString& InContentRootDir
)

  
Public function Virtual void

SetCoreContentRoot ( const FString& InCoreContentRootDir
)

  
Public function void

SetParentStyleName ( const FName& InParentStyleName
)

 Name a Parent Style to fallback on if the requested styles are specified in this style

Overridden from ISlateStyle

  Type Name Description
Public function Virtual Const const FSlateBrush *

GetBrush ( const FName PropertyName,
const ANSICHAR* Specifier,
const ISlateStyle* RequestingStyle
)

  
Public function Virtual Const const FLinearColor &

GetColor ( const FName PropertyName,
const ANSICHAR* Specifier,
const FLinearColor& DefaultValue,
const ISlateStyle* RequestingStyle
)

  
Public function Virtual Const FString  
Public function Virtual Const FSlateBrush * Get default FSlateBrush.
Public function Virtual Const const TSharedPtr< FSlateDynamicImageBrush >

GetDynamicImageBrush ( const FName BrushTemplate,
const ANSICHAR* Specifier,
UTexture2D* TextureResource,
const FName TextureName,
const ISlateStyle* RequestingStyle
)

  
Public function Virtual Const const TSharedPtr< FSlateDynamicImageBrush >

GetDynamicImageBrush ( const FName BrushTemplate,
UTexture2D* TextureResource,
const FName TextureName,
const ISlateStyle* RequestingStyle
)

  
Public function Virtual Const const TSharedPtr< FSlateDynamicImageBrush >

GetDynamicImageBrush ( const FName BrushTemplate,
const FName TextureName,
const ANSICHAR* Specifier,
const ISlateStyle* RequestingStyle
)

  
Public function Virtual Const TArray< FName >

GetEntriesUsingBrush ( const FName BrushName
)

 Gets the names of every style entry using a brush in this style Note: this function is expensive and is not designed to be used in performance critical situations
Public function Virtual Const float

GetFloat ( const FName PropertyName,
const ANSICHAR* Specifier,
float DefaultValue,
const ISlateStyle* RequestingStyle
)

  
Public function Virtual Const FSlateFontInfo

GetFontStyle ( const FName PropertyName,
const ANSICHAR* Specifier
)

  
Public function Virtual Const const FMargin &

GetMargin ( const FName PropertyName,
const ANSICHAR* Specifier,
const FMargin& DefaultValue,
const ISlateStyle* RequestingStyle
)

  
Public function Virtual Const const FSlateBrush *

GetOptionalBrush ( const FName PropertyName,
const ANSICHAR* Specifier,
const FSlateBrush*const DefaultBrush
)

 Just like GetBrush, but returns DefaultBrush instead of the "missing brush" image when the resource is not found.
Public function Virtual Const void

GetResources ( TArray< const FSlateBrush* >& OutResources
)

 Populate an array of FSlateBrush with resources consumed by this style.
Public function Virtual Const const FSlateColor

GetSlateColor ( const FName PropertyName,
const ANSICHAR* Specifier,
const FSlateColor& DefaultValue,
const ISlateStyle* RequestingStyle
)

  
Public function Virtual Const const FSlateSound &

GetSound ( const FName PropertyName,
const ANSICHAR* Specifier,
const ISlateStyle* RequestingStyle
)

 Look up a sound property specified by PropertyName and optional Specifier.
Protected function Virtual Const TSet< FName >  
Public function Virtual Const const FName &  
Public function Virtual Const FVector2D

GetVector ( const FName PropertyName,
const ANSICHAR* Specifier,
FVector2D DefaultValue,
const ISlateStyle* RequestingStyle
)

  
Protected function Virtual Const const FSlateWidgetStyle *

GetWidgetStyleInternal ( const FName DesiredTypeName,
const FName StyleName,
const FSlateWidgetStyle* DefaultStyle,
bool bWarnIfNotFound
)

  
Protected function Virtual Const void

Log ( ISlateStyle::EStyleMessageSeverity Severity,
const FText& Message
)

  
Protected function Virtual Const void

LogMissingResource ( EStyleMessageSeverity Severity,
const FText& Message,
const FName& MissingResource
)

  
Protected function Virtual Const const TSharedPtr< FSlateDynamicImageBrush >

MakeDynamicImageBrush ( const FName BrushTemplate,
UTexture2D* TextureResource,
const FName TextureName
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page