FSlateStyleSet

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

Windows
MacOS
Linux

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 FEditorStyle.

Variables

Name Description

Protected variable

TMap< FName, FS...

 

BrushResources

Protected variable

TMap< FName, FL...

 

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, TW...

 

DynamicBrushes

A list of dynamic brushes

Protected variable

TMap< FName, fl...

 

FloatValues

Float property storage.

Protected variable

TMap< FName, FS...

 

FontInfoResources

FSlateFontInfo property storage.

Protected variable

TMap< FName, FM...

 

MarginValues

FMargin property storage.

Protected variable

TSet< FName >

 

MissingResources

A set of resources that were requested, but not found.

Protected variable

TMap< FName, FS...

 

SlateColorValues

FSlateColor property storage.

Protected variable

TMap< FName, FS...

 

Sounds

SlateSound property storage

Protected variable

FName

 

StyleSetName

The name used to identity this style set

Protected variable

TMap< FName, FV...

 

Vector2DValues

FVector2D property storage.

Protected variable

TMap< FName, TS...

 

WidgetStyleValues

Constructors

Name Description

Public function

FSlateStyleSet

(
    const FName& InStyleSetName
)

Construct a style chunk.

Destructors

Name Description

Public function Virtual

~FSlateStyleSet()

Destructor.

Functions

Name Description

Protected function

bool

 

IsBrushFromFile

(
    const FString& FilePath,
    const FSlateBrush* Brush
)

Protected function Virtual

void

 

LogUnusedBrushResources()

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

void

 

Set

(
    const FName PropertyName,
    FSlateColorBrush* InBrush
)

Public function

void

 

Set

(
    const FName PropertyName,
    FSlateDynamicImageBrush* InBru...
)

Public function

void

 

Set

(
    const FName PropertyName,
    FSlateImageBrush* InBrush
)

Public function

void

 

Set

(
    const FName PropertyName,
    FSlateBorderBrush* InBrush
)

Public function

void

 

Set

(
    const FName PropertyName,
    FSlateBoxBrush* InBrush
)

Public function

void

 

Set

(
    const FName PropertyName,
    FSlateNoResource* InBrush
)

Public function

void

 

Set

(
    const FName PropertyName,
    FSlateBrush* InBrush
)

Add a FSlateBrush property to this style's collection

Public function

void

 

Set

(
    const FName PropertyName,
    const FMargin& InMargin
)

Add a FMargin property to this style's collection.

Public function

void

 

Set

(
    const FName PropertyName,
    const FLinearColor& InColor
)

Set FLinearColor property.

Public function

void

 

Set

(
    const FName PropertyName,
    const FColor& InColor
)

Public function

void

 

Set

(
    FName PropertyName,
    const FSlateSound& InSound
)

Set FSlateSound properties

Public function

void

 

Set

(
    const FName PropertyName,
    const FVector2D InVector
)

Add a FVector2D property to this style's collection.

Public function

void

 

Set

(
    const FName PropertyName,
    const float InFloat
)

Set float properties

Public function

void

 

Set

(
    const FName PropertyName,
    const DefinitionType& InStyleDefin...
)

Public function

void

 

Set

(
    const FName PropertyName,
    const FSlateColor& InColor
)

Add a FSlateLinearColor property to this style's collection.

Public function

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& InCoreContentRootDi...
)

Overridden from ISlateStyle

Name Description

Public function Virtual Const

const FSlate...

 

GetBrush

(
    const FName PropertyName,
    const ANSICHAR* Specifier
)

Public function Virtual Const

const FLinea...

 

GetColor

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

Public function Virtual Const

FSlateBrush ...

 

GetDefaultBrush()

Get default FSlateBrush.

Public function Virtual

const TShare...

 

GetDynamicImageBrush

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

Public function Virtual

const TShare...

 

GetDynamicImageBrush

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

Public function Virtual

const TShare...

 

GetDynamicImageBrush

(
    const FName BrushTemplate,
    const FName TextureName,
    const ANSICHAR* Specifier
)

Public function Virtual Const

TArray< FNam...

 

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
)

Public function Virtual Const

FSlateFontIn...

 

GetFontStyle

(
    const FName PropertyName,
    const ANSICHAR* Specifier
)

Public function Virtual Const

const FMargi...

 

GetMargin

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

Public function Virtual Const

const FSlate...

 

GetOptionalBrush

(
    const FName PropertyName,
    const ANSICHAR* Specifier,
    const FSlateBrush*const Defaul...
)

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* >&...
)

Populate an array of FSlateBrush with resources consumed by this style.

Public function Virtual Const

const FSlate...

 

GetSlateColor

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

Public function Virtual Const

const FSlate...

 

GetSound

(
    const FName PropertyName,
    const ANSICHAR* Specifier
)

Look up a sound property specified by PropertyName and optional Specifier.

Public function Virtual Const

const FName ...

 

GetStyleSetName()

Public function Virtual Const

FVector2D

 

GetVector

(
    const FName PropertyName,
    const ANSICHAR* Specifier,
    FVector2D DefaultValue
)

Protected function Virtual Const

const FSlate...

 

GetWidgetStyleInternal

(
    const FName DesiredTypeName,
    const FName StyleName
)

Protected function Virtual Const

void

 

Log

(
    ISlateStyle::EStyleMessageSeverity ...,
    const FText& Message
)
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss