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

#include <SlateTextUnderlineLineHighlighter.h>

+ Inheritance diagram for FSlateTextStrikeLineHighlighter:

Static Public Member Functions

static SLATE_API TSharedRef< FSlateTextStrikeLineHighlighter > Create (const FSlateBrush &InUnderlineBrush, const FSlateFontInfo &InFontInfo, const FSlateColor InColorAndOpacity, const UE::Slate::FDeprecateVector2DParameter InShadowOffset, const FLinearColor InShadowColorAndOpacity)
 

Protected Member Functions

SLATE_API FSlateTextStrikeLineHighlighter (const FSlateBrush &InStrikeBrush, const FSlateFontInfo &InFontInfo, const FSlateColor InColorAndOpacity, const UE::Slate::FDeprecateVector2DParameter InShadowOffset, const FLinearColor InShadowColorAndOpacity)
 
virtual SLATE_API void GetLineMetrics (const float InFontScale, int16 &OutLinePos, int16 &OutLineThickness) const override
 
- Protected Member Functions inherited from ISlateTextLineHighlighter
SLATE_API ISlateTextLineHighlighter (const FSlateBrush &InLineBrush, const FSlateFontInfo &InFontInfo, const FSlateColor InColorAndOpacity, const UE::Slate::FDeprecateVector2DParameter InShadowOffset, const FLinearColor InShadowColorAndOpacity)
 

Additional Inherited Members

- Public Member Functions inherited from ISlateTextLineHighlighter
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 ()
 
- 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
 
- Static Public Attributes inherited from ISlateTextLineHighlighter
static const int32 DefaultZIndex = 1
 
- Protected Attributes inherited from ISlateTextLineHighlighter
FSlateBrush LineBrush
 
FSlateFontInfo FontInfo
 
FSlateColor ColorAndOpacity
 
UE::Slate::FDeprecateVector2DResult ShadowOffset
 
FLinearColor ShadowColorAndOpacity
 

Detailed Description

Run highlighter used to draw strikes

Constructor & Destructor Documentation

◆ FSlateTextStrikeLineHighlighter()

FSlateTextStrikeLineHighlighter::FSlateTextStrikeLineHighlighter ( const FSlateBrush &  InStrikeBrush,
const FSlateFontInfo &  InFontInfo,
const FSlateColor  InColorAndOpacity,
const UE::Slate::FDeprecateVector2DParameter  InShadowOffset,
const FLinearColor  InShadowColorAndOpacity 
)
protected

Member Function Documentation

◆ Create()

TSharedRef< FSlateTextStrikeLineHighlighter > FSlateTextStrikeLineHighlighter::Create ( const FSlateBrush &  InUnderlineBrush,
const FSlateFontInfo &  InFontInfo,
const FSlateColor  InColorAndOpacity,
const UE::Slate::FDeprecateVector2DParameter  InShadowOffset,
const FLinearColor  InShadowColorAndOpacity 
)
static

◆ GetLineMetrics()

void FSlateTextStrikeLineHighlighter::GetLineMetrics ( const float  InFontScale,
int16 &  OutLinePos,
int16 &  OutLineThickness 
) const
overrideprotectedvirtual

Implements ISlateTextLineHighlighter.

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