Navigation
API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Widgets > API/Runtime/Slate/Widgets/Text > API/Runtime/Slate/Widgets/Text/SRichTextBlock
Inheritance Hierarchy
- FSlateBaseNamedArgs
- TSlateBaseNamedArgs
- SRichTextBlock::FArguments
References
| Module | Slate |
| Header | /Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h |
| Include | #include "Widgets/Text/SRichTextBlock.h" |
Syntax
struct FArguments : public TSlateBaseNamedArgs< SRichTextBlock >
Variables
| Type | Name | Description | |
|---|---|---|---|
| TArray< TSharedRef< ITextDecorator > > | InlineDecorators | Additional decorators can be append to the widget inline. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
FArguments () |
Functions
| Type | Name | Description | |
|---|---|---|---|
| WidgetArgsType & | AutoWrapText
(
const TAttribute< bool >& InAttribute |
Whether to wrap text automatically based on the widget's computed horizontal space. | |
| WidgetArgsType & | CreateSlateTextLayout
(
const FCreateSlateTextLayout& InDelegate |
Delegate used to create text layouts for this widget. | |
| WidgetArgsType & | Decorators
(
TArray< TSharedRef< class ITextDecorator > > InArg |
Any decorators that should be used while parsing the text. | |
| WidgetArgsType & | DecoratorStyleSet
(
const ISlateStyle* InArg |
The style set used for looking up styles used by decorators | |
| WidgetArgsType & | HighlightText
(
const TAttribute< FText >& InAttribute |
Highlight this text in the text block | |
| WidgetArgsType & | Justification
(
const TAttribute< ETextJustify::Type >& InAttribute |
How the text should be aligned with the margin. | |
| WidgetArgsType & | LineHeightPercentage
(
const TAttribute< float >& InAttribute |
The amount to scale each lines height by. | |
| WidgetArgsType & | Margin
(
const TAttribute< FMargin >& InAttribute |
The amount of blank space left around the edges of text area. | |
| WidgetArgsType & | Marshaller
(
TSharedPtr< class FRichTextLayoutMarshaller > InArg |
The marshaller used to get/set the raw text to/from the text layout. | |
| WidgetArgsType & | MinDesiredWidth
(
const TAttribute< float >& InAttribute |
Minimum width that this text block should be | |
| WidgetArgsType & | OverflowPolicy
(
TOptional< ETextOverflowPolicy > InArg |
Determines what happens to text that is clipped and doesn't fit within the clip rect for this widget | |
| WidgetArgsType & | Parser
(
TSharedPtr< class IRichTextMarkupParser > InArg |
The parser used to resolve any markup used in the provided string. | |
| WidgetArgsType & | Text
(
const TAttribute< FText >& InAttribute |
The text displayed in this text block | |
| WidgetArgsType & | TextFlowDirection
(
TOptional< ETextFlowDirection > InArg |
Which text flow direction should we use? (unset to use the default returned by GetDefaultTextFlowDirection) | |
| WidgetArgsType & | TextShapingMethod
(
TOptional< ETextShapingMethod > InArg |
Which text shaping method should we use? (unset to use the default returned by GetDefaultTextShapingMethod) | |
| WidgetArgsType & | TextStyle
(
const FTextBlockStyle* InArg |
The style of the text block, which dictates the default font, color, and shadow options. | |
| WidgetArgsType & | TransformPolicy
(
const TAttribute< ETextTransformPolicy >& InAttribute |
The transform policy to use | |
| WidgetArgsType & | WrappingPolicy
(
const TAttribute< ETextWrappingPolicy >& InAttribute |
The wrapping policy to use | |
| WidgetArgsType & | WrapTextAt
(
const TAttribute< float >& InAttribute |
Whether text wraps onto a new line when it's length exceeds this width; if this value is zero or negative, no wrapping occurs. |
Operators
| Type | Name | Description | |
|---|---|---|---|
| SRichTextBlock::FArguments & | operator+
(
const TSharedRef< ITextDecorator >& DecoratorToAdd |
Typedefs
| Name | Description |
|---|---|
| WidgetArgsType |