SHyperlink.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 "Widgets/DeclarativeSyntaxSupport.h"
#include "Styling/SlateColor.h"
#include "Input/CursorReply.h"
#include "Input/Reply.h"
#include "Layout/Margin.h"
#include "Styling/SlateTypes.h"
#include "Styling/CoreStyle.h"
#include "Widgets/Input/SButton.h"
#include "Widgets/Text/STextBlock.h"
#if WITH_ACCESSIBILITY
#include "Widgets/Accessibility/SlateAccessibleWidgets.h"
#endif
 
enum class ETextFlowDirection : uint8;
enum class ETextShapingMethod : uint8;
 
class SHyperlink
    : public SButton
{
public:
 
    SLATE_BEGIN_ARGS(SHyperlink)
        : _Text()
        , _Style(&FCoreStyle::Get().GetWidgetStyle< FHyperlinkStyle >("Hyperlink"))
        , _TextStyle(nullptr)
        , _UnderlineStyle(nullptr)
        , _Padding()
        , _OnNavigate()
        , _TextShapingMethod()
        , _TextFlowDirection()
        , _HighlightColor()
        , _HighlightShape()
        , _HighlightText()
        , _OverflowPolicy()
        {}
 
        SLATE_ATTRIBUTE( FText, Text )
        SLATE_STYLE_ARGUMENT( FHyperlinkStyle, Style )
        SLATE_STYLE_ARGUMENT( FTextBlockStyle, TextStyle )
        SLATE_STYLE_ARGUMENT( FButtonStyle, UnderlineStyle )
        SLATE_ATTRIBUTE( FMargin, Padding )
        SLATE_EVENT( FSimpleDelegate, OnNavigate )
        SLATE_ARGUMENT( TOptional<ETextShapingMethod>, TextShapingMethod )
        SLATE_ARGUMENT( TOptional<ETextFlowDirection>, TextFlowDirection )
        SLATE_ATTRIBUTE( FLinearColor, HighlightColor )
        SLATE_ATTRIBUTE( const FSlateBrush*, HighlightShape )
        SLATE_ATTRIBUTE( FText, HighlightText )
        SLATE_ARGUMENT(TOptional<ETextOverflowPolicy>, OverflowPolicy)
    SLATE_END_ARGS()
 
    
    void Construct( const FArguments& InArgs )
    {
        this->OnNavigate = InArgs._OnNavigate;
 
        check (InArgs._Style);
        const FButtonStyle* UnderlineStyle = InArgs._UnderlineStyle != nullptr ? InArgs._UnderlineStyle : &InArgs._Style->UnderlineStyle;
        const FTextBlockStyle* TextStyle = InArgs._TextStyle != nullptr ? InArgs._TextStyle : &InArgs._Style->TextStyle;
        TAttribute<FMargin> Padding = InArgs._Padding.IsSet() ? InArgs._Padding : InArgs._Style->Padding;
 
        SButton::Construct(
            SButton::FArguments()
            .ContentPadding(Padding)
            .ButtonStyle(UnderlineStyle)
            .OnClicked(this, &SHyperlink::Hyperlink_OnClicked)
            .ForegroundColor(FSlateColor::UseForeground())
            .TextShapingMethod(InArgs._TextShapingMethod)
            .TextFlowDirection(InArgs._TextFlowDirection)
            [
                SNew(STextBlock)
                .TextStyle(TextStyle)
                .Text(InArgs._Text)
                .HighlightColor(InArgs._HighlightColor)
                .HighlightShape(InArgs._HighlightShape)
                .HighlightText(InArgs._HighlightText)
                .OverflowPolicy(InArgs._OverflowPolicy)
            ]
        );
    }
 
public:
 
    // SWidget overrides
 
    virtual FCursorReply OnCursorQuery( const FGeometry& MyGeometry, const FPointerEvent& CursorEvent ) const override
    {
        return FCursorReply::Cursor( EMouseCursor::Hand );
    }
#if WITH_ACCESSIBILITY
    virtual TSharedRef<FSlateAccessibleWidget> CreateAccessibleWidget() override
    {
        return MakeShareable<FSlateAccessibleWidget>(new FSlateAccessibleHyperlink(SharedThis(this)));
    }
#endif
 
protected:
 
    FReply Hyperlink_OnClicked()
    {
        OnNavigate.ExecuteIfBound();
 
        return FReply::Handled();
    }
 
    FSimpleDelegate OnNavigate;
};