1. Epic GamesDeveloper
  3. STextBlock

STextBlock

A simple 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/STextBlock.h
Include #include "Widgets/Text/STextBlock.h"

Syntax

class STextBlock : public SLeafWidget

Remarks

A simple static text widget

Variables

  Type Name Description
Public variable uint16: 1 bIsAttributeBoundTextBound  
Public variable uint16: 1 bIsAttributeColorAndOpacitySet  
Public variable uint16: 1 bIsAttributeFontSet  
Public variable uint16: 1 bIsAttributeHighlightColorSet  
Public variable uint16: 1 bIsAttributeHighlightShapeSet  
Public variable uint16: 1 bIsAttributeShadowColorAndOpacitySet  
Public variable uint16: 1 bIsAttributeShadowOffsetSet  
Public variable uint16: 1 bIsAttributeStrikeBrushSet  
Public variable uint16: 1 bIsAttributeTransformPolicySet  
Public variable uint16: 1 bIsAttributeWrapTextAtSet  
Public variable uint16 Union_Flags  

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
)

 Construct this widget
Public function Const FSlateColor Gets the current foreground color
Public function Const const FSlateColor & Gets the current foreground color as ref
Public function Const FSlateFontInfo

GetFont ()

 Gets the current font
Public function Const const FSlateFontInfo & Gets the current font as ref
Public function Const FSlateColor Gets the current highlight color
Public function Const const FSlateBrush * Gets the current highlight shape
Public function Const FMargin Gets the current margin
Public function Const float Gets the current min desired width
Public function Const FLinearColor Gets the current shadow color and opacity
Public function Const const FLinearColor & Gets the current shadow color and opacity as ref
Public function Const FVector2f Gets the current shadow offset
Public function Const const FSlateBrush * Gets the current strike brush
Public function Const const FText &

GetText ()

 Gets the text assigned to this text block
Public function Const ETextTransformPolicy Get TransformPolicy attribute
Public function void

SetAutoWrapText ( TAttribute< bool > InAutoWrapText
)

 See AutoWrapText attribute
Public function void

SetColorAndOpacity ( TAttribute< FSlateColor > InColorAndOpacity
)

 See ColorAndOpacity attribute
Public function void Sets the font used to draw the text
Public function void

SetHighlightColor ( TAttribute< FLinearColor > InHighlightColor
)

 See HighlightColor attribute
Public function void

SetHighlightShape ( TAttribute< const FSlateBrush* > InHighlightShape
)

 See HighlightShape attribute
Public function void Sets the highlight text for this text block
Public function void See Justification attribute
Public function void

SetLineHeightPercentage ( TAttribute< float > InLineHeightPercentage
)

 See LineHeightPercentage attribute
Public function void

SetMargin ( TAttribute< FMargin > InMargin
)

 See Margin attribute
Public function void

SetMinDesiredWidth ( TAttribute< float > InMinDesiredWidth
)

 See MinDesiredWidth attribute
Public function void

SetOverflowPolicy ( TOptional< ETextOverflowPolicy > InOverflowPolicy
)

 Sets the overflow policy for this text block
Public function void

SetShadowColorAndOpacity ( TAttribute< FLinearColor > InShadowColorAndOpacity
)

 See ShadowColorAndOpacity attribute
Public function void

SetShadowOffset ( TAttribute< FVector2D > InShadowOffset
)

 See ShadowOffset attribute
Public function void

SetStrikeBrush ( TAttribute< const FSlateBrush* > InStrikeBrush
)

 Sets the brush used to strike through the text
Public function void

SetText ( TAttribute< FText > InText
)

 Sets the text for this text block
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 ( TAttribute< ETextTransformPolicy > InTransformPolicy
)

 Set TransformPolicy attribute
Public function void

SetWrappingPolicy ( TAttribute< ETextWrappingPolicy > InWrappingPolicy
)

 Set WrappingPolicy attribute
Public function void

SetWrapTextAt ( TAttribute< float > InWrapTextAt
)

 See WrapTextAt attribute
Public function Static const FSlateWidgetClassData &  

Overridden from SWidget

  Type Name Description
Public function Virtual Const FVector2D

ComputeDesiredSize ( float
)

 Overwritten from SWidget.
Public function Virtual TSharedRef< FSlateAccessibleWidget >  
Public function Virtual Const TOptional< FText >

GetDefaultAccessibleText ( EAccessibleType AccessibleType
)

 Assign AccessibleText with a default value that can be used when AccessibleBehavior is set to Auto or Custom.
Public function Virtual Const int32

OnPaint ( const FPaintArgs& Args,
const FGeometry& AllottedGeometry,
const FSlateRect& MyCullingRect,
FSlateWindowElementList& OutDrawElements,
int32 LayerId,
const FWidgetStyle& InWidgetStyle,
bool bParentEnabled
)

 Overwritten from SWidget.

Overridden from FSlateControlledConstruction

  Type Name Description
Public function Virtual Const const FSlateWidgetClassData &  

Classes

  Type Name Description
Public struct FArguments    

Typedefs

Name Description
PrivateParentType  
PrivateThisType  
Super  
ThisClass  

Deprecated Functions

  Type Name Description
Public function Const ETextTransformPolicy GetTransformPolicy is not accessible anymore since it's attribute value may not have been updated yet.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page