1. Epic GamesDeveloper
  3. FTextBlockStyle

FTextBlockStyle

Represents the appearance of an STextBlock

API > API/Runtime > API/Runtime/SlateCore

Represents the appearance of an STextBlock

   
Name FTextBlockStyle
Type struct
Header File /Engine/Source/Runtime/SlateCore/Public/Styling/SlateTypes.h
Include Path #include "Styling/SlateTypes.h"

Syntax

USTRUCT (BlueprintType )  
struct FTextBlockStyle : public FSlateWidgetStyle

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
  Styling/SlateTypes.h  
  Styling/SlateTypes.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FTextBlockStyle()

   Styling/SlateTypes.h  

Structs

Name Remarks
CompareParams Helper struct to compare two text styles without constructing a temporary text style

Constants

Name Type Remarks Include Path
TypeName const FName   Styling/SlateTypes.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ColorAndOpacity FSlateColor The color and opacity of this text Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Appearance
  • Meta=(DisplayName="Color")
Font FSlateFontInfo Font family and size to be used when displaying this text. Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Appearance
HighlightColor FSlateColor The color of highlighted text Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Appearance
  • AdvancedDisplay
HighlightShape FSlateBrush The shape of highlighted text Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Appearance
  • AdvancedDisplay
OverflowPolicy ETextOverflowPolicy Determines what happens to text that is clipped and doesn't fit within the clip rect of a text widget Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Appearance
  • AdvancedDisplay
SelectedBackgroundColor FSlateColor The background color of selected text Styling/SlateTypes.h
  • EditAnywhere
  • Category=Appearance
ShadowColorAndOpacity FLinearColor The color and opacity of the shadow Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Appearance
ShadowOffset FDeprecateSlateVector2D How much should the shadow be offset? An offset of 0 implies no shadow. Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Appearance
StrikeBrush FSlateBrush The brush used to draw an strike through the text (if any) Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Appearance
  • AdvancedDisplay
TransformPolicy ETextTransformPolicy The Text Transform Policy (defaults to None) Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Appearance
  • AdvancedDisplay
UnderlineBrush FSlateBrush The brush used to draw an underline under the text (if any) Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Appearance
  • AdvancedDisplay

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

 Checks to see whether this style is identical to another. Styling/SlateTypes.h  

bool IsIdenticalTo ( const FTextBlockStyle& InOther
) const

 Checks to see whether this style is identical to another. Styling/SlateTypes.h  

FTextBlockStyle & SetColorAndOpacity ( const FSlateColor& InColorAndOpacity
)

   Styling/SlateTypes.h  

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

   Styling/SlateTypes.h  

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

   Styling/SlateTypes.h  

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

   Styling/SlateTypes.h  

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

   Styling/SlateTypes.h  

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

   Styling/SlateTypes.h  

FTextBlockStyle & SetFont ( const FSlateFontInfo& InFont
)

   Styling/SlateTypes.h  

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

   Styling/SlateTypes.h  

FTextBlockStyle & SetFontMaterial ( UObject* InMaterial
)

   Styling/SlateTypes.h  

FTextBlockStyle & SetFontName ( const FString& InFontName
)

   Styling/SlateTypes.h  

FTextBlockStyle & SetFontName ( const FName& InFontName
)

   Styling/SlateTypes.h  

FTextBlockStyle & SetFontName ( const ANSICHAR* InFontName
)

   Styling/SlateTypes.h  

FTextBlockStyle & SetFontName ( const WIDECHAR* InFontName
)

   Styling/SlateTypes.h  

FTextBlockStyle & SetFontOutlineMaterial ( UObject* InMaterial
)

   Styling/SlateTypes.h  

FTextBlockStyle & SetFontSize ( float InSize
)

   Styling/SlateTypes.h  

FTextBlockStyle & SetHighlightColor ( const FSlateColor& InHighlightColor
)

   Styling/SlateTypes.h  

FTextBlockStyle & SetHighlightShape ( const FSlateBrush& InHighlightShape
)

   Styling/SlateTypes.h  

FTextBlockStyle & SetOverflowPolicy ( const ETextOverflowPolicy& InOverflowPolicy
)

   Styling/SlateTypes.h  

FTextBlockStyle & SetSelectedBackgroundColor ( const FSlateColor& InSelectedBackgroundColor
)

   Styling/SlateTypes.h  

FTextBlockStyle & SetShadowColorAndOpacity ( const FLinearColor& InShadowColorAndOpacity
)

   Styling/SlateTypes.h  

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

   Styling/SlateTypes.h  

FTextBlockStyle & SetStrikeBrush ( const FSlateBrush& InStrikeBrush
)

   Styling/SlateTypes.h  

FTextBlockStyle & SetTransformPolicy ( const ETextTransformPolicy& InTransformPolicy
)

   Styling/SlateTypes.h  

FTextBlockStyle & SetTypefaceFontName ( const FName& InTypefaceFontName
)

   Styling/SlateTypes.h  

FTextBlockStyle & SetUnderlineBrush ( const FSlateBrush& InUnderlineBrush
)

   Styling/SlateTypes.h  

void UnlinkColors ()

 Unlinks all colors in this style. Styling/SlateTypes.h  

Overridden from FSlateWidgetStyle

Name Remarks Include Path Unreal Specifiers

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

 Gets the brush resources associated with this style. Styling/SlateTypes.h  

virtual const FName GetTypeName()

 Gets the name of this style.This method must be implemented by inherited structures. Styling/SlateTypes.h  

Static

Name Remarks Include Path Unreal Specifiers

static const FTextBlockStyle & GetDefault()

   Styling/SlateTypes.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page