You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
6248f8d412
#preflight 6272a74d2f6d177be3c6fdda #rb Matt.Kuhlenschmidt #ROBOMERGE-OWNER: Lauren.Barnes #ROBOMERGE-AUTHOR: lauren.barnes #ROBOMERGE-SOURCE: CL 20057269 via CL 20070159 via CL 20072035 via CL 20072203 #ROBOMERGE-BOT: UE5 (Release-Engine-Staging -> Main) (v943-19904690) #ROBOMERGE-CONFLICT from-shelf [CL 20105363 by Lauren Barnes in ue5-main branch]
420 lines
12 KiB
C++
420 lines
12 KiB
C++
// Copyright Epic Games, Inc. All Rights Reserved.
|
|
|
|
#include "SDocumentationToolTip.h"
|
|
#include "Misc/Paths.h"
|
|
#include "HAL/FileManager.h"
|
|
#include "Modules/ModuleManager.h"
|
|
#include "Widgets/SBoxPanel.h"
|
|
#include "Framework/Application/SlateApplication.h"
|
|
#include "Widgets/Text/STextBlock.h"
|
|
#include "Widgets/Layout/SBox.h"
|
|
#include "Widgets/SToolTip.h"
|
|
#include "Styling/AppStyle.h"
|
|
#include "Editor/EditorPerProjectUserSettings.h"
|
|
#include "IDocumentationPage.h"
|
|
#include "IDocumentation.h"
|
|
#include "DocumentationLink.h"
|
|
#include "ISourceCodeAccessor.h"
|
|
#include "ISourceCodeAccessModule.h"
|
|
#include "SourceControlHelpers.h"
|
|
#include "EngineAnalytics.h"
|
|
#include "AnalyticsEventAttribute.h"
|
|
#include "Interfaces/IAnalyticsProvider.h"
|
|
#include "Widgets/Input/SHyperlink.h"
|
|
#include "Framework/Notifications/NotificationManager.h"
|
|
#include "Widgets/Notifications/SNotificationList.h"
|
|
|
|
void SDocumentationToolTip::Construct( const FArguments& InArgs )
|
|
{
|
|
TextContent = InArgs._Text;
|
|
StyleInfo = FAppStyle::GetWidgetStyle<FTextBlockStyle>(InArgs._Style);
|
|
SubduedStyleInfo = FAppStyle::GetWidgetStyle<FTextBlockStyle>(InArgs._SubduedStyle);
|
|
HyperlinkTextStyleInfo = FAppStyle::GetWidgetStyle<FTextBlockStyle>(InArgs._HyperlinkTextStyle);
|
|
HyperlinkButtonStyleInfo = FAppStyle::GetWidgetStyle<FButtonStyle>(InArgs._HyperlinkButtonStyle);
|
|
ColorAndOpacity = InArgs._ColorAndOpacity;
|
|
DocumentationLink = InArgs._DocumentationLink;
|
|
IsDisplayingDocumentationLink = false;
|
|
bAddDocumentation = InArgs._AddDocumentation;
|
|
DocumentationMargin = InArgs._DocumentationMargin;
|
|
|
|
if ( !DocumentationLink.IsEmpty() )
|
|
{
|
|
// All in-editor udn documents must live under the Shared/ folder
|
|
ensure( InArgs._DocumentationLink.StartsWith( TEXT("Shared/") ) );
|
|
}
|
|
|
|
ExcerptName = InArgs._ExcerptName;
|
|
IsShowingFullTip = false;
|
|
|
|
if( InArgs._Content.Widget != SNullWidget::NullWidget )
|
|
{
|
|
// Widget content argument takes precedence
|
|
// overrides the text content.
|
|
OverrideContent = InArgs._Content.Widget;
|
|
}
|
|
|
|
ConstructSimpleTipContent();
|
|
|
|
ChildSlot
|
|
[
|
|
SAssignNew(WidgetContent, SBox)
|
|
[
|
|
SimpleTipContent.ToSharedRef()
|
|
]
|
|
];
|
|
}
|
|
|
|
void SDocumentationToolTip::ConstructSimpleTipContent()
|
|
{
|
|
TSharedPtr< SVerticalBox > VerticalBox;
|
|
if ( !OverrideContent.IsValid() )
|
|
{
|
|
SAssignNew( SimpleTipContent, SBox )
|
|
[
|
|
SAssignNew( VerticalBox, SVerticalBox )
|
|
+SVerticalBox::Slot()
|
|
.FillHeight( 1.0f )
|
|
[
|
|
SNew( STextBlock )
|
|
.Text( TextContent )
|
|
.TextStyle( &StyleInfo )
|
|
.ColorAndOpacity( ColorAndOpacity )
|
|
.WrapTextAt_Static( &SToolTip::GetToolTipWrapWidth )
|
|
]
|
|
];
|
|
}
|
|
else
|
|
{
|
|
SAssignNew( SimpleTipContent, SBox )
|
|
[
|
|
SAssignNew( VerticalBox, SVerticalBox )
|
|
+SVerticalBox::Slot()
|
|
.FillHeight( 1.0f )
|
|
[
|
|
OverrideContent.ToSharedRef()
|
|
]
|
|
];
|
|
}
|
|
|
|
if (bAddDocumentation)
|
|
{
|
|
AddDocumentation(VerticalBox);
|
|
}
|
|
}
|
|
|
|
void SDocumentationToolTip::AddDocumentation(TSharedPtr< SVerticalBox > VerticalBox)
|
|
{
|
|
if ( !DocumentationLink.IsEmpty() )
|
|
{
|
|
IsDisplayingDocumentationLink = GetDefault<UEditorPerProjectUserSettings>()->bDisplayDocumentationLink;
|
|
|
|
if ( IsDisplayingDocumentationLink )
|
|
{
|
|
FString OptionalExcerptName;
|
|
if ( !ExcerptName.IsEmpty() )
|
|
{
|
|
OptionalExcerptName = FString( TEXT(" [") ) + ExcerptName + TEXT("]");
|
|
}
|
|
|
|
VerticalBox->AddSlot()
|
|
.AutoHeight()
|
|
.Padding(0, 5, 0, 0)
|
|
.HAlign( HAlign_Center )
|
|
[
|
|
SNew( STextBlock )
|
|
.Text( FText::FromString(DocumentationLink + OptionalExcerptName) )
|
|
.TextStyle( &SubduedStyleInfo )
|
|
];
|
|
}
|
|
|
|
if ( !DocumentationPage.IsValid() )
|
|
{
|
|
DocumentationPage = IDocumentation::Get()->GetPage( DocumentationLink, NULL );
|
|
}
|
|
|
|
if ( DocumentationPage->HasExcerpt( ExcerptName ) )
|
|
{
|
|
FText MacShortcut = NSLOCTEXT("SToolTip", "MacRichTooltipShortcut", "(Command + Option)");
|
|
FText WinShortcut = NSLOCTEXT("SToolTip", "WinRichTooltipShortcut", "(Ctrl + Alt)");
|
|
|
|
FText KeyboardShortcut;
|
|
#if PLATFORM_MAC
|
|
KeyboardShortcut = MacShortcut;
|
|
#else
|
|
KeyboardShortcut = WinShortcut;
|
|
#endif
|
|
|
|
VerticalBox->AddSlot()
|
|
.AutoHeight()
|
|
.HAlign( HAlign_Center )
|
|
.Padding(0, 5, 0, 0)
|
|
[
|
|
SNew( STextBlock )
|
|
.TextStyle( &SubduedStyleInfo )
|
|
.Text( FText::Format( NSLOCTEXT( "SToolTip", "AdvancedToolTipMessage", "hold {0} for more" ), KeyboardShortcut) )
|
|
];
|
|
}
|
|
else
|
|
{
|
|
if ( IsDisplayingDocumentationLink && FSlateApplication::Get().SupportsSourceAccess() )
|
|
{
|
|
FString DocPath = FDocumentationLink::ToSourcePath( DocumentationLink, FInternationalization::Get().GetCurrentCulture() );
|
|
if ( !FPaths::FileExists(DocPath) )
|
|
{
|
|
DocPath = FPaths::ConvertRelativePathToFull(DocPath);
|
|
}
|
|
|
|
VerticalBox->AddSlot()
|
|
.AutoHeight()
|
|
.Padding(0, 5, 0, 0)
|
|
.HAlign( HAlign_Center )
|
|
[
|
|
SNew( SHyperlink )
|
|
.Text( NSLOCTEXT( "SToolTip", "EditDocumentationMessage_Create", "create" ) )
|
|
.TextStyle( &HyperlinkTextStyleInfo )
|
|
.UnderlineStyle( &HyperlinkButtonStyleInfo )
|
|
.OnNavigate( this, &SDocumentationToolTip::CreateExcerpt, DocPath, ExcerptName )
|
|
];
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
void SDocumentationToolTip::CreateExcerpt( FString FileSource, FString InExcerptName )
|
|
{
|
|
FText CheckoutFailReason;
|
|
bool bNewFile = true;
|
|
bool bCheckoutOrAddSucceeded = true;
|
|
if (FPaths::FileExists(FileSource))
|
|
{
|
|
// Check out the existing file
|
|
bNewFile = false;
|
|
bCheckoutOrAddSucceeded = SourceControlHelpers::CheckoutOrMarkForAdd(FileSource, NSLOCTEXT("SToolTip", "DocumentationSCCActionDesc", "tool tip excerpt"), FOnPostCheckOut(), /*out*/ CheckoutFailReason);
|
|
}
|
|
|
|
FArchive* FileWriter = IFileManager::Get().CreateFileWriter( *FileSource, EFileWrite::FILEWRITE_Append | EFileWrite::FILEWRITE_AllowRead | EFileWrite::FILEWRITE_EvenIfReadOnly );
|
|
|
|
if (bNewFile)
|
|
{
|
|
FString UdnHeader;
|
|
UdnHeader += "Availability:NoPublish";
|
|
UdnHeader += LINE_TERMINATOR;
|
|
UdnHeader += "Title:";
|
|
UdnHeader += LINE_TERMINATOR;
|
|
UdnHeader += "Crumbs:";
|
|
UdnHeader += LINE_TERMINATOR;
|
|
UdnHeader += "Description:";
|
|
UdnHeader += LINE_TERMINATOR;
|
|
|
|
FileWriter->Serialize( TCHAR_TO_ANSI( *UdnHeader ), UdnHeader.Len() );
|
|
}
|
|
|
|
FString NewExcerpt;
|
|
NewExcerpt += LINE_TERMINATOR;
|
|
NewExcerpt += "[EXCERPT:";
|
|
NewExcerpt += InExcerptName;
|
|
NewExcerpt += "]";
|
|
NewExcerpt += LINE_TERMINATOR;
|
|
|
|
NewExcerpt += TextContent.Get().ToString();
|
|
NewExcerpt += LINE_TERMINATOR;
|
|
|
|
NewExcerpt += "[/EXCERPT:";
|
|
NewExcerpt += InExcerptName;
|
|
NewExcerpt += "]";
|
|
NewExcerpt += LINE_TERMINATOR;
|
|
|
|
if (!bNewFile)
|
|
{
|
|
FileWriter->Seek( FMath::Max( FileWriter->TotalSize(), (int64)0 ) );
|
|
}
|
|
|
|
FileWriter->Serialize( TCHAR_TO_ANSI( *NewExcerpt ), NewExcerpt.Len() );
|
|
|
|
FileWriter->Close();
|
|
delete FileWriter;
|
|
|
|
if (bNewFile)
|
|
{
|
|
// Add the new file
|
|
bCheckoutOrAddSucceeded = SourceControlHelpers::CheckoutOrMarkForAdd(FileSource, NSLOCTEXT("SToolTip", "DocumentationSCCActionDesc", "tool tip excerpt"), FOnPostCheckOut(), /*out*/ CheckoutFailReason);
|
|
}
|
|
|
|
ISourceCodeAccessModule& SourceCodeAccessModule = FModuleManager::LoadModuleChecked<ISourceCodeAccessModule>("SourceCodeAccess");
|
|
SourceCodeAccessModule.GetAccessor().OpenFileAtLine(FileSource, 0);
|
|
|
|
if (!bCheckoutOrAddSucceeded)
|
|
{
|
|
FNotificationInfo Info(CheckoutFailReason);
|
|
Info.ExpireDuration = 3.0f;
|
|
FSlateNotificationManager::Get().AddNotification(Info);
|
|
}
|
|
|
|
ReloadDocumentation();
|
|
}
|
|
|
|
void SDocumentationToolTip::ConstructFullTipContent()
|
|
{
|
|
TArray< FExcerpt > Excerpts;
|
|
DocumentationPage->GetExcerpts( Excerpts );
|
|
|
|
if ( Excerpts.Num() > 0 )
|
|
{
|
|
int32 ExcerptIndex = 0;
|
|
if ( !ExcerptName.IsEmpty() )
|
|
{
|
|
for (int Index = 0; Index < Excerpts.Num(); Index++)
|
|
{
|
|
if ( Excerpts[ Index ].Name == ExcerptName )
|
|
{
|
|
ExcerptIndex = Index;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
if ( !Excerpts[ ExcerptIndex ].Content.IsValid() )
|
|
{
|
|
DocumentationPage->GetExcerptContent( Excerpts[ ExcerptIndex ] );
|
|
}
|
|
|
|
if ( Excerpts[ ExcerptIndex ].Content.IsValid() )
|
|
{
|
|
TSharedPtr< SVerticalBox > Box;
|
|
FullTipContent =
|
|
SNew(SBox)
|
|
.Padding(DocumentationMargin)
|
|
[
|
|
SAssignNew(Box, SVerticalBox)
|
|
+ SVerticalBox::Slot()
|
|
.HAlign(HAlign_Center)
|
|
.AutoHeight()
|
|
[
|
|
Excerpts[ExcerptIndex].Content.ToSharedRef()
|
|
]
|
|
];
|
|
|
|
FString* FullDocumentationLink = Excerpts[ ExcerptIndex ].Variables.Find( TEXT("ToolTipFullLink") );
|
|
if ( FullDocumentationLink != NULL && !FullDocumentationLink->IsEmpty() )
|
|
{
|
|
struct Local
|
|
{
|
|
static void OpenLink( FString Link )
|
|
{
|
|
if (!IDocumentation::Get()->Open(Link, FDocumentationSourceInfo(TEXT("rich_tooltips"))))
|
|
{
|
|
FNotificationInfo Info( NSLOCTEXT("SToolTip", "FailedToOpenLink", "Failed to Open Link") );
|
|
FSlateNotificationManager::Get().AddNotification(Info);
|
|
}
|
|
}
|
|
};
|
|
|
|
Box->AddSlot()
|
|
.HAlign( HAlign_Center )
|
|
.AutoHeight()
|
|
[
|
|
SNew( SHyperlink )
|
|
.Text( NSLOCTEXT( "SToolTip", "GoToFullDocsLinkMessage", "see full documentation" ) )
|
|
.TextStyle( &HyperlinkTextStyleInfo )
|
|
.UnderlineStyle( &HyperlinkButtonStyleInfo )
|
|
.OnNavigate_Static( &Local::OpenLink, *FullDocumentationLink )
|
|
];
|
|
}
|
|
|
|
if ( GetDefault<UEditorPerProjectUserSettings>()->bDisplayDocumentationLink && FSlateApplication::Get().SupportsSourceAccess() )
|
|
{
|
|
struct Local
|
|
{
|
|
static void EditSource( FString Link, int32 LineNumber )
|
|
{
|
|
ISourceCodeAccessModule& SourceCodeAccessModule = FModuleManager::LoadModuleChecked<ISourceCodeAccessModule>("SourceCodeAccess");
|
|
SourceCodeAccessModule.GetAccessor().OpenFileAtLine(Link, LineNumber);
|
|
}
|
|
};
|
|
|
|
Box->AddSlot()
|
|
.AutoHeight()
|
|
.HAlign( HAlign_Center )
|
|
[
|
|
SNew( SHyperlink )
|
|
.Text( NSLOCTEXT( "SToolTip", "EditDocumentationMessage_Edit", "edit" ) )
|
|
.TextStyle( &HyperlinkTextStyleInfo )
|
|
.UnderlineStyle( &HyperlinkButtonStyleInfo )
|
|
.OnNavigate_Static(&Local::EditSource, FPaths::ConvertRelativePathToFull(FDocumentationLink::ToSourcePath(DocumentationLink, FInternationalization::Get().GetCurrentCulture())), Excerpts[ExcerptIndex].LineNumber)
|
|
];
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
FReply SDocumentationToolTip::ReloadDocumentation()
|
|
{
|
|
SimpleTipContent.Reset();
|
|
FullTipContent.Reset();
|
|
|
|
ConstructSimpleTipContent();
|
|
|
|
if ( DocumentationPage.IsValid() )
|
|
{
|
|
DocumentationPage->Reload();
|
|
|
|
if ( DocumentationPage->HasExcerpt( ExcerptName ) )
|
|
{
|
|
ConstructFullTipContent();
|
|
}
|
|
}
|
|
|
|
return FReply::Handled();
|
|
}
|
|
|
|
void SDocumentationToolTip::Tick( const FGeometry& AllottedGeometry, const double InCurrentTime, const float InDeltaTime )
|
|
{
|
|
const FModifierKeysState ModifierKeys = FSlateApplication::Get().GetModifierKeys();
|
|
const bool NeedsUpdate = IsDisplayingDocumentationLink != GetDefault<UEditorPerProjectUserSettings>()->bDisplayDocumentationLink;
|
|
|
|
if ( !IsShowingFullTip && ModifierKeys.IsAltDown() && ModifierKeys.IsControlDown() )
|
|
{
|
|
if ( !FullTipContent.IsValid() && DocumentationPage.IsValid() && DocumentationPage->HasExcerpt( ExcerptName ) )
|
|
{
|
|
ConstructFullTipContent();
|
|
}
|
|
else if ( GetDefault<UEditorPerProjectUserSettings>()->bDisplayDocumentationLink )
|
|
{
|
|
ReloadDocumentation();
|
|
}
|
|
|
|
if ( FullTipContent.IsValid() )
|
|
{
|
|
WidgetContent->SetContent( FullTipContent.ToSharedRef() );
|
|
IsShowingFullTip = true;
|
|
|
|
// Analytics event
|
|
if (FEngineAnalytics::IsAvailable())
|
|
{
|
|
TArray<FAnalyticsEventAttribute> Params;
|
|
Params.Add(FAnalyticsEventAttribute(TEXT("Page"), DocumentationLink));
|
|
Params.Add(FAnalyticsEventAttribute(TEXT("Excerpt"), ExcerptName));
|
|
|
|
FEngineAnalytics::GetProvider().RecordEvent(TEXT("Editor.Usage.Documentation.FullTooltipShown"), Params);
|
|
}
|
|
}
|
|
}
|
|
else if ( ( IsShowingFullTip || NeedsUpdate ) && ( !ModifierKeys.IsAltDown() || !ModifierKeys.IsControlDown() ) )
|
|
{
|
|
if ( NeedsUpdate )
|
|
{
|
|
ReloadDocumentation();
|
|
IsDisplayingDocumentationLink = GetDefault<UEditorPerProjectUserSettings>()->bDisplayDocumentationLink;
|
|
}
|
|
|
|
WidgetContent->SetContent( SimpleTipContent.ToSharedRef() );
|
|
IsShowingFullTip = false;
|
|
}
|
|
}
|
|
|
|
bool SDocumentationToolTip::IsInteractive() const
|
|
{
|
|
const FModifierKeysState ModifierKeys = FSlateApplication::Get().GetModifierKeys();
|
|
return ( DocumentationPage.IsValid() && ModifierKeys.IsAltDown() && ModifierKeys.IsControlDown() );
|
|
}
|