1. Epic GamesDeveloper
  3. FTextLayout

FTextLayout

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Framework > API/Runtime/Slate/Framework/Text

Inheritance Hierarchy

References

   
Module Slate
Header /Engine/Source/Runtime/Slate/Public/Framework/Text/TextLayout.h
Include #include "Framework/Text/TextLayout.h"

Syntax

class FTextLayout : public TSharedFromThis< FTextLayout >

Variables

  Type Name Description
Protected variable bool ApplyLineHeightToBottomLine Whether or not line height should be applied to the last line.
Protected variable int32 CachedLayoutGeneration  
Protected variable TAttribute< FString > DebugSourceInfo Information given to use by our an external source (typically our owner widget) to help identify who owns this text layout in the case of an error
Protected variable ETextLayoutDirtyState::Flags DirtyFlags Whether parameters on the layout have changed which requires the view be updated.
Protected variable TSharedRef< IBreakIterator > GraphemeBreakIterator The iterator to use to detect grapheme cluster boundaries
Protected variable ETextJustify::Type Justification How the text should be aligned with the margin.
Protected variable TSharedPtr< IBreakIterator > LineBreakIterator The iterator to use to detect appropriate soft-wrapping points for lines
Protected variable float LineHeightPercentage The percentage to modify a line height by.
Protected variable TArray< FLineModel > LineModels The models for the lines of text. A LineModel represents a single string with no manual breaks.
Protected variable TArray< FLineView > LineViews The views for the lines of text.
Protected variable TSet< int32 > LineViewsToJustify The indices for all of the line views that require justification.
Protected variable FMargin Margin The size of the margins to put about the text. This is an unscaled value.
Protected variable float OverHeight Extra height of the last line due to line height.
Protected variable float Scale The scale to draw the text at
Protected variable FVector2D ScrollOffset The scroll offset of the text layout from the parent widget
Protected variable TUniquePtr< TextBiDi::ITextBiDi > TextBiDiDetection Unicode BiDi text detection
Protected variable ETextFlowDirection TextFlowDirection How should the text within this layout be flowed?
Protected variable FTextLayoutSize TextLayoutSize The final size of the text layout on screen.
Protected variable TOptional< ETextOverflowPolicy > TextOverflowPolicyOverride Override for the text overflow policy. If unset, the style is used
Protected variable ETextShapingMethod TextShapingMethod The method used to shape the text within this layout
Protected variable ETextTransformPolicy TransformPolicy The transform policy used by this text layout.
Protected variable FVector2D ViewSize The size of the text layout that can actually be seen from the parent widget
Protected variable TSharedRef< IBreakIterator > WordBreakIterator The iterator to use to detect word boundaries
Protected variable ETextWrappingPolicy WrappingPolicy The wrapping policy used by this text layout.
Protected variable float WrappingWidth The width that the text should be wrap at. If 0 or negative no wrapping occurs.

Constructors

  Type Name Description
Protected function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

AddLine ( const FNewLineData& NewLine
)

  
Public function void

AddLineHighlight ( const FTextLineHighlight& Highlight
)

 Adds a single line highlight to the existing set of highlights.
Public function void

AddLines ( const TArray< FNewLineData >& NewLines
)

  
Public function void

AddRunRenderer ( const FTextRunRenderer& Renderer
)

 Adds a single run renderer to the existing set of renderers.
Protected function Virtual void Notifies all Runs that we are beginning to generate a new layout.
Protected function void

BeginLineLayout ( FLineModel& LineModel
)

 Notifies all Runs on the given line is beginning to have a new layout generated.
Protected function Const void Calculates the text direction for the given line based upon the current shaping method and document flow direction
Protected function Const ETextJustify::Type Calculates the visual justification for the given line view
Protected function void Calculates the text direction for each line based upon the current shaping method and document flow direction When changing the shaping method, or document flow direction, all the lines need to be dirtied (see DirtyAllLineModels(ELineModelDirtyState::TextBaseDirection))
Public function void Clears all line highlights
Public function void  
Public function void Clears all run renderers
Protected function void Clears the current layouts view information.
Protected function Const TSharedRef< IRun >

CreateDefaultTextRun ( const TSharedRef< FString >& NewText,
const FTextRange& NewRange
)

 Called to generate a new empty text run for this text layout
Protected function void Create the wrapping cache for the given line based upon the current scale
Protected function void Create the wrapping cache for the current text based upon the current scale Each line keeps its own cached state, so needs to be cleared when changing the text within a line When changing the scale, all the lines need to be cleared (see DirtyAllLineModels(ELineModelDirtyState::WrappingInformation))
Protected function void Set the given dirty flags on all line models in this layout
Public function void  
Public function void
DirtyRunLayout

( const TSharedRef< const IRun >& Run
)

  
Protected function Virtual void Notifies all Runs that the layout has finished generating.
Protected function void

EndLineLayout ( FLineModel& LineModel
)

 Notifies all Runs on the given line has finished having a new layout generated.
Protected function void Flushes the text shaping cache for the given line
Protected function void Flushes the text shaping cache for each line
Public function Const bool  
Public function Const void

GetAsText ( FText& DisplayText,
FTextOffsetLocations*const OutTextOffsetLocations
)

  
Public function Const void

GetAsText ( FString& DisplayText,
FTextOffsetLocations*const OutTextOffsetLocations
)

  
Public function Const FVector2D Get the size of the text layout, including any lines which extend beyond the wrapping boundaries (eg, lines with lots of trailing whitespace, or lines with no break candidates)
Public function Const FTextSelection

