UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
IRun Class Referenceabstract

#include <IRun.h>

+ Inheritance diagram for IRun:

Public Member Functions

virtual ~IRun ()
 
virtual FTextRange GetTextRange () const =0
 
virtual void SetTextRange (const FTextRange &Value)=0
 
virtual int16 GetBaseLine (float Scale) const =0
 
virtual int16 GetMaxHeight (float Scale) const =0
 
virtual FVector2D Measure (int32 StartIndex, int32 EndIndex, float Scale, const FRunTextContext &TextContext) const =0
 
virtual int8 GetKerning (int32 CurrentIndex, float Scale, const FRunTextContext &TextContext) const =0
 
virtual FVector2D GetOutlineSize (int32 StartIndex, int32 EndIndex, float Scale) const
 
virtual FVector2D GetShadowSize (int32 StartIndex, int32 EndIndex, float Scale) const
 
virtual TSharedRef< class ILayoutBlockCreateBlock (int32 StartIndex, int32 EndIndex, FVector2D Size, const FLayoutBlockTextContext &TextContext, const TSharedPtr< class IRunRenderer > &Renderer)=0
 
virtual int32 GetTextIndexAt (const TSharedRef< ILayoutBlock > &Block, const FVector2D &Location, float Scale, ETextHitPoint *const OutHitPoint=nullptr) const =0
 
virtual FVector2D GetLocationAt (const TSharedRef< ILayoutBlock > &Block, int32 Offset, float Scale) const =0
 
virtual void BeginLayout ()=0
 
virtual void EndLayout ()=0
 
virtual void Move (const TSharedRef< FString > &NewText, const FTextRange &NewRange)=0
 
virtual TSharedRef< IRunClone () const =0
 
virtual void AppendTextTo (FString &Text) const =0
 
virtual void AppendTextTo (FString &Text, const FTextRange &Range) const =0
 
virtual const FRunInfoGetRunInfo () const =0
 
virtual ERunAttributes GetRunAttributes () const =0
 

Constructor & Destructor Documentation

◆ ~IRun()

virtual IRun::~IRun ( )
inlinevirtual

Member Function Documentation

◆ AppendTextTo() [1/2]

virtual void IRun::AppendTextTo ( FString &  Text) const
pure virtual

Implemented in FSlateTextRun.

◆ AppendTextTo() [2/2]

virtual void IRun::AppendTextTo ( FString &  Text,
const FTextRange Range 
) const
pure virtual

Implemented in FSlateTextRun.

◆ BeginLayout()

virtual void IRun::BeginLayout ( )
pure virtual

Implemented in FSlateTextRun.

◆ Clone()

virtual TSharedRef< IRun > IRun::Clone ( ) const
pure virtual

Implemented in FSlatePasswordRun, and FSlateTextRun.

◆ CreateBlock()

virtual TSharedRef< class ILayoutBlock > IRun::CreateBlock ( int32  StartIndex,
int32  EndIndex,
FVector2D  Size,
const FLayoutBlockTextContext TextContext,
const TSharedPtr< class IRunRenderer > &  Renderer 
)
pure virtual

Implemented in FSlateTextRun.

◆ EndLayout()

virtual void IRun::EndLayout ( )
pure virtual

Implemented in FSlateTextRun.

◆ GetBaseLine()

virtual int16 IRun::GetBaseLine ( float  Scale) const
pure virtual

Implemented in FSlateTextRun.

◆ GetKerning()

virtual int8 IRun::GetKerning ( int32  CurrentIndex,
float  Scale,
const FRunTextContext TextContext 
) const
pure virtual

Implemented in FSlatePasswordRun, and FSlateTextRun.

◆ GetLocationAt()

virtual FVector2D IRun::GetLocationAt ( const TSharedRef< ILayoutBlock > &  Block,
int32  Offset,
float  Scale 
) const
pure virtual

Implemented in FSlatePasswordRun, and FSlateTextRun.

◆ GetMaxHeight()

virtual int16 IRun::GetMaxHeight ( float  Scale) const
pure virtual

Implemented in FSlateTextRun.

◆ GetOutlineSize()

virtual FVector2D IRun::GetOutlineSize ( int32  StartIndex,
int32  EndIndex,
float  Scale 
) const
inlinevirtual

Reimplemented in FSlateTextRun.

◆ GetRunAttributes()

virtual ERunAttributes IRun::GetRunAttributes ( ) const
pure virtual

Implemented in FSlateTextRun.

◆ GetRunInfo()

virtual const FRunInfo & IRun::GetRunInfo ( ) const
pure virtual

Implemented in FSlateTextRun.

◆ GetShadowSize()

virtual FVector2D IRun::GetShadowSize ( int32  StartIndex,
int32  EndIndex,
float  Scale 
) const
inlinevirtual

Reimplemented in FSlateTextRun.

◆ GetTextIndexAt()

virtual int32 IRun::GetTextIndexAt ( const TSharedRef< ILayoutBlock > &  Block,
const FVector2D Location,
float  Scale,
ETextHitPoint *const  OutHitPoint = nullptr 
) const
pure virtual

Implemented in FSlatePasswordRun, and FSlateTextRun.

◆ GetTextRange()

virtual FTextRange IRun::GetTextRange ( ) const
pure virtual

Implemented in FSlateTextRun.

◆ Measure()

virtual FVector2D IRun::Measure ( int32  StartIndex,
int32  EndIndex,
float  Scale,
const FRunTextContext TextContext 
) const
pure virtual

Implemented in FSlatePasswordRun, and FSlateTextRun.

◆ Move()

virtual void IRun::Move ( const TSharedRef< FString > &  NewText,
const FTextRange NewRange 
)
pure virtual

Implemented in FSlateTextRun.

◆ SetTextRange()

virtual void IRun::SetTextRange ( const FTextRange Value)
pure virtual

Implemented in FSlateTextRun.


The documentation for this class was generated from the following file: