FTextBlockStyle Struct Reference

#include <SlateTypes.h>

Inheritance diagram for FTextBlockStyle:

Classes
struct	CompareParams

Public Member Functions
SLATECORE_API	FTextBlockStyle ()
SLATECORE_API	FTextBlockStyle (const FTextBlockStyle &)
virtual SLATECORE_API	~FTextBlockStyle ()
virtual SLATECORE_API void	GetResources (TArray< const FSlateBrush * > &OutBrushes) const override
virtual const FName	GetTypeName () const override
FTextBlockStyle &	SetFont (const FSlateFontInfo &InFont)
FTextBlockStyle &	SetFont (TSharedPtr< const FCompositeFont > InCompositeFont, const float InSize, const FName &InTypefaceFontName=NAME_None)
FTextBlockStyle &	SetFont (const UObject *InFontObject, const float InSize, const FName &InTypefaceFontName=NAME_None)
FTextBlockStyle &	SetFont (const FName &InFontName, float InSize)
FTextBlockStyle &	SetFont (const FString &InFontName, float InSize)
FTextBlockStyle &	SetFont (const WIDECHAR *InFontName, float InSize)
FTextBlockStyle &	SetFont (const ANSICHAR *InFontName, float InSize)
FTextBlockStyle &	SetFontName (const FName &InFontName)
FTextBlockStyle &	SetFontName (const FString &InFontName)
FTextBlockStyle &	SetFontName (const WIDECHAR *InFontName)
FTextBlockStyle &	SetFontName (const ANSICHAR *InFontName)
FTextBlockStyle &	SetFontSize (float InSize)
FTextBlockStyle &	SetTypefaceFontName (const FName &InTypefaceFontName)
FTextBlockStyle &	SetFontMaterial (UObject *InMaterial)
FTextBlockStyle &	SetFontOutlineMaterial (UObject *InMaterial)
FTextBlockStyle &	SetColorAndOpacity (const FSlateColor &InColorAndOpacity)
FTextBlockStyle &	SetShadowOffset (const UE::Slate::FDeprecateVector2DParameter &InShadowOffset)
FTextBlockStyle &	SetShadowColorAndOpacity (const FLinearColor &InShadowColorAndOpacity)
FTextBlockStyle &	SetSelectedBackgroundColor (const FSlateColor &InSelectedBackgroundColor)
FTextBlockStyle &	SetHighlightColor (const FSlateColor &InHighlightColor)
FTextBlockStyle &	SetHighlightShape (const FSlateBrush &InHighlightShape)
FTextBlockStyle &	SetStrikeBrush (const FSlateBrush &InStrikeBrush)
FTextBlockStyle &	SetUnderlineBrush (const FSlateBrush &InUnderlineBrush)
FTextBlockStyle &	SetTransformPolicy (const ETextTransformPolicy &InTransformPolicy)
FTextBlockStyle &	SetOverflowPolicy (const ETextOverflowPolicy &InOverflowPolicy)
bool	IsIdenticalTo (const FTextBlockStyle &InOther) const
bool	IsIdenticalTo (const FTextBlockStyle::CompareParams &InNewStyleParams) const
void	UnlinkColors ()
Public Member Functions inherited from FSlateWidgetStyle
SLATECORE_API	FSlateWidgetStyle ()
virtual SLATECORE_API	~FSlateWidgetStyle ()

Static Public Member Functions
static SLATECORE_API const FTextBlockStyle &	GetDefault ()

Public Attributes
FSlateFontInfo	Font
FSlateColor	ColorAndOpacity
FDeprecateSlateVector2D	ShadowOffset
FLinearColor	ShadowColorAndOpacity
FSlateColor	SelectedBackgroundColor
FSlateColor	HighlightColor
FSlateBrush	HighlightShape
FSlateBrush	StrikeBrush
FSlateBrush	UnderlineBrush
ETextTransformPolicy	TransformPolicy
ETextOverflowPolicy	OverflowPolicy

Static Public Attributes
static SLATECORE_API const FName	TypeName

Detailed Description

Represents the appearance of an STextBlock

Constructor & Destructor Documentation

FTextBlockStyle() [1/2]

FTextBlockStyle::FTextBlockStyle

(

)

FTextBlockStyle() [2/2]

FTextBlockStyle::FTextBlockStyle ( const FTextBlockStyle &  )

default

~FTextBlockStyle()

FTextBlockStyle::~FTextBlockStyle ( )

virtualdefault

Member Function Documentation

GetDefault()

const FTextBlockStyle & FTextBlockStyle::GetDefault ( )

static

GetResources()

void FTextBlockStyle::GetResources ( TArray< const FSlateBrush * > &  OutBrushes ) const

overridevirtual

Gets the brush resources associated with this style.

This method must be implemented by inherited structures.

Parameters

OutBrushes

The brush resources.

Reimplemented from FSlateWidgetStyle.

GetTypeName()

virtual const FName FTextBlockStyle::GetTypeName ( ) const

inlineoverridevirtual

Gets the name of this style.

This method must be implemented by inherited structures.

Returns

Widget style name.

Reimplemented from FSlateWidgetStyle.

IsIdenticalTo() [1/2]

bool FTextBlockStyle::IsIdenticalTo ( const FTextBlockStyle &  InOther ) const

inline

Checks to see whether this style is identical to another.

IsIdenticalTo() [2/2]

bool FTextBlockStyle::IsIdenticalTo ( const FTextBlockStyle::CompareParams &  InNewStyleParams ) const

inline

Checks to see whether this style is identical to another.

SetColorAndOpacity()

FTextBlockStyle & FTextBlockStyle::SetColorAndOpacity ( const FSlateColor &  InColorAndOpacity )

inline

SetFont() [1/7]

