SRichTextBlock.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "CoreMinimal.h"
#include "Misc/Attribute.h"
#include "SlateGlobals.h"
#include "Layout/Margin.h"
#include "Styling/SlateWidgetStyleAsset.h"
#include "Widgets/DeclarativeSyntaxSupport.h"
#include "Widgets/SWidget.h"
#include "Styling/SlateTypes.h"
#include "Styling/CoreStyle.h"
#include "Framework/Text/TextLayout.h"
#include "Framework/Text/SlateHyperlinkRun.h"
#include "Framework/Text/ITextDecorator.h"
#include "Framework/Text/TextDecorators.h"
#include "Framework/Text/SlateTextLayoutFactory.h"
 
class FArrangedChildren;
class FPaintArgs;
class FRichTextLayoutMarshaller;
class FSlateWindowElementList;
class FSlateTextBlockLayout;
class IRichTextMarkupParser;
enum class ETextShapingMethod : uint8;
 
#if WITH_FANCY_TEXT
 
class SRichTextBlock : public SWidget
{
public:
 
    SLATE_BEGIN_ARGS( SRichTextBlock )
        : _Text()
        , _HighlightText()
        , _WrapTextAt( 0.0f )
        , _AutoWrapText(false)
        , _WrappingPolicy(ETextWrappingPolicy::DefaultWrapping)
        , _TransformPolicy(ETextTransformPolicy::None)
        , _Marshaller()
        , _DecoratorStyleSet( &FCoreStyle::Get() )
        , _TextStyle( &FCoreStyle::Get().GetWidgetStyle<FTextBlockStyle>( "NormalText" ) )
        , _Margin( FMargin() )
        , _LineHeightPercentage( 1.0f )
        , _ApplyLineHeightToBottomLine( true )
        , _Justification( ETextJustify::Left )
        , _TextShapingMethod()
        , _TextFlowDirection()
        , _Decorators()
        , _Parser()
        , _OverflowPolicy()
        , _MinDesiredWidth()
    {
        _Clipping = EWidgetClipping::OnDemand;
    }
        SLATE_ATTRIBUTE( FText, Text )
 
        
        SLATE_ATTRIBUTE( FText, HighlightText )
 
        
        SLATE_ATTRIBUTE( float, WrapTextAt )
 
        
        SLATE_ATTRIBUTE( bool, AutoWrapText )
 
        
        SLATE_ATTRIBUTE( ETextWrappingPolicy, WrappingPolicy )
 
        
        SLATE_ATTRIBUTE( ETextTransformPolicy, TransformPolicy )
 
        
        SLATE_ARGUMENT(TSharedPtr<class FRichTextLayoutMarshaller>, Marshaller)
 
        
        SLATE_EVENT(FCreateSlateTextLayout, CreateSlateTextLayout)
 
        
        SLATE_ARGUMENT( const ISlateStyle*, DecoratorStyleSet )
 
        
        SLATE_STYLE_ARGUMENT( FTextBlockStyle, TextStyle )
 
        
        SLATE_ATTRIBUTE( FMargin, Margin )
 
        
        SLATE_ATTRIBUTE( float, LineHeightPercentage )
 
        
        SLATE_ATTRIBUTE( bool, ApplyLineHeightToBottomLine )
 
        
        SLATE_ATTRIBUTE( ETextJustify::Type, Justification )
 
        
        SLATE_ARGUMENT( TOptional<ETextShapingMethod>, TextShapingMethod )
        
        
        SLATE_ARGUMENT( TOptional<ETextFlowDirection>, TextFlowDirection )
 
        
        SLATE_ARGUMENT( TArray< TSharedRef< class ITextDecorator > >, Decorators )
 
        
        SLATE_ARGUMENT( TSharedPtr< class IRichTextMarkupParser >, Parser )
 
        
        SLATE_ARGUMENT(TOptional<ETextOverflowPolicy>, OverflowPolicy)
 
        
        SLATE_ATTRIBUTE(float, MinDesiredWidth)
 
        
        TArray< TSharedRef< ITextDecorator > > InlineDecorators;
        SRichTextBlock::FArguments& operator + (const TSharedRef< ITextDecorator >& DecoratorToAdd)
        {
            InlineDecorators.Add( DecoratorToAdd );
            return *this;
        }
 
    SLATE_END_ARGS()
 
    static TSharedRef< ITextDecorator > Decorator( const TSharedRef< ITextDecorator >& Decorator )
    {
        return Decorator;
    }
 
    static TSharedRef< ITextDecorator > WidgetDecorator( const FString RunName, const FWidgetDecorator::FCreateWidget& FactoryDelegate )
    {
        return FWidgetDecorator::Create( RunName, FactoryDelegate );
    }
 
    template< class UserClass >
    static TSharedRef< ITextDecorator >  WidgetDecorator( const FString RunName, UserClass* InUserObjectPtr, typename FWidgetDecorator::FCreateWidget::TConstMethodPtr< UserClass > InFunc )
    {
        return FWidgetDecorator::Create( RunName, FWidgetDecorator::FCreateWidget::CreateSP( InUserObjectPtr, InFunc ) );
    }
 
