className
stringlengths
1
167
headerPath
stringlengths
14
166
description
stringlengths
0
1.62k
module
stringlengths
0
76
code
stringlengths
0
11.4k
variables
listlengths
0
395
SMultiLineEditableText::~SMultiLineEditableText
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SMultiLineEditableText.h
Slate
~SMultiLineEditableText()
[]
SRichTextBlock::ComputeDesiredSize
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Note thatComputeDesiredSize()is meant as an aide to the developer. It is NOT meant to be very robust in many cases. If your widget is simulating a bouncing ball, you should just return a reasonable size; e.g. 160x160. Let the programmer set up a reasonable rule of resizing the bouncy ball simulation. The desired size.
Slate
virtual FVector2D ComputeDesiredSize ( float LayoutScaleMultiplier ) const
[]
SMultiLineEditableText
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SMultiLineEditableText.h
An editable text widget that supports multiple lines and soft word-wrapping.
Slate
class SMultiLineEditableText : public [SWidget](API\Runtime\SlateCore\Widgets\SWidget), public [ISlateEditableTextWidget](API\Runtime\Slate\Widgets\Text\ISlateEditableTextWidget)
[ { "type": "TWeakPtr< FActi...", "name": "ActiveTickTimer", "description": "The timer that is actively driving this widget toTick()even when Slate is idle" }, { "type": "float", "name": "AmountScrolledWhileRightMouseDown", "description": "How much we scrolled while RMB was being held" }, { "type": "TAttribute< boo...", "name": "bAllowContextMenu", "description": "Whether the context menu can be opened" }, { "type": "TAttribute< boo...", "name": "bAllowMultiLine", "description": "Whether to allow multi-line text" }, { "type": "TAttribute< boo...", "name": "bClearKeyboardFocusOnCommit", "description": "True if we want the text control to lose focus on an text commit/revert events" }, { "type": "TAttribute< boo...", "name": "bClearTextSelectionOnFocusLoss", "description": "Whether to clear text selection when focus is lost" }, { "type": "TAttribute< boo...", "name": "bIsReadOnly", "description": "Sets whether this text box can actually be modified interactively by the user" }, { "type": "bool", "name": "bIsSoftwareCursor", "description": "Whether a software cursor is currently active" }, { "type": "TAttribute< boo...", "name": "bRevertTextOnEscape", "description": "True if any changes should be reverted if we receive an escape key" }, { "type": "TAttribute< boo...", "name": "bSelectAllTextWhenFocused", "description": "Whether to select all text when the user clicks to give focus on the widget" }, { "type": "TAttribute< boo...", "name": "bSelectWordOnMouseDoubleClick", "description": "Whether to select work on mouse double click" }, { "type": "TUniquePtr<FSl...", "name": "EditableTextLayout", "description": "The text layout that deals with the editable text" }, { "type": "TSharedPtr<SSc...", "name": "HScrollBar", "description": "The horizontal scroll bar widget" }, { "type": "TSharedPtr<FEx...", "name": "MenuExtender", "description": "Menu extender for right-click context menu" }, { "type": "EModifierKey::T...", "name": "ModiferKeyForNewLine", "description": "The optional modifier key necessary to create a newline when typing into the editor." }, { "type": "FOnContextMenuO...", "name": "OnContextMenuOpening", "description": "Delegate to call before a context menu is opened" }, { "type": "FOnCursorMoved", "name": "OnCursorMovedCallback", "description": "Called when the cursor is moved within the text area" }, { "type": "FOnUserScrolled", "name": "OnHScrollBarUserScrolled", "description": "Called whenever the horizontal scrollbar is moved by the user" }, { "type": "FOnIsTypedCharV...", "name": "OnIsTypedCharValid", "description": "Called when a character is typed and we want to know if the text field supports typing this character." }, { "type": "FOnKeyChar", "name": "OnKeyCharHandler", "description": "Callback delegate to have first chance handling of the OnKeyChar event" }, { "type": "FOnKeyDown", "name": "OnKeyDownHandler", "description": "Callback delegate to have first chance handling of the OnKeyDown event" }, { "type": "FOnTextChanged", "name": "OnTextChangedCallback", "description": "Called whenever the text is changed programmatically or interactively by the user" }, { "type": "FOnTextCommitte...", "name": "OnTextCommittedCallback", "description": "Called whenever the text is committed." }, { "type": "FOnUserScrolled", "name": "OnVScrollBarUserScrolled", "description": "Called whenever the vertical scrollbar is moved by the user" }, { "type": "FVector2f", "name": "SoftwareCursorPosition", "description": "The current position of the software cursor" }, { "type": "TAttribute< EVi...", "name": "VirtualKeyboardDismissAction", "description": "The message action to take when the virtual keyboard is dismissed by the user" }, { "type": "FVirtualKeyboar...", "name": "VirtualKeyboardOptions", "description": "Options to use for the virtual keyboard summoned by this widget" }, { "type": "TAttribute< EVi...", "name": "VirtualKeyboardTrigger", "description": "The type of event that will trigger the display of the virtual keyboard" }, { "type": "TSharedPtr<SSc...", "name": "VScrollBar", "description": "The vertical scroll bar widget" } ]
SRichTextBlock::ComputeVolatility
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Recomputes the volatility of the widget. If you have additional state you automatically want to make the widget volatile, you should sample that information here.
Slate
virtual bool ComputeVolatility() const
[]
SRichTextBlock::Construct
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Slate
void Construct ( const [FArguments](API\Runtime\Slate\Widgets\Text\SRichTextBlock\FArguments) & InArgs )
[]
SRichTextBlock::Decorator
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Slate
static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ITextDecorator](API\Runtime\Slate\Framework\Text\ITextDecorator) > Decorator ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ITextDecorator](API\Runtime\Slate\Framework\Text\ITextDecorator) > & Decorator )
[]
SRichTextBlock::FArguments::AutoWrapText
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Whether to wrap text automatically based on the widget's computed horizontal space. IMPORTANT: Using automatic wrapping can result in visual artifacts, as the the wrapped size will computed be at least one frame late! Consider using WrapTextAt instead. The initial desired size will not be clamped. This works best in cases where the text block's size is not affecting other widget's layout.
Slate
WidgetArgsType & AutoWrapText &40; const TAttribute< bool > & InAttribute &41;
[]
SRichTextBlock::FArguments::Justification
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
How the text should be aligned with the margin.
Slate
WidgetArgsType & Justification &40; const TAttribute< ETextJustify::Type > & InAttribute &41;
[]
SRichTextBlock::FArguments::HighlightText
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Highlight this text in the text block
Slate
WidgetArgsType & HighlightText &40; const TAttribute< FText > & InAttribute &41;
[]
SRichTextBlock::FArguments::CreateSlateTextLayout
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Delegate used to create text layouts for this widget. If none is provided thenFSlateTextLayoutwill be used.
Slate
WidgetArgsType & CreateSlateTextLayout &40; const FCreateSlateTextLayout & InDelegate &41;
[]
SRichTextBlock::FArguments::Decorators
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Any decorators that should be used while parsing the text.
Slate
WidgetArgsType & Decorators &40; TArray< TSharedRef< class ITextDecorator > > InArg &41;
[]
SRichTextBlock::FArguments::DecoratorStyleSet
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
The style set used for looking up styles used by decorators
Slate
WidgetArgsType & DecoratorStyleSet &40; const ISlateStyle &42; InArg &41;
[]
SRichTextBlock::FArguments::LineHeightPercentage
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
The amount to scale each lines height by.
Slate
WidgetArgsType & LineHeightPercentage &40; const TAttribute< float > & InAttribute &41;
[]
SRichTextBlock::FArguments::Marshaller
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
The marshaller used to get/set the raw text to/from the text layout.
Slate
WidgetArgsType & Marshaller &40; TSharedPtr< class FRichTextLayoutMarshaller > InArg &41;
[]
SRichTextBlock::FArguments::Margin
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
The amount of blank space left around the edges of text area.
Slate
WidgetArgsType & Margin &40; const TAttribute< FMargin > & InAttribute &41;
[]
SRichTextBlock::FArguments::MinDesiredWidth
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Minimum width that this text block should be
Slate
WidgetArgsType & MinDesiredWidth &40; const TAttribute< float > & InAttribute &41;
[]
SRichTextBlock::FArguments::operator+
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Slate
SRichTextBlock::FArguments & operator&43; &40; const TSharedRef< ITextDecorator > & DecoratorToAdd &41;
[]
SRichTextBlock::FArguments::OverflowPolicy
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Determines what happens to text that is clipped and doesn't fit within the clip rect for this widget
Slate
WidgetArgsType & OverflowPolicy &40; TOptional< ETextOverflowPolicy > InArg &41;
[]
SRichTextBlock::FArguments::Parser
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
The parser used to resolve any markup used in the provided string.
Slate
WidgetArgsType & Parser &40; TSharedPtr< class IRichTextMarkupParser > InArg &41;
[]
SRichTextBlock::FArguments::Text
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
The text displayed in this text block
Slate
WidgetArgsType & Text &40; const TAttribute< FText > & InAttribute &41;
[]
SRichTextBlock::FArguments::TextFlowDirection
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Which text flow direction should we use? (unset to use the default returned by GetDefaultTextFlowDirection)
Slate
WidgetArgsType & TextFlowDirection &40; TOptional< ETextFlowDirection > InArg &41;
[]
SRichTextBlock::FArguments::TextShapingMethod
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Which text shaping method should we use? (unset to use the default returned by GetDefaultTextShapingMethod)
Slate
WidgetArgsType & TextShapingMethod &40; TOptional< ETextShapingMethod > InArg &41;
[]
SRichTextBlock::FArguments::TextStyle
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
The style of the text block, which dictates the default font, color, and shadow options.
Slate
WidgetArgsType & TextStyle &40; const FTextBlockStyle &42; InArg &41;
[]
SRichTextBlock::FArguments::TransformPolicy
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
The transform policy to use
Slate
WidgetArgsType & TransformPolicy &40; const TAttribute< ETextTransformPolicy > & InAttribute &41;
[]
WidgetArgsType
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Slate
typedef FArguments WidgetArgsType
[]
SRichTextBlock::FArguments::WrappingPolicy
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
The wrapping policy to use
Slate
WidgetArgsType & WrappingPolicy &40; const TAttribute< ETextWrappingPolicy > & InAttribute &41;
[]
SRichTextBlock::FArguments::WrapTextAt
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Whether text wraps onto a new line when it's length exceeds this width; if this value is zero or negative, no wrapping occurs.
Slate
WidgetArgsType & WrapTextAt &40; const TAttribute< float > & InAttribute &41;
[]
SRichTextBlock::FArguments::FArguments
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Slate
FArguments&40;&41;
[]
FArguments
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Slate
struct FArguments : public [TSlateBaseNamedArgs< SRichTextBlock >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)
[ { "type": "TArray<TShared...", "name": "InlineDecorators", "description": "Additional decorators can be append to the widget inline." } ]
SRichTextBlock::GetChildren
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Should be renamed to GetVisibleChildren (not ALL children will be returned in all cases).
Slate
virtual [FChildren](API\Runtime\SlateCore\Layout\FChildren) * GetChildren()
[]
SRichTextBlock::GetText
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Gets the text assigned to this text block
Slate
const [FText](API\Runtime\Core\Internationalization\FText) & GetText() const
[]
SRichTextBlock::HyperlinkDecorator
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Slate
static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ITextDecorator](API\Runtime\Slate\Framework\Text\ITextDecorator) > HyperlinkDecorator ( const [FString](API\Runtime\Core\Containers\FString) Id, const [FSlateHyperlinkRun::FOnClick](API\Runtime\Slate\Framework\Text\FSlateHyperlinkRun\FOnClick) & NavigateDelegate )
[]
SRichTextBlock::HyperlinkDecorator
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Slate
template<class UserClass> static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ITextDecorator](API\Runtime\Slate\Framework\Text\ITextDecorator) > HyperlinkDecorator ( const [FString](API\Runtime\Core\Containers\FString) Id, UserClass * InUserObjectPtr, typename FSlateHyperlinkRun::FOnClick::TMethodPtr< UserClass > NavigateFunc )
[]
SRichTextBlock::OnArrangeChildren
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Compute the Geometry of all the children and add populate the ArrangedChildren list with their values. Each type of Layout panel should arrange children based on desired behavior.
Slate
virtual void OnArrangeChildren ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, [FArrangedChildren](API\Runtime\SlateCore\Layout\FArrangedChildren) & ArrangedChildren ) const
[]
SRichTextBlock::OnPaint
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children. Called by the non-virtual OnPaint to enforce pre/post conditions during OnPaint. The maximum layer ID attained by this widget or any of its children.
Slate
virtual int32 OnPaint ( const [FPaintArgs](API\Runtime\SlateCore\Types\FPaintArgs) & Args, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const [FSlateRect](API\Runtime\SlateCore\Layout\FSlateRect) & MyCullingRect, [FSlateWindowElementList](API\Runtime\SlateCore\Rendering\FSlateWindowElementList) & OutDrawElements, int32 LayerId, const [FWidgetStyle](API\Runtime\SlateCore\Styling\FWidgetStyle) & InWidgetStyle, bool bParentEnabled ) const
[]
SRichTextBlock::ImageDecorator
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Slate
static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ITextDecorator](API\Runtime\Slate\Framework\Text\ITextDecorator) > ImageDecorator ( [FString](API\Runtime\Core\Containers\FString) RunName, const [ISlateStyle](API\Runtime\SlateCore\Styling\ISlateStyle) *const OverrideStyle )
[]
SRichTextBlock::Refresh
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Causes the text to reflow it's layout
Slate
void Refresh()
[]
SRichTextBlock::SetAutoWrapText
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
See AutoWrapText attribute
Slate
void SetAutoWrapText ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > & InAutoWrapText )
[]
SRichTextBlock::SetDecorators
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Replaces the decorators for this text block
Slate
void SetDecorators ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ITextDecorator](API\Runtime\Slate\Framework\Text\ITextDecorator) >> InDecorators )
[]
SRichTextBlock::SetDecoratorStyleSet
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Slate
void SetDecoratorStyleSet ( const [ISlateStyle](API\Runtime\SlateCore\Styling\ISlateStyle) * NewDecoratorStyleSet )
[]
SRichTextBlock::SetHighlightText
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
See HighlightText attribute
Slate
void SetHighlightText ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InHighlightText )
[]
SRichTextBlock::SetJustification
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
See Justification attribute
Slate
void SetJustification ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [ETextJustify::Type](API\Runtime\Slate\Framework\Text\ETextJustify__Type) > & InJustification )
[]
SRichTextBlock::SetMargin
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
See Margin attribute
Slate
void SetMargin ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FMargin](API\Runtime\SlateCore\Layout\FMargin) > & InMargin )
[]
SRichTextBlock::SetLineHeightPercentage
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
See LineHeightPercentage attribute
Slate
void SetLineHeightPercentage ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< float > & InLineHeightPercentage )
[]
SRichTextBlock::SetMinDesiredWidth
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
See MinDesiredWidth attribute
Slate
void SetMinDesiredWidth ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< float > & InMinDesiredWidth )
[]
SRichTextBlock::SetOverflowPolicy
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Sets the overflow policy for this text block
Slate
void SetOverflowPolicy ( [TOptional](API\Runtime\Core\IO\TOptional)< ETextOverflowPolicy > InOverflowPolicy )
[]
SRichTextBlock::SetTextFlowDirection
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
See TextFlowDirection attribute
Slate
void SetTextFlowDirection ( const [TOptional](API\Runtime\Core\IO\TOptional)< ETextFlowDirection > & InTextFlowDirection )
[]
SRichTextBlock::SetTextBlockScale
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Set the scale value at the TextLayout
Slate
void SetTextBlockScale ( const float NewTextBlockScale )
[]
SRichTextBlock::SetText
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Sets the text for this text block
Slate
void SetText ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InTextAttr )
[]
SRichTextBlock::SetTextShapingMethod
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
See TextShapingMethod attribute
Slate
void SetTextShapingMethod ( const [TOptional](API\Runtime\Core\IO\TOptional)< ETextShapingMethod > & InTextShapingMethod )
[]
SRichTextBlock::SetTransformPolicy
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Set TransformPolicy attribute
Slate
void SetTransformPolicy ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< ETextTransformPolicy > & InTransformPolicy )
[]
SRichTextBlock::SetTextStyle
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
See TextStyle argument
Slate
void SetTextStyle ( const [FTextBlockStyle](API\Runtime\SlateCore\Styling\FTextBlockStyle) & InTextStyle )
[]
SRichTextBlock::SetWrappingPolicy
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Set WrappingPolicy attribute
Slate
void SetWrappingPolicy ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< ETextWrappingPolicy > & InWrappingPolicy )
[]
SRichTextBlock::SetWrapTextAt
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
See WrapTextAt attribute
Slate
void SetWrapTextAt ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< float > & InWrapTextAt )
[]
SRichTextBlock::WidgetDecorator
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Slate
static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ITextDecorator](API\Runtime\Slate\Framework\Text\ITextDecorator) > WidgetDecorator ( const [FString](API\Runtime\Core\Containers\FString) RunName, const [FWidgetDecorator::FCreateWidget](API\Runtime\Slate\Framework\Text\FWidgetDecorator\FCreateWidget) & FactoryDelegate )
[]
SRichTextBlock::WidgetDecorator
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Slate
template<class UserClass> static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ITextDecorator](API\Runtime\Slate\Framework\Text\ITextDecorator) > WidgetDecorator ( const [FString](API\Runtime\Core\Containers\FString) RunName, UserClass * InUserObjectPtr, typename FWidgetDecorator::FCreateWidget::TConstMethodPtr< UserClass > InFunc )
[]
SRichTextBlock::SRichTextBlock
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Constructor
Slate
SRichTextBlock()
[]
SRichTextBlock
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
A rich static text widget. Through the use of markup and text decorators, text with different styles, embedded image and widgets can be achieved.
Slate
class SRichTextBlock : public [SWidget](API\Runtime\SlateCore\Widgets\SWidget)
[]
STextBlock::ComputeDesiredSize
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
LeafWidgets should compute their DesiredSize based solely on their visual representation. There is no need to take child widgets into account as LeafWidgets have none by definition. For example, the TextBlock widget simply measures the area necessary to display its text with the given font and font size.
Slate
virtual FVector2D ComputeDesiredSize ( float ) const
[]
SRichTextBlock::~SRichTextBlock
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Destructor
Slate
~SRichTextBlock()
[]
STextBlock::Construct
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
Construct this widget
Slate
void Construct ( const [FArguments](API\Runtime\Slate\Widgets\Text\STextBlock\FArguments) & InArgs )
[]
STextBlock::CreateAccessibleWidget
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
Slate
virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< FSlateAccessibleWidget > CreateAccessibleWidget()
[]
STextBlock::FArguments::ColorAndOpacity
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
Text color and opacity
Slate
WidgetArgsType & ColorAndOpacity &40; const TAttribute< FSlateColor > & InAttribute &41;
[]
STextBlock::FArguments::AutoWrapText
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
Whether to wrap text automatically based on the widget's computed horizontal space. IMPORTANT: Using automatic wrapping can result in visual artifacts, as the the wrapped size will computed be at least one frame late! Consider using WrapTextAt instead. The initial desired size will not be clamped. This works best in cases where the text block's size is not affecting other widget's layout.
Slate
WidgetArgsType & AutoWrapText &40; const TAttribute< bool > & InAttribute &41;
[]
STextBlock::FArguments::HighlightColor
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
The color used to highlight the specified text
Slate
WidgetArgsType & HighlightColor &40; const TAttribute< FLinearColor > & InAttribute &41;
[]
STextBlock::FArguments::Font
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
Sets the font used to draw the text
Slate
WidgetArgsType & Font &40; const TAttribute< FSlateFontInfo > & InAttribute &41;
[]
STextBlock::FArguments::HighlightShape
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
The brush used to highlight the specified text
Slate
WidgetArgsType & HighlightShape &40; const TAttribute< const FSlateBrush &42; > & InAttribute &41;
[]
STextBlock::FArguments::HighlightText
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
Highlight this text in the text block
Slate
WidgetArgsType & HighlightText &40; const TAttribute< FText > & InAttribute &41;
[]
STextBlock::FArguments::Justification
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
How the text should be aligned with the margin.
Slate
WidgetArgsType & Justification &40; const TAttribute< ETextJustify::Type > & InAttribute &41;
[]
STextBlock::FArguments::LineBreakPolicy
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
The iterator to use to detect appropriate soft-wrapping points for lines (or null to use the default)
Slate
WidgetArgsType & LineBreakPolicy &40; TSharedPtr< IBreakIterator > InArg &41;
[]
STextBlock::FArguments::Margin
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
The amount of blank space left around the edges of text area.
Slate
WidgetArgsType & Margin &40; const TAttribute< FMargin > & InAttribute &41;
[]
STextBlock::FArguments::LineHeightPercentage
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
The amount to scale each lines height by.
Slate
WidgetArgsType & LineHeightPercentage &40; const TAttribute< float > & InAttribute &41;
[]
STextBlock::FArguments::MinDesiredWidth
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
Minimum width that a text block should be
Slate
WidgetArgsType & MinDesiredWidth &40; const TAttribute< float > & InAttribute &41;
[]
STextBlock::FArguments::OnDoubleClicked
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
Called when this text is double clicked
Slate
WidgetArgsType & OnDoubleClicked &40; const FPointerEventHandler & InDelegate &41;
[]
STextBlock::FArguments::ShadowOffset
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
Drop shadow offset in pixels
Slate
WidgetArgsType & ShadowOffset &40; const TAttribute< FVector2D > & InAttribute &41;
[]
STextBlock::FArguments::OverflowPolicy
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
Determines what happens to text that is clipped and doesn't fit within the clip rect for this widget
Slate
WidgetArgsType & OverflowPolicy &40; TOptional< ETextOverflowPolicy > InArg &41;
[]
STextBlock::FArguments::ShadowColorAndOpacity
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
Shadow color and opacity
Slate
WidgetArgsType & ShadowColorAndOpacity &40; const TAttribute< FLinearColor > & InAttribute &41;
[]
STextBlock::FArguments::StrikeBrush
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
Sets the brush used to strike through the text
Slate
WidgetArgsType & StrikeBrush &40; const TAttribute< const FSlateBrush &42; > & InAttribute &41;
[]
STextBlock::FArguments::SimpleTextMode
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
If this is enabled, text shaping, wrapping, justification are disabled in favor of much faster text layout and measurement. This feature is suitable for numbers and text that changes often and impact performance. Enabling this setting may cause certain languages (such as Right to left languages) to not display properly.
Slate
WidgetArgsType & SimpleTextMode &40; bool InArg &41;
[]
STextBlock::FArguments::TextFlowDirection
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
Which text flow direction should we use? (unset to use the default returned by GetDefaultTextFlowDirection)
Slate
WidgetArgsType & TextFlowDirection &40; TOptional< ETextFlowDirection > InArg &41;
[]
STextBlock::FArguments::TextShapingMethod
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
Which text shaping method should we use? (unset to use the default returned by GetDefaultTextShapingMethod)
Slate
WidgetArgsType & TextShapingMethod &40; TOptional< ETextShapingMethod > InArg &41;
[]
STextBlock::FArguments::Text
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
The text displayed in this text block
Slate
WidgetArgsType & Text &40; const TAttribute< FText > & InAttribute &41;
[]
STextBlock::FArguments::TextStyle
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
Pointer to a style of the text block, which dictates the font, color, and shadow options.
Slate
WidgetArgsType & TextStyle &40; const FTextBlockStyle &42; InArg &41;
[]
STextBlock::FArguments::TransformPolicy
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
The transform policy to use
Slate
WidgetArgsType & TransformPolicy &40; const TAttribute< ETextTransformPolicy > & InAttribute &41;
[]
WidgetArgsType
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
Slate
typedef FArguments WidgetArgsType
[]
STextBlock::FArguments::WrappingPolicy
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
The wrapping policy to use
Slate
WidgetArgsType & WrappingPolicy &40; const TAttribute< ETextWrappingPolicy > & InAttribute &41;
[]
STextBlock::FArguments::WrapTextAt
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
Whether text wraps onto a new line when it's length exceeds this width; if this value is zero or negative, no wrapping occurs.
Slate
WidgetArgsType & WrapTextAt &40; const TAttribute< float > & InAttribute &41;
[]
FArguments
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
Slate
struct FArguments : public [TSlateBaseNamedArgs< STextBlock >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)
[]
STextBlock::FArguments::FArguments
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
Slate
FArguments&40;&41;
[]
STextBlock::GetColorAndOpacity
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
Gets the current foreground color
Slate
[FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) GetColorAndOpacity() const
[]
STextBlock::GetColorAndOpacityRef
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
Gets the current foreground color as ref
Slate
const [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) & GetColorAndOpacityRef() const
[]
STextBlock::GetDefaultAccessibleText
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
Assign AccessibleText with a default value that can be used when AccessibleBehavior is set to Auto or Custom.
Slate
virtual [TOptional](API\Runtime\Core\IO\TOptional)< [FText](API\Runtime\Core\Internationalization\FText) > GetDefaultAccessibleText ( EAccessibleType AccessibleType ) const
[]
STextBlock::GetFont
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
Gets the current font
Slate
[FSlateFontInfo](API\Runtime\SlateCore\Fonts\FSlateFontInfo) GetFont() const
[]
STextBlock::GetFontRef
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
Gets the current font as ref
Slate
const [FSlateFontInfo](API\Runtime\SlateCore\Fonts\FSlateFontInfo) & GetFontRef() const
[]
STextBlock::GetHighlightColor
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
Gets the current highlight color
Slate
[FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) GetHighlightColor() const
[]
STextBlock::GetHighlightShape
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
Gets the current highlight shape
Slate
const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * GetHighlightShape() const
[]
STextBlock::GetMinDesiredWidth
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
Gets the current min desired width
Slate
float GetMinDesiredWidth() const
[]
STextBlock::GetMargin
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
Gets the current margin
Slate
[FMargin](API\Runtime\SlateCore\Layout\FMargin) GetMargin() const
[]
STextBlock::GetShadowColorAndOpacity
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
Gets the current shadow color and opacity
Slate
[FLinearColor](API\Runtime\Core\Math\FLinearColor) GetShadowColorAndOpacity() const
[]
STextBlock::GetShadowColorAndOpacityRef
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
Gets the current shadow color and opacity as ref
Slate
const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & GetShadowColorAndOpacityRef() const
[]