1. Epic GamesDeveloper
  3. FTextBlockStyle

FTextBlockStyle

Represents the appearance of an STextBlock

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

Inheritance Hierarchy

References

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

Syntax

USTRUCT (BlueprintType )  
struct FTextBlockStyle : public FSlateWidgetStyle

Remarks

Represents the appearance of an STextBlock

Variables

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

Constructors

  Type Name Description
Public function    
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Static const FTextBlockStyle &  
Public function Const bool

IsIdenticalTo ( const FTextBlockStyle::CompareParams& InNewStyleParams
)

 Checks to see whether this style is identical to another.
Public function Const bool

IsIdenticalTo ( const FTextBlockStyle& InOther
)

 Checks to see whether this style is identical to another.
Public function FTextBlockStyle &

SetColorAndOpacity ( const FSlateColor& InColorAndOpacity
)

  
Public function FTextBlockStyle &

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

  
Public function FTextBlockStyle &

SetFont ( const ANSICHAR* InFontName,
float InSize
)

  
Public function FTextBlockStyle &

SetFont ( const WIDECHAR* InFontName,
float InSize
)

  
Public function FTextBlockStyle &

SetFont ( const FString& InFontName,
float InSize
)

  
Public function FTextBlockStyle &

SetFont ( const FName& InFontName,
float InSize
)

  
Public function FTextBlockStyle &

SetFont ( const FSlateFontInfo& InFont
)

  
Public function FTextBlockStyle &

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

  
Public function FTextBlockStyle &

SetFontMaterial ( UObject* InMaterial
)

  
Public function FTextBlockStyle &

SetFontName ( const FString& InFontName
)

  
Public function FTextBlockStyle &

SetFontName ( const FName& InFontName
)

  
Public function FTextBlockStyle &

SetFontName ( const ANSICHAR* InFontName
)

  
Public function FTextBlockStyle &

SetFontName ( const WIDECHAR* InFontName
)

  
Public function FTextBlockStyle &  
Public function FTextBlockStyle &

SetFontSize ( float InSize
)

  
Public function FTextBlockStyle &

SetHighlightColor ( const FSlateColor& InHighlightColor
)

  
Public function FTextBlockStyle &

SetHighlightShape ( const FSlateBrush& InHighlightShape
)

  
Public function FTextBlockStyle &

SetOverflowPolicy ( const ETextOverflowPolicy& InOverflowPolicy
)

  
Public function FTextBlockStyle &

SetSelectedBackgroundColor ( const FSlateColor& InSelectedBackgroundColor
)

  
Public function FTextBlockStyle &

SetShadowColorAndOpacity ( const FLinearColor& InShadowColorAndOpacity
)

  
Public function FTextBlockStyle &  
Public function FTextBlockStyle &

SetStrikeBrush ( const FSlateBrush& InStrikeBrush
)

  
Public function FTextBlockStyle &

SetTransformPolicy ( const ETextTransformPolicy& InTransformPolicy
)

  
Public function FTextBlockStyle &

SetTypefaceFontName ( const FName& InTypefaceFontName
)

  
Public function FTextBlockStyle &

SetUnderlineBrush ( const FSlateBrush& InUnderlineBrush
)

  
Public function void Unlinks all colors in this style.

Overridden from FSlateWidgetStyle

  Type Name Description
Public function Virtual Const void

GetResources ( TArray< const FSlateBrush* >& OutBrushes
)

 Gets the brush resources associated with this style.
Public function Virtual Const const FName Gets the name of this style.This method must be implemented by inherited structures.

Classes

  Type Name Description
Public struct CompareParams Helper struct to compare two text styles without constructing a temporary text style  

Constants

Name Description
TypeName  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page