2014-08-14 07:42:47 -04:00
// Copyright 1998-2014 Epic Games, Inc. All Rights Reserved.
# include "IntroTutorialsPrivatePCH.h"
# include "STutorialEditableText.h"
# include "IDocumentation.h"
# include "ISourceCodeAccessModule.h"
# include "ContentBrowserModule.h"
2014-08-27 20:35:19 -04:00
# include "SColorPicker.h"
2014-08-29 15:31:27 -04:00
# include "DesktopPlatformModule.h"
Converted STextBlock to use an FTextLayout
This solves a wrapping issue where STextBlock would incorrectly consume new-line characters when wrapping, as well as allowing it to use custom wrapping behavior (eg, CamelCase wrapping for asset names in the content browser).
This change also implements FString -> FText passthrough for SLATE_TEXT_ATTRIBUTE (it was previously performing FText -> FString passthrough, however this didn't fit well with the fact that FText has a more efficient method of comparing whether a bound text attribute has changed (see FTextSnapshot), so can quickly work out that the FTextLayout doesn't need updating).
This change adds FTextBlockLayout to handle the text layout cache for text block types (STextBlock and SRichTextBlock) and serves a dual purpose of moving the duplicated caching logic into a single place, as well as hiding it from the widget (so allowing the cache to mutate, even when called from immutable widget functions).
This change also increases the unification between the STextBlock and SRichTextBlock construction parameters, by allowing STextBlock to specify a Justification, Margin, and LineHeightPercentage, and allowing SRichTextBlock to specify its HighlightText as an attribute.
ReviewedBy Nick.Atamas, Justin.Sargent
[CL 2280351 by Jamie Dale in Main branch]
2014-09-01 06:28:16 -04:00
# include "RichTextLayoutMarshaller.h"
2014-09-05 08:25:07 -04:00
# include "EditorTutorial.h"
2014-09-04 09:59:45 -04:00
# include "Editor/MainFrame/Public/MainFrame.h"
2014-08-14 07:42:47 -04:00
# define LOCTEXT_NAMESPACE "STutorialEditableText"
2014-08-27 20:35:19 -04:00
2014-08-14 07:42:47 -04:00
namespace TutorialTextHelpers
{
void OnBrowserLinkClicked ( const FSlateHyperlinkRun : : FMetadata & Metadata )
{
const FString * Url = Metadata . Find ( TEXT ( " href " ) ) ;
if ( Url )
{
FPlatformProcess : : LaunchURL ( * * Url , nullptr , nullptr ) ;
}
}
void OnDocLinkClicked ( const FSlateHyperlinkRun : : FMetadata & Metadata )
{
const FString * Url = Metadata . Find ( TEXT ( " href " ) ) ;
if ( Url )
{
IDocumentation : : Get ( ) - > Open ( * Url ) ;
}
}
2014-09-04 09:59:45 -04:00
static void ParseTutorialLink ( const FString & InternalLink )
{
UBlueprint * Blueprint = LoadObject < UBlueprint > ( nullptr , * InternalLink ) ;
if ( Blueprint & & Blueprint - > GeneratedClass )
{
FIntroTutorials & IntroTutorials = FModuleManager : : GetModuleChecked < FIntroTutorials > ( TEXT ( " IntroTutorials " ) ) ;
IMainFrameModule & MainFrameModule = FModuleManager : : LoadModuleChecked < IMainFrameModule > ( TEXT ( " MainFrame " ) ) ;
const bool bRestart = true ;
IntroTutorials . LaunchTutorial ( Blueprint - > GeneratedClass - > GetDefaultObject < UEditorTutorial > ( ) , bRestart , MainFrameModule . GetParentWindow ( ) ) ;
}
}
2014-08-14 07:42:47 -04:00
void OnTutorialLinkClicked ( const FSlateHyperlinkRun : : FMetadata & Metadata )
{
const FString * Url = Metadata . Find ( TEXT ( " href " ) ) ;
if ( Url )
{
2014-09-04 09:59:45 -04:00
ParseTutorialLink ( * Url ) ;
2014-08-14 07:42:47 -04:00
}
}
static void ParseCodeLink ( const FString & InternalLink )
{
// Tokens used by the code parsing. Details in the parse section
2014-09-04 09:59:45 -04:00
static const FString ProjectSpecifier ( TEXT ( " [PROJECTPATH] " ) ) ;
static const FString ProjectPathSpecifier ( TEXT ( " [PROJECT] " ) ) ;
static const FString EnginePathSpecifier ( TEXT ( " [ENGINEPATH] " ) ) ;
2014-08-14 07:42:47 -04:00
FString Path ;
int32 Line = 0 ;
int32 Col = 0 ;
TArray < FString > Tokens ;
InternalLink . ParseIntoArray ( & Tokens , TEXT ( " , " ) , 0 ) ;
int32 TokenStringsCount = Tokens . Num ( ) ;
if ( TokenStringsCount > 0 )
{
Path = Tokens [ 0 ] ;
}
if ( TokenStringsCount > 1 )
{
TTypeFromString < int32 > : : FromString ( Line , * Tokens [ 1 ] ) ;
}
if ( TokenStringsCount > 2 )
{
TTypeFromString < int32 > : : FromString ( Col , * Tokens [ 2 ] ) ;
}
ISourceCodeAccessModule & SourceCodeAccessModule = FModuleManager : : LoadModuleChecked < ISourceCodeAccessModule > ( " SourceCodeAccess " ) ;
ISourceCodeAccessor & SourceCodeAccessor = SourceCodeAccessModule . GetAccessor ( ) ;
2014-09-04 09:59:45 -04:00
if ( Path . Contains ( EnginePathSpecifier ) = = true )
2014-08-14 07:42:47 -04:00
{
2014-09-04 09:59:45 -04:00
// replace engine path specifier with path to engine
Path . ReplaceInline ( * EnginePathSpecifier , * FPaths : : EngineDir ( ) ) ;
2014-08-14 07:42:47 -04:00
}
2014-09-04 09:59:45 -04:00
if ( Path . Contains ( ProjectSpecifier ) = = true )
2014-08-14 07:42:47 -04:00
{
2014-09-04 09:59:45 -04:00
// replace project specifier with path to project
Path . ReplaceInline ( * ProjectSpecifier , FApp : : GetGameName ( ) ) ;
2014-08-14 07:42:47 -04:00
}
2014-09-04 09:59:45 -04:00
if ( Path . Contains ( ProjectPathSpecifier ) = = true )
{
// replace project specifier with path to project
Path . ReplaceInline ( * ProjectPathSpecifier , * FPaths : : GetProjectFilePath ( ) ) ;
}
Path = FPaths : : ConvertRelativePathToFull ( Path ) ;
SourceCodeAccessor . OpenFileAtLine ( Path , Line , Col ) ;
2014-08-14 07:42:47 -04:00
}
void OnCodeLinkClicked ( const FSlateHyperlinkRun : : FMetadata & Metadata )
{
const FString * Url = Metadata . Find ( TEXT ( " href " ) ) ;
if ( Url )
{
ParseCodeLink ( * Url ) ;
}
}
2014-09-04 09:59:45 -04:00
static void ParseAssetLink ( const FString & InternalLink , const FString * Action )
2014-08-14 07:42:47 -04:00
{
UObject * RequiredObject = FindObject < UObject > ( ANY_PACKAGE , * InternalLink ) ;
if ( RequiredObject ! = nullptr )
{
2014-09-04 09:59:45 -04:00
if ( Action & & * Action = = TEXT ( " select " ) )
2014-08-14 07:42:47 -04:00
{
FContentBrowserModule & ContentBrowserModule = FModuleManager : : Get ( ) . LoadModuleChecked < FContentBrowserModule > ( " ContentBrowser " ) ;
TArray < UObject * > AssetToBrowse ;
AssetToBrowse . Add ( RequiredObject ) ;
ContentBrowserModule . Get ( ) . SyncBrowserToAssets ( AssetToBrowse ) ;
}
2014-09-04 09:59:45 -04:00
else
{
FAssetEditorManager : : Get ( ) . OpenEditorForAsset ( RequiredObject ) ;
}
2014-08-14 07:42:47 -04:00
}
}
void OnAssetLinkClicked ( const FSlateHyperlinkRun : : FMetadata & Metadata )
{
const FString * Url = Metadata . Find ( TEXT ( " href " ) ) ;
const FString * Action = Metadata . Find ( TEXT ( " action " ) ) ;
2014-09-04 09:59:45 -04:00
if ( Url )
2014-08-14 07:42:47 -04:00
{
2014-09-04 09:59:45 -04:00
ParseAssetLink ( * Url , Action ) ;
2014-08-14 07:42:47 -04:00
}
}
}
BEGIN_SLATE_FUNCTION_BUILD_OPTIMIZATION
void STutorialEditableText : : Construct ( const FArguments & InArgs )
{
OnTextChanged = InArgs . _OnTextChanged ;
OnTextCommitted = InArgs . _OnTextCommitted ;
2014-09-03 06:25:58 -04:00
bNewHyperlink = true ;
2014-08-14 07:42:47 -04:00
2014-09-03 06:25:58 -04:00
// Setup text styles
StylesAndNames . Add ( MakeShareable ( new FTextStyleAndName ( TEXT ( " Tutorials.Content.Text " ) , LOCTEXT ( " NormalTextDesc " , " Normal " ) ) ) ) ;
StylesAndNames . Add ( MakeShareable ( new FTextStyleAndName ( TEXT ( " Tutorials.Content.TextBold " ) , LOCTEXT ( " BoldTextDesc " , " Bold " ) ) ) ) ;
StylesAndNames . Add ( MakeShareable ( new FTextStyleAndName ( TEXT ( " Tutorials.Content.HeaderText2 " ) , LOCTEXT ( " Header2TextDesc " , " Header 2 " ) ) ) ) ;
StylesAndNames . Add ( MakeShareable ( new FTextStyleAndName ( TEXT ( " Tutorials.Content.HeaderText1 " ) , LOCTEXT ( " Header1TextDesc " , " Header 1 " ) ) ) ) ;
ActiveStyle = StylesAndNames [ 0 ] ;
HyperlinkStyle = MakeShareable ( new FTextStyleAndName ( TEXT ( " Tutorials.Content.HyperlinkText " ) , LOCTEXT ( " HyperlinkTextDesc " , " Hyperlink " ) ) ) ;
StylesAndNames . Add ( HyperlinkStyle ) ;
2014-08-14 07:42:47 -04:00
TSharedRef < FRichTextLayoutMarshaller > RichTextMarshaller = FRichTextLayoutMarshaller : : Create (
TArray < TSharedRef < ITextDecorator > > ( ) ,
& FEditorStyle : : Get ( ) ,
2014-09-03 06:25:58 -04:00
FEditorStyle : : Get ( ) . GetWidgetStyle < FTextBlockStyle > ( " Tutorials.Content.Text " )
2014-08-14 07:42:47 -04:00
) ;
2014-09-04 09:59:45 -04:00
HyperlinkDescs . Add ( MakeShareable ( new FHyperlinkTypeDesc (
EHyperlinkType : : Browser ,
LOCTEXT ( " BrowserLinkTypeLabel " , " URL " ) ,
LOCTEXT ( " BrowserLinkTypeTooltip " , " A link that opens a browser window (e.g. http://www.unrealengine.com) " ) ,
TEXT ( " browser " ) ,
FSlateHyperlinkRun : : FOnClick : : CreateStatic ( & TutorialTextHelpers : : OnBrowserLinkClicked ) ) ) ) ;
CurrentHyperlinkType = HyperlinkDescs [ 0 ] ;
HyperlinkDescs . Add ( MakeShareable ( new FHyperlinkTypeDesc (
EHyperlinkType : : UDN ,
LOCTEXT ( " UDNLinkTypeLabel " , " UDN " ) ,
LOCTEXT ( " UDNLinkTypeTooltip " , " A link that opens some UDN documentation (e.g. /Engine/Blueprints/UserGuide/Types/ClassBlueprint) " ) ,
TEXT ( " udn " ) ,
FSlateHyperlinkRun : : FOnClick : : CreateStatic ( & TutorialTextHelpers : : OnDocLinkClicked ) ) ) ) ;
HyperlinkDescs . Add ( MakeShareable ( new FHyperlinkTypeDesc (
EHyperlinkType : : Asset ,
LOCTEXT ( " AssetLinkTypeLabel " , " Asset " ) ,
LOCTEXT ( " AssetLinkTypeTooltip " , " A link that opens an asset (e.g. /Game/StaticMeshes/SphereMesh.SphereMesh) " ) ,
TEXT ( " asset " ) ,
FSlateHyperlinkRun : : FOnClick : : CreateStatic ( & TutorialTextHelpers : : OnAssetLinkClicked ) ) ) ) ;
HyperlinkDescs . Add ( MakeShareable ( new FHyperlinkTypeDesc (
EHyperlinkType : : Code ,
LOCTEXT ( " CodeLinkTypeLabel " , " Code " ) ,
LOCTEXT ( " CodeLinkTypeTooltip " , " A link that opens code in your selected IDE. \n For example: [PROJECTPATH]/Private/SourceFile.cpp,1,1. \n The numbers correspond to line number and column number. \n You can use [PROJECT], [PROJECTPATH] and [ENGINEPATH] tags to make paths. " ) ,
TEXT ( " code " ) ,
FSlateHyperlinkRun : : FOnClick : : CreateStatic ( & TutorialTextHelpers : : OnCodeLinkClicked ) ) ) ) ;
HyperlinkDescs . Add ( MakeShareable ( new FHyperlinkTypeDesc (
EHyperlinkType : : Tutorial ,
LOCTEXT ( " TutorialLinkTypeLabel " , " Tutorial " ) ,
LOCTEXT ( " TutorialLinkTypeTooltip " , " A type of asset link that opens another tutorial, e.g. /Game/Tutorials/StaticMeshTutorial.StaticMeshTutorial " ) ,
TEXT ( " tutorial " ) ,
FSlateHyperlinkRun : : FOnClick : : CreateStatic ( & TutorialTextHelpers : : OnTutorialLinkClicked ) ) ) ) ;
for ( const auto & HyperlinkDesc : HyperlinkDescs )
{
RichTextMarshaller - > AppendInlineDecorator ( FHyperlinkDecorator : : Create ( HyperlinkDesc - > Id , HyperlinkDesc - > OnClickedDelegate ) ) ;
}
2014-09-03 06:25:58 -04:00
RichTextMarshaller - > AppendInlineDecorator ( FTextStyleDecorator : : Create ( ) ) ;
2014-08-14 07:42:47 -04:00
this - > ChildSlot
[
SNew ( SVerticalBox )
+ SVerticalBox : : Slot ( )
. AutoHeight ( )
. Padding ( FMargin ( 0.0f , 0.0f , 0.0f , 0.0f ) )
[
SAssignNew ( RichEditableTextBox , SMultiLineEditableTextBox )
2014-09-03 06:25:58 -04:00
. Font ( FEditorStyle : : Get ( ) . GetWidgetStyle < FTextBlockStyle > ( " Tutorials.Content.Text " ) . Font )
2014-08-14 07:42:47 -04:00
. Text ( InArgs . _Text )
. OnTextChanged ( this , & STutorialEditableText : : HandleRichEditableTextChanged )
. OnTextCommitted ( this , & STutorialEditableText : : HandleRichEditableTextCommitted )
. OnCursorMoved ( this , & STutorialEditableText : : HandleRichEditableTextCursorMoved )
. Marshaller ( RichTextMarshaller )
. AutoWrapText ( true )
. Margin ( 4 )
. LineHeightPercentage ( 1.1f )
]
+ SVerticalBox : : Slot ( )
. AutoHeight ( )
. Padding ( FMargin ( 0.0f , 0.0f , 0.0f , 4.0f ) )
[
SNew ( SBorder )
. Visibility ( this , & STutorialEditableText : : GetToolbarVisibility )
. BorderImage ( FEditorStyle : : Get ( ) . GetBrush ( " TutorialEditableText.RoundedBackground " ) )
. Padding ( FMargin ( 4 ) )
[
SNew ( SHorizontalBox )
+ SHorizontalBox : : Slot ( )
. AutoWidth ( )
[
2014-09-03 06:25:58 -04:00
SAssignNew ( FontComboBox , SComboBox < TSharedPtr < FTextStyleAndName > > )
2014-08-14 07:42:47 -04:00
. ComboBoxStyle ( FEditorStyle : : Get ( ) , " TutorialEditableText.Toolbar.ComboBox " )
2014-09-03 06:25:58 -04:00
. OptionsSource ( & StylesAndNames )
. OnSelectionChanged ( this , & STutorialEditableText : : OnActiveStyleChanged )
. OnGenerateWidget ( this , & STutorialEditableText : : GenerateStyleComboEntry )
. ContentPadding ( 0.0f )
. InitiallySelectedItem ( nullptr )
2014-08-14 07:42:47 -04:00
[
SNew ( SBox )
. Padding ( FMargin ( 0.0f , 0.0f , 2.0f , 0.0f ) )
2014-09-03 06:25:58 -04:00
. MinDesiredWidth ( 100.0f )
2014-08-14 07:42:47 -04:00
[
SNew ( STextBlock )
2014-09-03 06:25:58 -04:00
. Text ( this , & STutorialEditableText : : GetActiveStyleName )
2014-08-14 07:42:47 -04:00
]
]
]
+ SHorizontalBox : : Slot ( )
. Padding ( FMargin ( 4.0f , 0.0f , 0.0f , 0.0f ) )
. AutoWidth ( )
[
SAssignNew ( HyperlinkComboButton , SComboButton )
2014-09-03 06:25:58 -04:00
. ToolTipText ( LOCTEXT ( " HyperlinkButtonTooltip " , " Insert or Edit Hyperlink " ) )
2014-08-14 07:42:47 -04:00
. ComboButtonStyle ( FEditorStyle : : Get ( ) , " TutorialEditableText.Toolbar.ComboButton " )
. OnComboBoxOpened ( this , & STutorialEditableText : : HandleHyperlinkComboOpened )
2014-09-03 06:25:58 -04:00
. IsEnabled ( this , & STutorialEditableText : : IsHyperlinkComboEnabled )
. ContentPadding ( 1.0f )
2014-08-14 07:42:47 -04:00
. ButtonContent ( )
[
2014-09-03 06:25:58 -04:00
SNew ( SImage )
. Image ( FEditorStyle : : Get ( ) . GetBrush ( " TutorialEditableText.Toolbar.HyperlinkImage " ) )
2014-08-14 07:42:47 -04:00
]
. MenuContent ( )
[
SNew ( SGridPanel )
. FillColumn ( 1 , 1.0f )
+ SGridPanel : : Slot ( 0 , 0 )
. HAlign ( HAlign_Right )
2014-09-04 09:59:45 -04:00
. VAlign ( VAlign_Center )
2014-08-14 07:42:47 -04:00
. Padding ( FMargin ( 2.0f ) )
[
SNew ( STextBlock )
. TextStyle ( FEditorStyle : : Get ( ) , " TutorialEditableText.Toolbar.Text " )
. Text ( LOCTEXT ( " HyperlinkNameLabel " , " Name: " ) )
]
+ SGridPanel : : Slot ( 1 , 0 )
. Padding ( FMargin ( 2.0f ) )
[
SNew ( SBox )
. WidthOverride ( 300 )
[
2014-09-03 06:25:58 -04:00
SAssignNew ( HyperlinkNameTextBlock , STextBlock )
. TextStyle ( FEditorStyle : : Get ( ) , " TutorialEditableText.Toolbar.Text " )
2014-08-14 07:42:47 -04:00
]
]
+ SGridPanel : : Slot ( 0 , 1 )
. HAlign ( HAlign_Right )
2014-09-04 09:59:45 -04:00
. VAlign ( VAlign_Center )
2014-08-14 07:42:47 -04:00
. Padding ( FMargin ( 2.0f ) )
[
SNew ( STextBlock )
. TextStyle ( FEditorStyle : : Get ( ) , " TutorialEditableText.Toolbar.Text " )
. Text ( LOCTEXT ( " HyperlinkURLLabel " , " URL: " ) )
]
+ SGridPanel : : Slot ( 1 , 1 )
. Padding ( FMargin ( 2.0f ) )
[
SNew ( SBox )
. WidthOverride ( 300 )
[
SAssignNew ( HyperlinkURLTextBox , SEditableTextBox )
]
]
+ SGridPanel : : Slot ( 0 , 2 )
. HAlign ( HAlign_Right )
2014-09-04 09:59:45 -04:00
. VAlign ( VAlign_Center )
2014-08-14 07:42:47 -04:00
. Padding ( FMargin ( 2.0f ) )
2014-09-04 09:59:45 -04:00
[
SNew ( STextBlock )
. TextStyle ( FEditorStyle : : Get ( ) , " TutorialEditableText.Toolbar.Text " )
. Text ( LOCTEXT ( " HyperlinkTypeLabel " , " Type: " ) )
]
+ SGridPanel : : Slot ( 1 , 2 )
. Padding ( FMargin ( 2.0f ) )
. VAlign ( VAlign_Center )
2014-08-14 07:42:47 -04:00
. ColumnSpan ( 2 )
[
SNew ( SHorizontalBox )
+ SHorizontalBox : : Slot ( )
. AutoWidth ( )
. VAlign ( VAlign_Center )
[
2014-09-04 09:59:45 -04:00
SNew ( SComboBox < TSharedPtr < FHyperlinkTypeDesc > > )
. OptionsSource ( & HyperlinkDescs )
. ComboBoxStyle ( FEditorStyle : : Get ( ) , " TutorialEditableText.Toolbar.ComboBox " )
. OnSelectionChanged ( this , & STutorialEditableText : : OnActiveHyperlinkChanged )
. OnGenerateWidget ( this , & STutorialEditableText : : GenerateHyperlinkComboEntry )
. ContentPadding ( 0.0f )
. InitiallySelectedItem ( HyperlinkDescs [ 0 ] )
. Content ( )
2014-08-14 07:42:47 -04:00
[
2014-09-04 09:59:45 -04:00
SNew ( SBox )
. Padding ( FMargin ( 0.0f , 0.0f , 2.0f , 0.0f ) )
. MinDesiredWidth ( 100.0f )
[
SNew ( STextBlock )
. TextStyle ( FEditorStyle : : Get ( ) , " TutorialEditableText.Toolbar.Text " )
. Text ( this , & STutorialEditableText : : GetActiveHyperlinkName )
. ToolTipText ( this , & STutorialEditableText : : GetActiveHyperlinkTooltip )
]
2014-08-14 07:42:47 -04:00
]
]
+ SHorizontalBox : : Slot ( )
. AutoWidth ( )
. VAlign ( VAlign_Center )
2014-09-04 09:59:45 -04:00
. Padding ( 5.0f , 0.0f , 0.0f , 0.0f )
2014-08-14 07:42:47 -04:00
[
SNew ( SCheckBox )
2014-09-04 09:59:45 -04:00
. ToolTipText ( LOCTEXT ( " OpenAssetTooltip " , " Should this link open the asset or just highlight it in the content browser? " ) )
. Visibility ( this , & STutorialEditableText : : GetOpenAssetVisibility )
. IsChecked ( this , & STutorialEditableText : : IsOpenAssetChecked )
. OnCheckStateChanged ( this , & STutorialEditableText : : HandleOpenAssetCheckStateChanged )
2014-08-14 07:42:47 -04:00
[
SNew ( STextBlock )
. TextStyle ( FEditorStyle : : Get ( ) , " TutorialEditableText.Toolbar.Text " )
2014-09-04 09:59:45 -04:00
. Text ( LOCTEXT ( " OpenAssetLabel " , " Open Asset " ) )
2014-08-14 07:42:47 -04:00
]
]
+ SHorizontalBox : : Slot ( )
2014-09-04 09:59:45 -04:00
. FillWidth ( 1.0f )
2014-08-14 07:42:47 -04:00
. VAlign ( VAlign_Center )
2014-09-04 09:59:45 -04:00
. HAlign ( HAlign_Right )
2014-08-14 07:42:47 -04:00
[
SNew ( SButton )
. ButtonStyle ( FEditorStyle : : Get ( ) , " TutorialEditableText.Toolbar.Button " )
2014-09-03 06:25:58 -04:00
. OnClicked ( this , & STutorialEditableText : : HandleInsertHyperLinkClicked )
2014-08-14 07:42:47 -04:00
[
SNew ( STextBlock )
. TextStyle ( FEditorStyle : : Get ( ) , " TutorialEditableText.Toolbar.Text " )
2014-09-03 06:25:58 -04:00
. Text ( this , & STutorialEditableText : : GetHyperlinkButtonText )
2014-08-14 07:42:47 -04:00
]
]
]
]
]
]
]
] ;
}
END_SLATE_FUNCTION_BUILD_OPTIMIZATION
void STutorialEditableText : : HandleRichEditableTextChanged ( const FText & Text )
{
OnTextChanged . ExecuteIfBound ( Text ) ;
}
void STutorialEditableText : : HandleRichEditableTextCommitted ( const FText & Text , ETextCommit : : Type Type )
{
OnTextCommitted . ExecuteIfBound ( Text , Type ) ;
}
2014-09-03 06:25:58 -04:00
static bool AreRunsTheSame ( const TArray < TSharedRef < const IRun > > & Runs )
{
if ( Runs . Num ( ) = = 0 )
{
return false ;
}
TSharedRef < const IRun > FirstRun = Runs [ 0 ] ;
for ( const auto & Run : Runs )
{
if ( Run ! = FirstRun )
{
if ( Run - > GetRunInfo ( ) . Name ! = FirstRun - > GetRunInfo ( ) . Name )
{
return false ;
}
for ( const auto & MetaData : FirstRun - > GetRunInfo ( ) . MetaData )
{
const FString * FoundMetaData = Run - > GetRunInfo ( ) . MetaData . Find ( MetaData . Key ) ;
if ( FoundMetaData = = nullptr | | * FoundMetaData ! = MetaData . Value )
{
return false ;
}
}
}
}
return true ;
}
TSharedPtr < const IRun > STutorialEditableText : : GetCurrentRun ( ) const
{
if ( ! RichEditableTextBox - > GetSelectedText ( ) . IsEmpty ( ) )
{
const TArray < TSharedRef < const IRun > > Runs = RichEditableTextBox - > GetSelectedRuns ( ) ;
if ( Runs . Num ( ) = = 1 | | AreRunsTheSame ( Runs ) )
{
return Runs [ 0 ] ;
}
}
else
{
return RichEditableTextBox - > GetRunUnderCursor ( ) ;
}
return TSharedPtr < const IRun > ( ) ;
}
2014-08-14 07:42:47 -04:00
void STutorialEditableText : : HandleRichEditableTextCursorMoved ( const FTextLocation & NewCursorPosition )
{
2014-09-03 06:25:58 -04:00
TSharedPtr < const IRun > Run = GetCurrentRun ( ) ;
if ( Run . IsValid ( ) )
2014-08-14 07:42:47 -04:00
{
2014-09-03 06:25:58 -04:00
if ( Run - > GetRunInfo ( ) . Name = = TEXT ( " TextStyle " ) )
{
ActiveStyle = StylesAndNames [ 0 ] ;
2014-08-14 07:42:47 -04:00
2014-09-03 06:25:58 -04:00
FName StyleName = FTextStyleAndName : : GetStyleFromRunInfo ( Run - > GetRunInfo ( ) ) ;
for ( const auto & StyleAndName : StylesAndNames )
{
if ( StyleAndName - > Style = = StyleName )
{
ActiveStyle = StyleAndName ;
break ;
}
}
}
else if ( Run - > GetRunInfo ( ) . Name = = TEXT ( " a " ) )
{
ActiveStyle = HyperlinkStyle ;
}
2014-08-14 07:42:47 -04:00
2014-09-03 06:25:58 -04:00
FontComboBox - > SetSelectedItem ( ActiveStyle ) ;
2014-08-14 07:42:47 -04:00
}
else
{
2014-09-03 06:25:58 -04:00
FontComboBox - > SetSelectedItem ( nullptr ) ;
2014-08-14 07:42:47 -04:00
}
}
2014-09-03 06:25:58 -04:00
FText STutorialEditableText : : GetActiveStyleName ( ) const
2014-08-14 07:42:47 -04:00
{
2014-09-03 06:25:58 -04:00
return ActiveStyle . IsValid ( ) ? ActiveStyle - > DisplayName : FText ( ) ;
2014-08-14 07:42:47 -04:00
}
2014-09-03 06:25:58 -04:00
void STutorialEditableText : : OnActiveStyleChanged ( TSharedPtr < FTextStyleAndName > NewValue , ESelectInfo : : Type SelectionType )
2014-08-14 07:42:47 -04:00
{
2014-09-03 06:25:58 -04:00
ActiveStyle = NewValue ;
if ( SelectionType ! = ESelectInfo : : Direct )
2014-08-14 07:42:47 -04:00
{
2014-09-03 06:25:58 -04:00
// style text if it was the user that made this selection
if ( NewValue = = HyperlinkStyle )
{
HandleHyperlinkComboOpened ( ) ;
HyperlinkComboButton - > SetIsOpen ( true ) ;
}
else
{
StyleSelectedText ( ) ;
}
2014-08-14 07:42:47 -04:00
}
}
2014-09-03 06:25:58 -04:00
TSharedRef < SWidget > STutorialEditableText : : GenerateStyleComboEntry ( TSharedPtr < FTextStyleAndName > SourceEntry )
2014-08-14 07:42:47 -04:00
{
2014-09-03 06:25:58 -04:00
return SNew ( SBorder )
. BorderImage ( FCoreStyle : : Get ( ) . GetBrush ( " NoBorder " ) )
. ForegroundColor ( FCoreStyle : : Get ( ) . GetSlateColor ( " InvertedForeground " ) )
[
SNew ( STextBlock )
. Text ( SourceEntry - > DisplayName )
. TextStyle ( & FEditorStyle : : Get ( ) . GetWidgetStyle < FTextBlockStyle > ( SourceEntry - > Style ) )
] ;
2014-08-14 07:42:47 -04:00
}
void STutorialEditableText : : StyleSelectedText ( )
{
// Apply the current style to the selected text
// If no text is selected, then a new (empty) run will be inserted with the appropriate style
2014-09-03 06:25:58 -04:00
if ( ActiveStyle . IsValid ( ) )
{
const FRunInfo RunInfo = ActiveStyle - > CreateRunInfo ( ) ;
const FTextBlockStyle TextBlockStyle = ActiveStyle - > CreateTextBlockStyle ( ) ;
RichEditableTextBox - > ApplyToSelection ( RunInfo , TextBlockStyle ) ;
FSlateApplication : : Get ( ) . SetKeyboardFocus ( RichEditableTextBox , EKeyboardFocusCause : : SetDirectly ) ;
}
2014-08-14 07:42:47 -04:00
}
2014-09-04 09:59:45 -04:00
TSharedPtr < FHyperlinkTypeDesc > STutorialEditableText : : GetHyperlinkTypeFromId ( const FString & InId ) const
{
TSharedPtr < FHyperlinkTypeDesc > FoundType ;
for ( const auto & Desc : HyperlinkDescs )
{
if ( Desc - > Id = = InId )
{
return Desc ;
}
}
return FoundType ;
}
2014-09-03 06:25:58 -04:00
2014-08-14 07:42:47 -04:00
void STutorialEditableText : : HandleHyperlinkComboOpened ( )
{
2014-09-03 06:25:58 -04:00
HyperlinkURLTextBox - > SetText ( FText ( ) ) ;
HyperlinkNameTextBlock - > SetText ( FText ( ) ) ;
2014-08-14 07:42:47 -04:00
// Read any currently selected text, and use this as the default name of the hyperlink
FString SelectedText = RichEditableTextBox - > GetSelectedText ( ) . ToString ( ) ;
2014-09-03 06:25:58 -04:00
if ( SelectedText . Len ( ) > 0 )
2014-08-14 07:42:47 -04:00
{
2014-09-03 06:25:58 -04:00
for ( int32 SelectedTextIndex = 0 ; SelectedTextIndex < SelectedText . Len ( ) ; + + SelectedTextIndex )
2014-08-14 07:42:47 -04:00
{
2014-09-03 06:25:58 -04:00
if ( FChar : : IsLinebreak ( SelectedText [ SelectedTextIndex ] ) )
{
SelectedText = SelectedText . Left ( SelectedTextIndex ) ;
break ;
}
2014-08-14 07:42:47 -04:00
}
2014-09-03 06:25:58 -04:00
HyperlinkNameTextBlock - > SetText ( FText : : FromString ( SelectedText ) ) ;
2014-08-14 07:42:47 -04:00
}
2014-09-03 06:25:58 -04:00
TSharedPtr < const IRun > Run = GetCurrentRun ( ) ;
2014-08-14 07:42:47 -04:00
if ( Run . IsValid ( ) & & Run - > GetRunInfo ( ) . Name = = TEXT ( " a " ) )
{
const FString * const URLUnderCursor = Run - > GetRunInfo ( ) . MetaData . Find ( TEXT ( " href " ) ) ;
HyperlinkURLTextBox - > SetText ( ( URLUnderCursor ) ? FText : : FromString ( * URLUnderCursor ) : FText ( ) ) ;
2014-09-04 09:59:45 -04:00
const FString * const IdUnderCursor = Run - > GetRunInfo ( ) . MetaData . Find ( TEXT ( " id " ) ) ;
CurrentHyperlinkType = IdUnderCursor ? GetHyperlinkTypeFromId ( * IdUnderCursor ) : HyperlinkDescs [ 0 ] ;
2014-09-03 06:25:58 -04:00
FString RunText ;
Run - > AppendTextTo ( RunText ) ;
HyperlinkNameTextBlock - > SetText ( FText : : FromString ( RunText ) ) ;
}
2014-08-14 07:42:47 -04:00
}
2014-09-03 06:25:58 -04:00
bool STutorialEditableText : : IsHyperlinkComboEnabled ( ) const
{
return ActiveStyle = = HyperlinkStyle ;
}
FReply STutorialEditableText : : HandleInsertHyperLinkClicked ( )
2014-08-14 07:42:47 -04:00
{
HyperlinkComboButton - > SetIsOpen ( false ) ;
2014-09-03 06:25:58 -04:00
const FText & Name = HyperlinkNameTextBlock - > GetText ( ) ;
if ( ! Name . IsEmpty ( ) )
{
const FText & URL = HyperlinkURLTextBox - > GetText ( ) ;
2014-08-14 07:42:47 -04:00
2014-09-03 06:25:58 -04:00
// Create the correct meta-information for this run, so that valid source rich-text formatting can be generated for it
FRunInfo RunInfo ( TEXT ( " a " ) ) ;
2014-09-04 09:59:45 -04:00
RunInfo . MetaData . Add ( TEXT ( " id " ) , CurrentHyperlinkType - > Id ) ;
2014-09-03 06:25:58 -04:00
RunInfo . MetaData . Add ( TEXT ( " href " ) , URL . ToString ( ) ) ;
RunInfo . MetaData . Add ( TEXT ( " style " ) , TEXT ( " Tutorials.Content.Hyperlink " ) ) ;
2014-08-14 07:42:47 -04:00
2014-09-04 09:59:45 -04:00
if ( CurrentHyperlinkType - > Type = = EHyperlinkType : : Asset )
{
RunInfo . MetaData . Add ( TEXT ( " action " ) , bOpenAsset ? TEXT ( " edit " ) : TEXT ( " select " ) ) ;
}
2014-09-03 06:25:58 -04:00
// Create the new run, and then insert it at the cursor position
TSharedRef < FSlateHyperlinkRun > HyperlinkRun = FSlateHyperlinkRun : : Create (
RunInfo ,
MakeShareable ( new FString ( Name . ToString ( ) ) ) ,
FEditorStyle : : Get ( ) . GetWidgetStyle < FHyperlinkStyle > ( FName ( TEXT ( " Tutorials.Content.Hyperlink " ) ) ) ,
2014-09-04 09:59:45 -04:00
CurrentHyperlinkType - > OnClickedDelegate
2014-09-03 06:25:58 -04:00
) ;
// @todo: if the rich editable text box allowed us to replace a run that we found under the cursor (or returned a non-const
// instance of it) then we could edit the hyperlink here. This would mean the user does not need to select the whole hyperlink
// to edit its URL.
RichEditableTextBox - > InsertRunAtCursor ( HyperlinkRun ) ;
}
2014-08-14 07:42:47 -04:00
return FReply : : Handled ( ) ;
}
EVisibility STutorialEditableText : : GetToolbarVisibility ( ) const
{
2014-09-03 06:25:58 -04:00
return FontComboBox - > IsOpen ( ) | | HyperlinkComboButton - > IsOpen ( ) | | HasKeyboardFocus ( ) | | HasFocusedDescendants ( ) ? EVisibility : : Visible : EVisibility : : Collapsed ;
2014-08-14 07:42:47 -04:00
}
2014-09-03 06:25:58 -04:00
FText STutorialEditableText : : GetHyperlinkButtonText ( ) const
{
return bNewHyperlink ? LOCTEXT ( " HyperlinkInsertLabel " , " Insert Hyperlink " ) : LOCTEXT ( " HyperlinkSetLabel " , " Set Hyperlink " ) ;
}
2014-09-04 09:59:45 -04:00
void STutorialEditableText : : OnActiveHyperlinkChanged ( TSharedPtr < FHyperlinkTypeDesc > NewValue , ESelectInfo : : Type SelectionType )
{
CurrentHyperlinkType = NewValue ;
}
TSharedRef < SWidget > STutorialEditableText : : GenerateHyperlinkComboEntry ( TSharedPtr < FHyperlinkTypeDesc > SourceEntry )
{
return SNew ( SBorder )
. BorderImage ( FCoreStyle : : Get ( ) . GetBrush ( " NoBorder " ) )
. ForegroundColor ( FCoreStyle : : Get ( ) . GetSlateColor ( " InvertedForeground " ) )
[
SNew ( STextBlock )
. Text ( SourceEntry - > Text )
. ToolTipText ( SourceEntry - > TooltipText )
. TextStyle ( & FEditorStyle : : Get ( ) . GetWidgetStyle < FTextBlockStyle > ( " TutorialEditableText.Toolbar.Text " ) )
] ;
}
FText STutorialEditableText : : GetActiveHyperlinkName ( ) const
{
if ( CurrentHyperlinkType . IsValid ( ) )
{
return CurrentHyperlinkType - > Text ;
}
return FText ( ) ;
}
FText STutorialEditableText : : GetActiveHyperlinkTooltip ( ) const
{
if ( CurrentHyperlinkType . IsValid ( ) )
{
return CurrentHyperlinkType - > TooltipText ;
}
return FText ( ) ;
}
EVisibility STutorialEditableText : : GetOpenAssetVisibility ( ) const
{
return CurrentHyperlinkType . IsValid ( ) & & CurrentHyperlinkType - > Type = = EHyperlinkType : : Asset ? EVisibility : : Visible : EVisibility : : Collapsed ;
}
void STutorialEditableText : : HandleOpenAssetCheckStateChanged ( ESlateCheckBoxState : : Type InCheckState )
{
bOpenAsset = ! bOpenAsset ;
}
ESlateCheckBoxState : : Type STutorialEditableText : : IsOpenAssetChecked ( ) const
{
return bOpenAsset ? ESlateCheckBoxState : : Checked : ESlateCheckBoxState : : Unchecked ;
}
2014-08-14 07:42:47 -04:00
# undef LOCTEXT_NAMESPACE