UCommonTextStyle

- All properties must be EditDefaultsOnly, BlueprintReadOnly !!! -- We return the CDO to blueprints, so we cannot allow any changes (blueprint doesn't support const variables)

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

CommonUI

Header

/Engine/Plugins/Experimental/CommonUI/Source/CommonUI/Public/CommonTextBlock.h

Include

#include "CommonTextBlock.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract, Blueprintable, ClassGroup=UI, Meta=(Category="Common UI"))
class UCommonTextStyle : public UObject

Remarks

  • All properties must be EditDefaultsOnly, BlueprintReadOnly !!! -- We return the CDO to blueprints, so we cannot allow any changes (blueprint doesn't support const variables)

Variables

Name Description

Public variable UProperty Category, EditDefaultsOnly BlueprintReadOnly

bool

 

bUsesDropShadow

Whether or not the style uses a drop shadow

Public variable UProperty Category, EditDefaultsOnly BlueprintReadOnly

FLinearColor

 

Color

The color of the text

Public variable UProperty Category, EditDefaultsOnly BlueprintReadOnly

FSlateFontInfo

 

Font

The font to apply at each size

Public variable UProperty Category, EditDefaultsOnly BlueprintReadOnly

float

 

LineHeightPercentage

The amount to scale each lines height by at each size

Public variable UProperty Category, EditDefaultsOnly BlueprintReadOnly

FMargin

 

Margin

The amount of blank space left around the edges of text area at each size

Public variable UProperty Category, EditDefaultsOnly, Meta BlueprintReadOnly

FLinearColor

 

ShadowColor

The drop shadow color

Public variable UProperty Category, EditDefaultsOnly, Meta BlueprintReadOnly

FVector2D

 

ShadowOffset

The offset of the drop shadow at each size

Public variable UProperty Category, EditDefaultsOnly BlueprintReadOnly

FSlateBrush

 

StrikeBrush

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

Constructors

Name Description

Public function

UCommonTextStyle()

Functions

Name Description

Public function Const

void

 

ApplyToTextBlock

(
    const TSharedRef< STextBlock >& Te...
)

Public function Const UFunction BlueprintCallable, Category

void

 

GetColor

(
    FLinearColor& OutColor
)

Public function Const UFunction BlueprintCallable, Category

void

 

GetFont

(
    FSlateFontInfo& OutFont
)

Public function Const UFunction BlueprintCallable, Category

float

 

GetLineHeightPercentage()

Public function Const UFunction BlueprintCallable, Category

void

 

GetMargin

(
    FMargin& OutMargin
)

Public function Const UFunction BlueprintCallable, Category

void

 

GetShadowColor

(
    FLinearColor& OutColor
)

Public function Const UFunction BlueprintCallable, Category

void

 

GetShadowOffset

(
    FVector2D& OutShadowOffset
)

Public function Const UFunction BlueprintCallable, Category

void

 

GetStrikeBrush

(
    FSlateBrush& OutStrikeBrush
)

Public function Const

void

 

ToTextBlockStyle

(
    FTextBlockStyle& OutTextBlockStyle
)
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss