SRichTextBlock

A rich static text widget.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FSlateControlledConstruction

TSharedFromThis

SWidget

SRichTextBlock

References

Module	Slate
Header	/Engine/Source/Runtime/Slate/Public/Widgets/Text/SRichTextBlock.h
Include	#include "Widgets/Text/SRichTextBlock.h"

Syntax

class SRichTextBlock : public SWidget

Remarks

A rich static text widget. Through the use of markup and text decorators, text with different styles, embedded image and widgets can be achieved.

Constructors

	Name	Description
	SRichTextBlock()	Constructor

Destructors

	Name	Description
	~SRichTextBlock()	Destructor

Functions

	Name	Description
void	Construct ( const FArguments& InArgs )
TSharedRef< ...	Decorator ( const TSharedRef< ITextDecorator > ... )
const FText ...	GetText()	Gets the text assigned to this text block
TSharedRef< ...	HyperlinkDecorator ( const FString Id, UserClass* InUserObjectPtr, typename FSlateHyperlinkRun::FOnCli... )
TSharedRef< ...	HyperlinkDecorator ( const FString Id, const FSlateHyperlinkRun::FOnClick ... )
TSharedRef< ...	ImageDecorator ( FString RunName, const ISlateStyle*const Overri... )
void	Refresh()	Causes the text to reflow it's layout
void	SetAutoWrapText ( const TAttribute< bool >& InAutoWr... )	See AutoWrapText attribute
void	SetDecoratorStyleSet ( const ISlateStyle* NewDecorato... )
void	SetHighlightText ( const TAttribute< FText >& InHighl... )	See HighlightText attribute
void	SetJustification ( const TAttribute< ETextJustify::Typ... )	See Justification attribute
void	SetLineHeightPercentage ( const TAttribute< float >& InLineH... )	See LineHeightPercentage attribute
void	SetMargin ( const TAttribute< FMargin >& InMar... )	See Margin attribute
void	SetMinDesiredWidth ( const TAttribute< float >& InMinDe... )	See MinDesiredWidth attribute
void	SetOverflowPolicy ( TOptional< ETextOverflowPolicy > In... )	Sets the overflow policy for this text block
void	SetText ( const TAttribute< FText >& InTextA... )	Sets the text for this text block
void	SetTextBlockScale ( const float NewTextBlockScale )	Set the scale value at the TextLayout
void	SetTextFlowDirection ( const TOptional< ETextFlowDirection... )	See TextFlowDirection attribute
void	SetTextShapingMethod ( const TOptional< ETextShapingMethod... )	See TextShapingMethod attribute
void	SetTextStyle ( const FTextBlockStyle& InTextStyle )	See TextStyle argument
void	SetTransformPolicy ( const TAttribute< ETextTransformPol... )	Set TransformPolicy attribute
void	SetWrappingPolicy ( const TAttribute< ETextWrappingPoli... )	Set WrappingPolicy attribute
void	SetWrapTextAt ( const TAttribute< float >& InWrapT... )	See WrapTextAt attribute
TSharedRef< ...	WidgetDecorator ( const FString RunName, const FWidgetDecorator::FCreateWidg... )
TSharedRef< ...	WidgetDecorator ( const FString RunName, UserClass* InUserObjectPtr, typename FWidgetDecorator::FCreateW... )

Overridden from SWidget

	Name	Description
FVector2D	ComputeDesiredSize ( float LayoutScaleMultiplier )	Compute the ideal size necessary to display this widget.
bool	ComputeVolatility()	Recomputes the volatility of the widget.
FChildren &#...	GetChildren()	Returns the useful children (if any) of this widget.
void	OnArrangeChildren ( const FGeometry& AllottedGeometry, FArrangedChildren& ArrangedChildre... )	Compute the Geometry of all the children and add populate the ArrangedChildren list with their values.
int32	OnPaint ( const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawEl..., int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled )	The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children.

Classes

	Name	Description
	FArguments