Navigation
API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/STextBlock
| Name | FArguments |
| Type | struct |
| Header File | /Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h |
| Include Path | #include "Widgets/Text/STextBlock.h" |
Syntax
struct FArguments : public TSlateBaseNamedArgs< STextBlock >
Inheritance Hierarchy
- FSlateBaseNamedArgs → TSlateBaseNamedArgs → STextBlock::FArguments
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FArguments() |
Widgets/Text/STextBlock.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| WidgetArgsType | FArguments | Widgets/Text/STextBlock.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/STextBlock.h | |
WidgetArgsType & AutoWrapText
(
const TAttribute< bool >& InAttribute |
Whether to wrap text automatically based on the widget's computed horizontal space. | Widgets/Text/STextBlock.h | |
WidgetArgsType & ColorAndOpacity
(
const TAttribute< FSlateColor >& InAttribute |
Text color and opacity | Widgets/Text/STextBlock.h | |
WidgetArgsType & Font
(
const TAttribute< FSlateFontInfo >& InAttribute |
Sets the font used to draw the text | Widgets/Text/STextBlock.h | |
WidgetArgsType & HighlightColor
(
const TAttribute< FLinearColor >& InAttribute |
The color used to highlight the specified text | Widgets/Text/STextBlock.h | |
WidgetArgsType & HighlightShape
(
const TAttribute< const FSlateBrush* >& InAttribute |
The brush used to highlight the specified text | Widgets/Text/STextBlock.h | |
WidgetArgsType & HighlightText
(
const TAttribute< FText >& InAttribute |
Highlight this text in the text block | Widgets/Text/STextBlock.h | |
WidgetArgsType & Justification
(
const TAttribute< ETextJustify::Type >& InAttribute |
How the text should be aligned with the margin. | Widgets/Text/STextBlock.h | |
WidgetArgsType & LineBreakPolicy
(
TSharedPtr< IBreakIterator > InArg |
The iterator to use to detect appropriate soft-wrapping points for lines (or null to use the default) | Widgets/Text/STextBlock.h | |
WidgetArgsType & LineHeightPercentage
(
const TAttribute< float >& InAttribute |
The amount to scale each lines height by. | Widgets/Text/STextBlock.h | |
WidgetArgsType & Margin
(
const TAttribute< FMargin >& InAttribute |
The amount of blank space left around the edges of text area. | Widgets/Text/STextBlock.h | |
WidgetArgsType & MinDesiredWidth
(
const TAttribute< float >& InAttribute |
Minimum width that a text block should be | Widgets/Text/STextBlock.h | |
WidgetArgsType & OnDoubleClicked
(
const FPointerEventHandler& InDelegate |
Called when this text is double clicked | Widgets/Text/STextBlock.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/STextBlock.h | |
WidgetArgsType & ShadowColorAndOpacity
(
const TAttribute< FLinearColor >& InAttribute |
Shadow color and opacity | Widgets/Text/STextBlock.h | |
WidgetArgsType & ShadowOffset
(
const TAttribute< FVector2D >& InAttribute |
Drop shadow offset in pixels | Widgets/Text/STextBlock.h | |
WidgetArgsType & SimpleTextMode
(
bool InArg |
If this is enabled, text shaping, wrapping, justification are disabled in favor of much faster text layout and measurement. | Widgets/Text/STextBlock.h | |
WidgetArgsType & StrikeBrush
(
const TAttribute< const FSlateBrush* >& InAttribute |
Sets the brush used to strike through the text | Widgets/Text/STextBlock.h | |
WidgetArgsType & Text
(
const TAttribute< FText >& InAttribute |
The text displayed in this text block | Widgets/Text/STextBlock.h | |
WidgetArgsType & TextFlowDirection
(
TOptional< ETextFlowDirection > InArg |
Which text flow direction should we use? (unset to use the default returned by GetDefaultTextFlowDirection) | Widgets/Text/STextBlock.h | |
WidgetArgsType & TextShapingMethod
(
TOptional< ETextShapingMethod > InArg |
Which text shaping method should we use? (unset to use the default returned by GetDefaultTextShapingMethod) | Widgets/Text/STextBlock.h | |
WidgetArgsType & TextStyle
(
const FTextBlockStyle* InArg |
Pointer to a style of the text block, which dictates the font, color, and shadow options. | Widgets/Text/STextBlock.h | |
WidgetArgsType & TransformPolicy
(
const TAttribute< ETextTransformPolicy >& InAttribute |
The transform policy to use | Widgets/Text/STextBlock.h | |
WidgetArgsType & WrappingPolicy
(
const TAttribute< ETextWrappingPolicy >& InAttribute |
The wrapping policy to use | Widgets/Text/STextBlock.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/STextBlock.h |