GetGraphemeAt ( const FTextLocation& Location
)

  
Public function Const ETextJustify::Type  
Public function Const int32  
Public function Const float  
Public function Const const TArray< FTextLayout::FLineModel > &  
Public function Const int32

GetLineViewIndexForTextLocation ( const TArray< FTextLayout::FLineView >& LineViews,
const FTextLocation& Location,
const bool bPerformInclusiveBoundsCheck
)

  
Public function Const const TArray< FTextLayout::FLineView > &  
Public function Const FVector2D

GetLocationAt ( const FTextLocation& Location,
const bool bPerformInclusiveBoundsCheck
)

  
Public function Const FMargin  
Public function Const float  
Public function Const void

GetSelectionAsText ( FString& DisplayText,
const FTextSelection& Selection
)

  
Public function Const FVector2D

GetSize ()

 Get the size of the text layout, including any lines which extend beyond the wrapping boundaries (eg, lines with lots of trailing whitespace, or lines with no break candidates)
Public function Const ETextFlowDirection  
Public function Const FTextLocation

GetTextLocationAt ( const FLineView& LineView,
const FVector2D& Relative,
ETextHitPoint*const OutHitPoint
)

  
Public function Const FTextLocation

GetTextLocationAt ( const FVector2D& Relative,
ETextHitPoint*const OutHitPoint
)

  
Public function Const void

GetTextOffsetLocations ( FTextOffsetLocations& OutTextOffsetLocations
)

 Constructs an array containing the mappings between the text that would be returned by GetAsText, and the internal FTextLocation points used within this text layout
Public function Const ETextShapingMethod  
Public function Const ETextTransformPolicy This option is destructive to the model text, so changing it requires refreshing the text layout from its marshaller
Public function Const FVector2D Get the size of the text layout that can actually be seen from the parent widget
Public function Const ETextJustify::Type Get the visual justification for this document (based on the visual justification used by the first line of text)
Public function Const FTextSelection

GetWordAt ( const FTextLocation& Location
)

  
Public function Const FVector2D Get the size of the text layout after the text has been wrapped, and including the first piece of trailing whitespace for any given soft-wrapped line
Public function Const FVector2D Get the size of the text layout after the text has been wrapped, and including the first piece of trailing whitespace for any given soft-wrapped line
Public function Const ETextWrappingPolicy  
Public function Const float  
Public function bool

InsertAt ( const FTextLocation& Location,
TCHAR Character
)

  
Public function bool

InsertAt ( const FTextLocation& Location,
const FString& Text
)

  
Public function bool

InsertAt ( const FTextLocation& Location,
TSharedRef< IRun > InRun,
const bool bAlwaysKeepRightRun
)

  
Public function Const bool

IsEmpty ()

  
Public function Const bool  
Public function bool

JoinLineWithNextLine ( int32 LineIndex
)

  
Public function bool

RemoveAt ( const FTextLocation& Location,
int32 Count
)

  
Public function bool

RemoveLine ( int32 LineIndex
)

  
Public function void Removes a single line highlight to the existing set of highlights.
Public function void

RemoveRunRenderer ( const FTextRunRenderer& Renderer
)

 Removes a single run renderer to the existing set of renderers.
Public function void  
Public function void

SetDebugSourceInfo ( const TAttribute< FString >& InDebugSourceInfo
)

 Set the information used to help identify who owns this text layout in the case of an error
Public function void  
Public function void

SetLineBreakIterator ( TSharedPtr< IBreakIterator > InLineBreakIterator
)

 Set the iterator to use to detect appropriate soft-wrapping points for lines (or null to go back to using the default)
Public function void

SetLineHeightPercentage ( float Value
)

  
Public function void

SetLineHighlights ( const TArray< FTextLineHighlight >& Highlights
)

 Replaces the current set of line highlights with the provided highlights.
Public function void

SetMargin ( const FMargin& InMargin
)

  
Public function void

SetRunRenderers ( const TArray< FTextRunRenderer >& Renderers
)

 Replaces the current set of run renderers with the provided renderers.
Public function void

SetScale ( float Value
)

  
Public function void

SetTextFlowDirection ( const ETextFlowDirection InTextFlowDirection
)

  
Public function void

SetTextOverflowPolicy ( const TOptional< ETextOverflowPolicy > InTextOverflowPolicy
)

  
Public function void

SetTextShapingMethod ( const ETextShapingMethod InTextShapingMethod
)

  
Public function void  
Public function void

SetVisibleRegion ( const FVector2D& InViewSize,
const FVector2D& InScrollOffset
)

  
Public function void  
Public function void

SetWrappingWidth ( float Value
)

  
Public function bool

SplitLineAt ( const FTextLocation& Location
)

  
Protected function Const void

TransformLineText ( FLineModel& LineModel
)

 Transform the given line model text based on the active transform policy.
Public function Virtual void  
Public function Virtual void Updates the TextLayout's if any changes have occurred since the last update.
Public function Virtual void  

Classes

  Type Name Description
Public struct ELineModelDirtyState    
Protected struct ETextLayoutDirtyState    
Public struct FBlockDefinition    
Public struct FBreakCandidate    
Public struct FLineModel    
Public struct FLineView    
Public struct FLineViewHighlight    
Public struct FNewLineData    
Public class FRunModel    
Protected struct FTextLayoutSize    
Public struct FTextOffsetLocations A mapping between the offsets into the text as a flat string (with line-breaks), and the internal lines used within a text layout  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page