1. Epic GamesDeveloper
  3. Text

Text

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

Filters

Classes

  Type Name Description
Public class FBaseTextLayoutMarshaller Copyright Epic Games, Inc. All Rights Reserved.  
Public struct FCachedShapedTextKey Information representing a piece of shaped text  
Public struct UStruct FCharRange Represents a range of characters, specified by the Unicode code point of the first and last characters in the range, both included.  
Public struct UStruct FCharRangeList Represents a list of character ranges.  
Public class FDefaultLayoutBlock Copyright Epic Games, Inc. All Rights Reserved.  
Public class FDefaultRichTextMarkupParser Copyright Epic Games, Inc. All Rights Reserved.  
Public class FDefaultRichTextMarkupWriter    
Public class FGenericPlatformTextField    
Public class FHyperlinkDecorator    
Public class FImageDecorator    
Public struct FLayoutBlockTextContext The context needed when creating a block from a run of a text  
Public class FPlainTextLayoutMarshaller Get/set the raw text to/from a text layout as plain text  
Public class FRichTextLayoutMarshaller Get/set the raw text to/from a text layout as rich text  
Public class FRichTextSyntaxHighlighterTextLayoutMarshaller Get/set the raw text to/from a text layout, and also inject syntax highlighting for our rich-text markup  
Public struct FRunInfo    
Public struct FRunTextContext The context needed when performing text operations on a run of text  
Public class FShapedTextCache Cache of shaped text  
Public struct FShapedTextContext The basic data needed when shaping a run of text  
Public class FSlateHyperlinkRun    
Public class FSlateImageRun    
Public class FSlatePasswordRun    
Public class FSlateTextHighlightRunRenderer    
Public class FSlateTextLayout    
Public class FSlateTextRun    
Public class FSlateTextStrikeLineHighlighter Run highlighter used to draw strikes  
Public class FSlateTextUnderlineLineHighlighter Run highlighter used to draw underlines  
Public class FSlateWidgetRun    
Public class FSyntaxHighlighterTextLayoutMarshaller Get/set the raw text to/from a text layout, and also inject syntax highlighting  
Public class FSyntaxTokenizer Tokenize the text based upon the given rule set  
Public struct FTextArgs    
Public class FTextLayout    
Public struct FTextLineHighlight    
Public struct FTextLineParseResults    
Public struct FTextLocation Location within the text model.  
Public struct FTextRunInfo    
Public struct FTextRunParseResults    
Public struct FTextRunRenderer    
Public class FTextSelection    
Public class FWidgetDecorator    
Public class FWidgetLayoutBlock Copyright Epic Games, Inc. All Rights Reserved.  
Public class ILayoutBlock Copyright Epic Games, Inc. All Rights Reserved.  
Public class ILineHighlighter Copyright Epic Games, Inc. All Rights Reserved.  
Public class IRichTextMarkupParser Copyright Epic Games, Inc. All Rights Reserved.  
Public class IRichTextMarkupWriter Copyright Epic Games, Inc. All Rights Reserved.  
Public class IRun    
Public class IRunRenderer Copyright Epic Games, Inc. All Rights Reserved.  
Public class ISlateLineHighlighter    
Public class ISlateRun    
Public class ISlateRunRenderer    
Public class ISlateTextLineHighlighter Run highlighter used to draw lines  
Public class ISyntaxTokenizer Copyright Epic Games, Inc. All Rights Reserved.  
Public class ITextDecorator    
Public class ITextLayoutMarshaller Interface used to get/set the raw text to/from a text layout  

Typedefs

Name Description
FCreateSlateTextLayout  
FPlatformTextField  
FShapedTextCachePtr  
FShapedTextCacheRef  

Enums

  Type Name Description
Public enum ERunAttributes Attributes that a run can have  
Public enum UEnum BlueprintType ETextFlowDirection The different directions that text can flow within a paragraph of text.  
Public enum ETextHitPoint Copyright Epic Games, Inc. All Rights Reserved.  
Public enum UEnum BlueprintType ETextJustify::Type    
Public enum UEnum BlueprintType ETextWrappingPolicy The different methods that can be used if a word is too long to be broken by the default line-break iterator.  

Functions

  Type Name Description
Public function    
Public function ETextFlowDirection Get the default text flow direction (from the "Slate.DefaultTextFlowDirection" CVar)
Public function FTextRange

RunUtils::CalculateOffsetMeasureRange ( const int32 InOffset,
const FTextRange& InTextRange,
const TextBiDi::ETextDirection InTextDirection
)

 Calculate the range that will measure to the given index, based on the given range and text direction
Public function ETextHitPoint

RunUtils::CalculateTextHitPoint ( const int32 InIndex,
const FTextRange& InTextRange,
const TextBiDi::ETextDirection InTextDirection
)

 Calculate the correct hit-point for the given index, based on the given range and text direction
Public function int32

ShapedTextCacheUtil::FindCharacterIndexAtOffset ( const FShapedTextCacheRef& InShapedTextCache,
const FCachedShapedTextKey& InRunKey,
const FTextRange& InTextRange,
const TCHAR* InText,
const int32 InHorizontalOffset
)

 Find the character index at the specified position in pixels along the string horizontally
Public function int8

ShapedTextCacheUtil::GetShapedGlyphKerning ( const FShapedTextCacheRef& InShapedTextCache,
const FCachedShapedTextKey& InRunKey,
const int32 InGlyphIndex,
const TCHAR* InText
)

 Get the kerning between two shaped glyphs
Public function FShapedGlyphSequenceRef

ShapedTextCacheUtil::GetShapedTextSubSequence ( const FShapedTextCacheRef& InShapedTextCache,
const FCachedShapedTextKey& InRunKey,
const FTextRange& InTextRange,
const TCHAR* InText,
const TextBiDi::ETextDirection InTextDirection
)

 Extract a sub-section of a run of text into its own shaped glyph sequence
Public function FVector2D

ShapedTextCacheUtil::MeasureShapedText ( const FShapedTextCacheRef& InShapedTextCache,
const FCachedShapedTextKey& InRunKey,
const FTextRange& InMeasureRange,
const TCHAR* InText
)

 Measure a sub-section of a run of text
Public function void Copyright Epic Games, Inc. All Rights Reserved.
Public function void  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page