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