    static TSharedRef< ITextDecorator > ImageDecorator( FString RunName = TEXT("img"), const ISlateStyle* const OverrideStyle = NULL )
    {
        return FImageDecorator::Create( RunName, OverrideStyle );
    }
 
    static TSharedRef< ITextDecorator > HyperlinkDecorator( const FString Id, const FSlateHyperlinkRun::FOnClick& NavigateDelegate )
    {
        return FHyperlinkDecorator::Create( Id, NavigateDelegate );
    }
 
    template< class UserClass >
    static TSharedRef< ITextDecorator > HyperlinkDecorator( const FString Id, UserClass* InUserObjectPtr, typename FSlateHyperlinkRun::FOnClick::TMethodPtr< UserClass > NavigateFunc )
    {
        return FHyperlinkDecorator::Create( Id, FSlateHyperlinkRun::FOnClick::CreateSP( InUserObjectPtr, NavigateFunc ) );
    }
 
    SLATE_API SRichTextBlock();
 
    SLATE_API ~SRichTextBlock();
 
    //~ Begin SWidget Interface
    SLATE_API void Construct( const FArguments& InArgs );
    SLATE_API virtual int32 OnPaint( const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawElements, int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled ) const override;
    SLATE_API virtual FChildren* GetChildren() override;
    SLATE_API virtual void OnArrangeChildren( const FGeometry& AllottedGeometry, FArrangedChildren& ArrangedChildren ) const override;
    //~ End SWidget Interface
 
    const FText& GetText() const
    {
        return BoundText.Get(FText::GetEmpty());
    }
 
    SLATE_API void SetText( const TAttribute<FText>& InTextAttr );
 
    SLATE_API void SetHighlightText( const TAttribute<FText>& InHighlightText );
 
    SLATE_API void SetTextShapingMethod(const TOptional<ETextShapingMethod>& InTextShapingMethod);
 
    SLATE_API void SetTextFlowDirection(const TOptional<ETextFlowDirection>& InTextFlowDirection);
 
    SLATE_API void SetWrapTextAt(const TAttribute<float>& InWrapTextAt);
 
    SLATE_API void SetAutoWrapText(const TAttribute<bool>& InAutoWrapText);
 
    SLATE_API void SetWrappingPolicy(const TAttribute<ETextWrappingPolicy>& InWrappingPolicy);
 
    SLATE_API void SetTransformPolicy(const TAttribute<ETextTransformPolicy>& InTransformPolicy);
 
    SLATE_API void SetLineHeightPercentage(const TAttribute<float>& InLineHeightPercentage);
 
    SLATE_API void SetApplyLineHeightToBottomLine(const TAttribute<bool>& InApplyLineHeightToBottomLine);
 
    SLATE_API void SetMargin(const TAttribute<FMargin>& InMargin);
 
    SLATE_API void SetJustification(const TAttribute<ETextJustify::Type>& InJustification);
 
    SLATE_API void SetTextStyle(const FTextBlockStyle& InTextStyle);
 
    SLATE_API void SetMinDesiredWidth(const TAttribute<float>& InMinDesiredWidth);
 
    SLATE_API void SetDecoratorStyleSet(const ISlateStyle* NewDecoratorStyleSet);
 
    SLATE_API void SetDecorators(TArrayView<TSharedRef<ITextDecorator>> InDecorators);
 
    SLATE_API void SetOverflowPolicy(TOptional<ETextOverflowPolicy> InOverflowPolicy);
 
    SLATE_API void Refresh();
 
    SLATE_API void SetTextBlockScale(const float NewTextBlockScale);
 
protected:
    //~ SWidget interface
    SLATE_API virtual FVector2D ComputeDesiredSize(float) const override;
    SLATE_API virtual bool ComputeVolatility() const override;
    //~ End of SWidget interface
 
private:
 
    TAttribute< FText > BoundText;
 
    TUniquePtr< FSlateTextBlockLayout > TextLayoutCache;
 
    FTextBlockStyle TextStyle;
 
    TAttribute<FText> HighlightText;
 
    TAttribute<float> WrapTextAt;
    
    TAttribute<bool> AutoWrapText;
 
    TAttribute<ETextWrappingPolicy> WrappingPolicy;
 
    TAttribute<ETextTransformPolicy> TransformPolicy;
 
    TAttribute< FMargin > Margin;
 
    TAttribute< ETextJustify::Type > Justification; 
 
    TAttribute< float > LineHeightPercentage;
 
    TAttribute< bool > ApplyLineHeightToBottomLine;
 
    TAttribute<float> MinDesiredWidth;
 
    float TextBlockScale = 1.0f;
 
    TSharedPtr<FRichTextLayoutMarshaller> Marshaller;
};
 
#endif //WITH_FANCY_TEXT