Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > SlateCore > Styling > FTextBlockStyle

Light Theme

Dark Theme

FTextBlockStyle

Represents the appearance of an [STextBlock](API\Runtime\Slate\Widgets\Text\STextBlock)

Windows

MacOS

Linux

Inheritance Hierarchy

FSlateWidgetStyle

FTextBlockStyle

References

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

Syntax

struct FTextBlockStyle : public FSlateWidgetStyle

Remarks

Represents the appearance of an STextBlock

Variables

	Name	Description
FSlateColor	ColorAndOpacity	The color and opacity of this text
FSlateFontInfo	Font	Font family and size to be used when displaying this text.
FLinearColor	HighlightColor	The color of highlighted text
FSlateBrush	HighlightShape	The shape of highlighted text
FSlateColor	SelectedBackgroundColor	The background color of selected text
FLinearColor	ShadowColorAndOpacity	The color and opacity of the shadow
FVector2D	ShadowOffset	How much should the shadow be offset? An offset of 0 implies no shadow.
FSlateBrush	StrikeBrush	The brush used to draw an strike through the text (if any)
FSlateBrush	UnderlineBrush	The brush used to draw an underline under the text (if any)

Constructors

	Name	Description
	FTextBlockStyle()

Destructors

	Name	Description
	~FTextBlockStyle()

Functions

	Name	Description
const FTextB...	GetDefault()
FTextBlockSt...	SetColorAndOpacity ( const FSlateColor& InColorAndOpaci... )
FTextBlockSt...	SetFont ( const UObject* InFontObject, const int32 InSize, const FName& InTypefaceFontName )
FTextBlockSt...	SetFont ( TSharedPtr< const FCompositeFont > ..., const int32 InSize, const FName& InTypefaceFontName )
FTextBlockSt...	SetFont ( const ANSICHAR* InFontName, uint16 InSize )
FTextBlockSt...	SetFont ( const WIDECHAR* InFontName, uint16 InSize )
FTextBlockSt...	SetFont ( const FString& InFontName, uint16 InSize )
FTextBlockSt...	SetFont ( const FName& InFontName, uint16 InSize )
FTextBlockSt...	SetFont ( const FSlateFontInfo& InFont )
FTextBlockSt...	SetFontName ( const FString& InFontName )
FTextBlockSt...	SetFontName ( const FName& InFontName )
FTextBlockSt...	SetFontName ( const ANSICHAR* InFontName )
FTextBlockSt...	SetFontName ( const WIDECHAR* InFontName )
FTextBlockSt...	SetFontSize ( uint16 InSize )
FTextBlockSt...	SetHighlightColor ( const FLinearColor& InHighlightCol... )
FTextBlockSt...	SetHighlightShape ( const FSlateBrush& InHighlightShap... )
FTextBlockSt...	SetSelectedBackgroundColor ( const FSlateColor& InSelectedBackg... )
FTextBlockSt...	SetShadowColorAndOpacity ( const FLinearColor& InShadowColorA... )
FTextBlockSt...	SetShadowOffset ( const FVector2D& InShadowOffset )
FTextBlockSt...	SetStrikeBrush ( const FSlateBrush& InStrikeBrush )
FTextBlockSt...	SetTypefaceFontName ( const FName& InTypefaceFontName )
FTextBlockSt...	SetUnderlineBrush ( const FSlateBrush& InUnderlineBrus... )
void	UnlinkColors()	Unlinks all colors in this style.

Overridden from FSlateWidgetStyle

		Name	Description
	void	GetResources ( TArray< const FSlateBrush* >&... )	Gets the brush resources associated with this style.
	const FName	GetTypeName()	Gets the name of this style. This method must be implemented by inherited structures.

Name

Description

void

GetResources

(
TArray< const FSlateBrush* >&...
)

Gets the brush resources associated with this style.

const FName

GetTypeName()

Gets the name of this style.

This method must be implemented by inherited structures.

Constants

Name	Description
TypeName

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss