1. Epic GamesDeveloper
  3. SRichTextBlock

SRichTextBlock

A rich static text widget.

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Widgets > API/Runtime/Slate/Widgets/Text

Inheritance Hierarchy

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

  Type Name Description
Public function   Constructor

Destructors

  Type Name Description
Public function   Destructor

Functions

  Type Name Description
Public function void

Construct ( const FArguments& InArgs
)

  
Public function Static TSharedRef< ITextDecorator >

Decorator ( const TSharedRef< ITextDecorator >& Decorator
)

  
Public function Const const FText &

GetText ()

 Gets the text assigned to this text block
Public function Static TSharedRef< ITextDecorator >

HyperlinkDecorator ( const FString Id,
UserClass* InUserObjectPtr,
typename FSlateHyperlinkRun::FOnClick::TMethodPtr< UserClass > NavigateFunc
)

  
Public function Static TSharedRef< ITextDecorator >

HyperlinkDecorator ( const FString Id,
const FSlateHyperlinkRun::FOnClick& NavigateDelegate
)

  
Public function Static TSharedRef< ITextDecorator >

ImageDecorator ( FString RunName,
const ISlateStyle*const OverrideStyle
)

  
Public function void

Refresh ()

 Causes the text to reflow it's layout
Public function void

SetAutoWrapText ( const TAttribute< bool >& InAutoWrapText
)

 See AutoWrapText attribute
Public function void Replaces the decorators for this text block
Public function void

SetDecoratorStyleSet ( const ISlateStyle* NewDecoratorStyleSet
)

  
Public function void

SetHighlightText ( const TAttribute< FText >& InHighlightText
)

 See HighlightText attribute
Public function void

SetJustification ( const TAttribute< ETextJustify::Type >& InJustification
)

 See Justification attribute
Public function void

SetLineHeightPercentage ( const TAttribute< float >& InLineHeightPercentage
)

 See LineHeightPercentage attribute
Public function void

SetMargin ( const TAttribute< FMargin >& InMargin
)

 See Margin attribute
Public function void

SetMinDesiredWidth ( const TAttribute< float >& InMinDesiredWidth
)

 See MinDesiredWidth attribute
Public function void

SetOverflowPolicy ( TOptional< ETextOverflowPolicy > InOverflowPolicy
)

 Sets the overflow policy for this text block
Public function void

SetText ( const TAttribute< FText >& InTextAttr
)

 Sets the text for this text block
Public function void

SetTextBlockScale ( const float NewTextBlockScale
)

 Set the scale value at the TextLayout
Public function void

SetTextFlowDirection ( const TOptional< ETextFlowDirection >& InTextFlowDirection
)

 See TextFlowDirection attribute
Public function void

SetTextShapingMethod ( const TOptional< ETextShapingMethod >& InTextShapingMethod
)

 See TextShapingMethod attribute
Public function void

SetTextStyle ( const FTextBlockStyle& InTextStyle
)

 See TextStyle argument
Public function void

SetTransformPolicy ( const TAttribute< ETextTransformPolicy >& InTransformPolicy
)

 Set TransformPolicy attribute
Public function void

SetWrappingPolicy ( const TAttribute< ETextWrappingPolicy >& InWrappingPolicy
)

 Set WrappingPolicy attribute
Public function void

SetWrapTextAt ( const TAttribute< float >& InWrapTextAt
)

 See WrapTextAt attribute
Public function Static TSharedRef< ITextDecorator >

WidgetDecorator ( const FString RunName,
const FWidgetDecorator::FCreateWidget& FactoryDelegate
)

  
Public function Static TSharedRef< ITextDecorator >

WidgetDecorator ( const FString RunName,
UserClass* InUserObjectPtr,
typename FWidgetDecorator::FCreateWidget::TConstMethodPtr< UserClass > InFunc
)

  

Overridden from SWidget

  Type Name Description
Protected function Virtual Const FVector2D

ComputeDesiredSize ( float LayoutScaleMultiplier
)

 Compute the ideal size necessary to display this widget.
Protected function Virtual Const bool Recomputes the volatility of the widget.
Public function Virtual FChildren * Returns the useful children (if any) of this widget.
Public function Virtual Const void

OnArrangeChildren ( const FGeometry& AllottedGeometry,
FArrangedChildren& ArrangedChildren
)

 Compute the Geometry of all the children and add populate the ArrangedChildren list with their values.
Public function Virtual Const int32

OnPaint ( const FPaintArgs& Args,
const FGeometry& AllottedGeometry,
const FSlateRect& MyCullingRect,
FSlateWindowElementList& OutDrawElements,
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

  Type Name Description
Public struct FArguments    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page