ISlateTextLineHighlighter Class Reference

#include <SlateTextUnderlineLineHighlighter.h>

Inheritance diagram for ISlateTextLineHighlighter:

Public Member Functions
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 Attributes
static const int32	DefaultZIndex = 1

Protected Member Functions
SLATE_API	ISlateTextLineHighlighter (const FSlateBrush &InLineBrush, const FSlateFontInfo &InFontInfo, const FSlateColor InColorAndOpacity, const UE::Slate::FDeprecateVector2DParameter InShadowOffset, const FLinearColor InShadowColorAndOpacity)
virtual void	GetLineMetrics (const float InFontScale, int16 &OutLinePos, int16 &OutLineThickness) const =0

Protected Attributes
FSlateBrush	LineBrush
FSlateFontInfo	FontInfo
FSlateColor	ColorAndOpacity
UE::Slate::FDeprecateVector2DResult	ShadowOffset
FLinearColor	ShadowColorAndOpacity

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 lines

Constructor & Destructor Documentation

ISlateTextLineHighlighter()

ISlateTextLineHighlighter::ISlateTextLineHighlighter ( const FSlateBrush &  InLineBrush, const FSlateFontInfo &  InFontInfo, const FSlateColor  InColorAndOpacity, const UE::Slate::FDeprecateVector2DParameter  InShadowOffset, const FLinearColor  InShadowColorAndOpacity  )

protected

Member Function Documentation

GetLineMetrics()

virtual void ISlateTextLineHighlighter::GetLineMetrics ( const float  InFontScale, int16 &  OutLinePos, int16 &  OutLineThickness  ) const

protectedpure virtual

Implemented in FSlateTextUnderlineLineHighlighter, and FSlateTextStrikeLineHighlighter.

OnPaint()

int32 ISlateTextLineHighlighter::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.

Member Data Documentation

ColorAndOpacity

FSlateColor ISlateTextLineHighlighter::ColorAndOpacity

protected

The color to draw the underline (typically matches the text its associated with)

DefaultZIndex

const int32 ISlateTextLineHighlighter::DefaultZIndex = 1

static

FontInfo

FSlateFontInfo ISlateTextLineHighlighter::FontInfo

protected

Font the underline is associated with

LineBrush

FSlateBrush ISlateTextLineHighlighter::LineBrush

protected

Brush used to draw the line

ShadowColorAndOpacity

FLinearColor ISlateTextLineHighlighter::ShadowColorAndOpacity

protected

The color to draw the shadow

ShadowOffset

UE::Slate::FDeprecateVector2DResult ISlateTextLineHighlighter::ShadowOffset

protected

Offset at which to draw the shadow (if any)

---

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

• Engine/Source/Runtime/Slate/Public/Framework/Text/SlateTextUnderlineLineHighlighter.h
• Engine/Source/Runtime/Slate/Private/Framework/Text/SlateTextUnderlineLineHighlighter.cpp