FTextBlockStyle & FTextBlockStyle::SetFont	(	const ANSICHAR *	InFontName,
		float	InSize
	)

SetFont() [2/7]

PRAGMA_DISABLE_DEPRECATION_WARNINGS FTextBlockStyle & FTextBlockStyle::SetFont	(	const FName &	InFontName,
		float	InSize
	)

SetFont() [3/7]

FTextBlockStyle & FTextBlockStyle::SetFont ( const FSlateFontInfo &  InFont )

inline

SetFont() [4/7]

FTextBlockStyle & FTextBlockStyle::SetFont	(	const FString &	InFontName,
		float	InSize
	)

SetFont() [5/7]

FTextBlockStyle & FTextBlockStyle::SetFont ( const UObject *  InFontObject, const float  InSize, const FName &  InTypefaceFontName = NAME_None  )

inline

SetFont() [6/7]

FTextBlockStyle & FTextBlockStyle::SetFont	(	const WIDECHAR *	InFontName,
		float	InSize
	)

SetFont() [7/7]

FTextBlockStyle & FTextBlockStyle::SetFont ( TSharedPtr< const FCompositeFont >  InCompositeFont, const float  InSize, const FName &  InTypefaceFontName = NAME_None  )

inline

SetFontMaterial()

FTextBlockStyle & FTextBlockStyle::SetFontMaterial ( UObject *  InMaterial )

inline

SetFontName() [1/4]

FTextBlockStyle & FTextBlockStyle::SetFontName

(

const ANSICHAR *

InFontName

)

SetFontName() [2/4]

FTextBlockStyle & FTextBlockStyle::SetFontName

(

const FName &

InFontName

)

SetFontName() [3/4]

FTextBlockStyle & FTextBlockStyle::SetFontName

(

const FString &

InFontName

)

SetFontName() [4/4]

FTextBlockStyle & FTextBlockStyle::SetFontName

(

const WIDECHAR *

InFontName

)

SetFontOutlineMaterial()

FTextBlockStyle & FTextBlockStyle::SetFontOutlineMaterial ( UObject *  InMaterial )

inline

SetFontSize()

FTextBlockStyle & FTextBlockStyle::SetFontSize ( float  InSize )

inline

SetHighlightColor()

FTextBlockStyle & FTextBlockStyle::SetHighlightColor ( const FSlateColor &  InHighlightColor )

inline

SetHighlightShape()

FTextBlockStyle & FTextBlockStyle::SetHighlightShape ( const FSlateBrush &  InHighlightShape )

inline

SetOverflowPolicy()

FTextBlockStyle & FTextBlockStyle::SetOverflowPolicy ( const ETextOverflowPolicy &  InOverflowPolicy )

inline

SetSelectedBackgroundColor()

FTextBlockStyle & FTextBlockStyle::SetSelectedBackgroundColor ( const FSlateColor &  InSelectedBackgroundColor )

inline

SetShadowColorAndOpacity()

FTextBlockStyle & FTextBlockStyle::SetShadowColorAndOpacity ( const FLinearColor &  InShadowColorAndOpacity )

inline

SetShadowOffset()

FTextBlockStyle & FTextBlockStyle::SetShadowOffset ( const UE::Slate::FDeprecateVector2DParameter &  InShadowOffset )

inline

SetStrikeBrush()

FTextBlockStyle & FTextBlockStyle::SetStrikeBrush ( const FSlateBrush &  InStrikeBrush )

inline

SetTransformPolicy()

FTextBlockStyle & FTextBlockStyle::SetTransformPolicy ( const ETextTransformPolicy &  InTransformPolicy )

inline

SetTypefaceFontName()

FTextBlockStyle & FTextBlockStyle::SetTypefaceFontName ( const FName &  InTypefaceFontName )

inline

SetUnderlineBrush()

FTextBlockStyle & FTextBlockStyle::SetUnderlineBrush ( const FSlateBrush &  InUnderlineBrush )

inline

UnlinkColors()

void FTextBlockStyle::UnlinkColors ( )

inline

Unlinks all colors in this style.

See also

FSlateColor::Unlink

Member Data Documentation

ColorAndOpacity

FSlateColor FTextBlockStyle::ColorAndOpacity

The color and opacity of this text

Font

FSlateFontInfo FTextBlockStyle::Font

Font family and size to be used when displaying this text.

HighlightColor

FSlateColor FTextBlockStyle::HighlightColor

The color of highlighted text

HighlightShape

FSlateBrush FTextBlockStyle::HighlightShape

The shape of highlighted text

OverflowPolicy

ETextOverflowPolicy FTextBlockStyle::OverflowPolicy

Determines what happens to text that is clipped and doesn't fit within the clip rect of a text widget

SelectedBackgroundColor

FSlateColor FTextBlockStyle::SelectedBackgroundColor

The background color of selected text

ShadowColorAndOpacity

FLinearColor FTextBlockStyle::ShadowColorAndOpacity

The color and opacity of the shadow

ShadowOffset

FDeprecateSlateVector2D FTextBlockStyle::ShadowOffset

How much should the shadow be offset? An offset of 0 implies no shadow.

StrikeBrush

FSlateBrush FTextBlockStyle::StrikeBrush

The brush used to draw an strike through the text (if any)

TransformPolicy

ETextTransformPolicy FTextBlockStyle::TransformPolicy

The Text Transform Policy (defaults to None)

TypeName

const FName FTextBlockStyle::TypeName

static

UnderlineBrush

FSlateBrush FTextBlockStyle::UnderlineBrush

The brush used to draw an underline under the text (if any)

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/SlateCore/Public/Styling/SlateTypes.h
• Engine/Source/Runtime/SlateCore/Private/Styling/SlateTypes.cpp