UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
SlateEditableTextTypes::FTextCompositionHighlighter Class Reference

#include <SlateEditableTextTypes.h>

+ Inheritance diagram for SlateEditableTextTypes::FTextCompositionHighlighter:

Public Member Functions

SLATE_API void SetCompositionBrush (const TAttribute< const FSlateBrush * > &InCompositionBrush)
 
virtual SLATE_API int32 OnPaint (const FPaintArgs &Args, const FTextLayout::FLineView &Line, const FVector2D Offset, const float Width, const FTextBlockStyle &DefaultStyle, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const override
 
- Public Member Functions inherited from ISlateLineHighlighter
virtual ~ISlateLineHighlighter ()
 
 UE_DEPRECATED (5.6, "Please use OnPaint with Offset (FVector2D) instead of OffsetX (float).") virtual int32 OnPaint(const FPaintArgs &Args
 
- Public Member Functions inherited from ILineHighlighter
virtual ~ILineHighlighter ()
 

Static Public Member Functions

static SLATE_API TSharedRef< FTextCompositionHighlighter > Create ()
 

Protected Member Functions

SLATE_API FTextCompositionHighlighter ()
 

Protected Attributes

TAttribute< const FSlateBrush * > CompositionBrush
 

Additional Inherited Members

- Public Attributes inherited from ISlateLineHighlighter
const FTextLayout::FLineView & Line
 
const FTextLayout::FLineView const float OffsetX
 
const FTextLayout::FLineView const float const float Width
 
const FTextLayout::FLineView const float const float const FTextBlockStyle & DefaultStyle
 
const FTextLayout::FLineView const float const float const FTextBlockStyle const FGeometry & AllottedGeometry
 
const FTextLayout::FLineView const float const float const FTextBlockStyle const FGeometry const FSlateRect & MyCullingRect
 
const FTextLayout::FLineView const float const float const FTextBlockStyle const FGeometry const FSlateRect FSlateWindowElementList & OutDrawElements
 
const FTextLayout::FLineView const float const float const FTextBlockStyle const FGeometry const FSlateRect FSlateWindowElementList int32 LayerId
 
const FTextLayout::FLineView const float const float const FTextBlockStyle const FGeometry const FSlateRect FSlateWindowElementList int32 const FWidgetStyle & InWidgetStyle
 
const FTextLayout::FLineView const float const float const FTextBlockStyle const FGeometry const FSlateRect FSlateWindowElementList int32 const FWidgetStyle bool bParentEnabled const final
 

Detailed Description

Run highlighter used to draw the composition range

Constructor & Destructor Documentation

◆ FTextCompositionHighlighter()

SlateEditableTextTypes::FTextCompositionHighlighter::FTextCompositionHighlighter ( )
protected

Member Function Documentation

◆ Create()

TSharedRef< FTextCompositionHighlighter > SlateEditableTextTypes::FTextCompositionHighlighter::Create ( )
static

◆ OnPaint()

int32 SlateEditableTextTypes::FTextCompositionHighlighter::OnPaint ( const FPaintArgs &  Args,
const FTextLayout::FLineView &  Line,
const FVector2D  Offset,
const float  Width,
const FTextBlockStyle &  DefaultStyle,
const FGeometry &  AllottedGeometry,
const FSlateRect &  MyCullingRect,
FSlateWindowElementList &  OutDrawElements,
int32  LayerId,
const FWidgetStyle &  InWidgetStyle,
bool  bParentEnabled 
) const
overridevirtual

Implements ISlateLineHighlighter.

◆ SetCompositionBrush()

void SlateEditableTextTypes::FTextCompositionHighlighter::SetCompositionBrush ( const TAttribute< const FSlateBrush * > &  InCompositionBrush)

Member Data Documentation

◆ CompositionBrush

TAttribute<const FSlateBrush*> SlateEditableTextTypes::FTextCompositionHighlighter::CompositionBrush
protected

Brush used to draw the composition highlight

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