Navigation
API > API/Plugins > API/Plugins/CommonUI
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UVisual
- UWidget
- UTextLayoutWidget
- UTextBlock
- UCommonTextBlock
- UCommonDateTimeTextBlock
- UCommonNumericTextBlock
References
| Module | CommonUI |
| Header | /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/CommonTextBlock.h |
| Include | #include "CommonTextBlock.h" |
Syntax
UCLASS&40;Config&61;CommonUI, defaultconfig, ClassGroup&61;UI,
Meta&61;&40;Category&61;"Common UI", DisplayName&61;"Common Text", prioritizeCategories&61;"Content"&41;&41;
class UCommonTextBlock : public UTextBlock
Remarks
Text block with automatic scrolling for FX / large texts, also supports a larger set of default styling, & custom mobile scaling.
Variables
| Type | Name | Description | |
|---|---|---|---|
| float | MobileFontSizeMultiplier | Mobile font size multiplier. Activated by default on mobile. See CVar Mobile_PreviewFontSize |
Constructors
| Type | Name | Description | |
|---|---|---|---|
UCommonTextBlock
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
| const FMargin & | GetMargin () |
||
| float | |||
| void | |||
| void | SetLineHeightPercentage
(
float InLineHeightPercentage |
||
| void | |||
| void | SetMobileFontSizeMultiplier
(
float InMobileFontSizeMultiplier |
Sets the new value and then applies the FontSizeMultiplier | |
| void | SetScrollingEnabled
(
bool bInIsScrollingEnabled |
||
| void | SetStyle
(
TSubclassOf< UCommonTextStyle > InStyle |
||
| void | SetTextCase
(
bool bUseAllCaps |
||
| void | SetWrapTextWidth
(
int32 InWrapTextAt |
Overridden from UTextBlock
| Type | Name | Description | |
|---|---|---|---|
| void | |||
| void |
Overridden from UWidget
| Type | Name | Description | |
|---|---|---|---|
| const FText | Gets the palette category of the widget | ||
| void | Called after constructing a new widget from the palette. | ||
| TSharedRef< SWidget > | Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed. | ||
| void | Applies all properties to the native widget if possible. |
Overridden from UVisual
| Type | Name | Description | |
|---|---|---|---|
| void | ReleaseSlateResources
(
bool bReleaseChildren |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| bool | CanEditChange
(
const FProperty* InProperty |
Called by the editor to query whether a property of this object is allowed to be modified. | |
| void | Called after the C++ constructor and after the properties have been initialized, including those loaded from config. | ||
| void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. | |
| void | Handles reading, writing, and reference collecting using FArchive. |