izzy/UnrealEngineUWP
0
0
Fork 0
mirror of https://github.com/izzy2lost/UnrealEngineUWP.git synced 2026-03-26 18:15:20 -07:00
Code Issues Packages Projects Releases Wiki Activity
Files
3c2010d281269994deefcc86297a79247a9aeb34
UnrealEngineUWP/Engine/Source/Editor/Documentation/Private/SDocumentationToolTip.cpp

420 lines
12 KiB
C++
Raw Normal View History

Updating copyright for Engine Editor. #rnx #rb none #ROBOMERGE-SOURCE: CL 10869241 via CL 10869527 via CL 10869904 #ROBOMERGE-BOT: (v613-10869866) [CL 10870586 by ryan durand in Main branch]
2019-12-26 15:33:43 -05:00
// Copyright Epic Games, Inc. All Rights Reserved.
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
#include "SDocumentationToolTip.h"
Copying //UE4/Dev-Build to //UE4/Dev-Main (Source: //UE4/Dev-Build @ 3209340) #lockdown Nick.Penwarden #rb none ========================== MAJOR FEATURES + CHANGES ========================== Change 3209340 on 2016/11/23 by Ben.Marsh Convert UE4 codebase to an "include what you use" model - where every header just includes the dependencies it needs, rather than every source file including large monolithic headers like Engine.h and UnrealEd.h. Measured full rebuild times around 2x faster using XGE on Windows, and improvements of 25% or more for incremental builds and full rebuilds on most other platforms. * Every header now includes everything it needs to compile. * There's a CoreMinimal.h header that gets you a set of ubiquitous types from Core (eg. FString, FName, TArray, FVector, etc...). Most headers now include this first. * There's a CoreTypes.h header that sets up primitive UE4 types and build macros (int32, PLATFORM_WIN64, etc...). All headers in Core include this first, as does CoreMinimal.h. * Every .cpp file includes its matching .h file first. * This helps validate that each header is including everything it needs to compile. * No engine code includes a monolithic header such as Engine.h or UnrealEd.h any more. * You will get a warning if you try to include one of these from the engine. They still exist for compatibility with game projects and do not produce warnings when included there. * There have only been minor changes to our internal games down to accommodate these changes. The intent is for this to be as seamless as possible. * No engine code explicitly includes a precompiled header any more. * We still use PCHs, but they're force-included on the compiler command line by UnrealBuildTool instead. This lets us tune what they contain without breaking any existing include dependencies. * PCHs are generated by a tool to get a statistical amount of coverage for the source files using it, and I've seeded the new shared PCHs to contain any header included by > 15% of source files. Tool used to generate this transform is at Engine\Source\Programs\IncludeTool. [CL 3209342 by Ben Marsh in Main branch]
2016-11-23 15:48:37 -05:00
#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"
Replacing legacy EditorStyle calls with AppStyle #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]
2022-05-09 13:12:28 -04:00
#include "Styling/AppStyle.h"
Copying //UE4/Dev-Build to //UE4/Dev-Main (Source: //UE4/Dev-Build @ 3209340) #lockdown Nick.Penwarden #rb none ========================== MAJOR FEATURES + CHANGES ========================== Change 3209340 on 2016/11/23 by Ben.Marsh Convert UE4 codebase to an "include what you use" model - where every header just includes the dependencies it needs, rather than every source file including large monolithic headers like Engine.h and UnrealEd.h. Measured full rebuild times around 2x faster using XGE on Windows, and improvements of 25% or more for incremental builds and full rebuilds on most other platforms. * Every header now includes everything it needs to compile. * There's a CoreMinimal.h header that gets you a set of ubiquitous types from Core (eg. FString, FName, TArray, FVector, etc...). Most headers now include this first. * There's a CoreTypes.h header that sets up primitive UE4 types and build macros (int32, PLATFORM_WIN64, etc...). All headers in Core include this first, as does CoreMinimal.h. * Every .cpp file includes its matching .h file first. * This helps validate that each header is including everything it needs to compile. * No engine code includes a monolithic header such as Engine.h or UnrealEd.h any more. * You will get a warning if you try to include one of these from the engine. They still exist for compatibility with game projects and do not produce warnings when included there. * There have only been minor changes to our internal games down to accommodate these changes. The intent is for this to be as seamless as possible. * No engine code explicitly includes a precompiled header any more. * We still use PCHs, but they're force-included on the compiler command line by UnrealBuildTool instead. This lets us tune what they contain without breaking any existing include dependencies. * PCHs are generated by a tool to get a statistical amount of coverage for the source files using it, and I've seeded the new shared PCHs to contain any header included by > 15% of source files. Tool used to generate this transform is at Engine\Source\Programs\IncludeTool. [CL 3209342 by Ben Marsh in Main branch]
2016-11-23 15:48:37 -05:00
#include "Editor/EditorPerProjectUserSettings.h"
#include "IDocumentationPage.h"
#include "IDocumentation.h"
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
#include "DocumentationLink.h"
Copying //UE4/Dev-Build to //UE4/Dev-Main (Source: //UE4/Dev-Build @ 3209340) #lockdown Nick.Penwarden #rb none ========================== MAJOR FEATURES + CHANGES ========================== Change 3209340 on 2016/11/23 by Ben.Marsh Convert UE4 codebase to an "include what you use" model - where every header just includes the dependencies it needs, rather than every source file including large monolithic headers like Engine.h and UnrealEd.h. Measured full rebuild times around 2x faster using XGE on Windows, and improvements of 25% or more for incremental builds and full rebuilds on most other platforms. * Every header now includes everything it needs to compile. * There's a CoreMinimal.h header that gets you a set of ubiquitous types from Core (eg. FString, FName, TArray, FVector, etc...). Most headers now include this first. * There's a CoreTypes.h header that sets up primitive UE4 types and build macros (int32, PLATFORM_WIN64, etc...). All headers in Core include this first, as does CoreMinimal.h. * Every .cpp file includes its matching .h file first. * This helps validate that each header is including everything it needs to compile. * No engine code includes a monolithic header such as Engine.h or UnrealEd.h any more. * You will get a warning if you try to include one of these from the engine. They still exist for compatibility with game projects and do not produce warnings when included there. * There have only been minor changes to our internal games down to accommodate these changes. The intent is for this to be as seamless as possible. * No engine code explicitly includes a precompiled header any more. * We still use PCHs, but they're force-included on the compiler command line by UnrealBuildTool instead. This lets us tune what they contain without breaking any existing include dependencies. * PCHs are generated by a tool to get a statistical amount of coverage for the source files using it, and I've seeded the new shared PCHs to contain any header included by > 15% of source files. Tool used to generate this transform is at Engine\Source\Programs\IncludeTool. [CL 3209342 by Ben Marsh in Main branch]
2016-11-23 15:48:37 -05:00
#include "ISourceCodeAccessor.h"
#summary Source code access is now done via plugins #ttp 330039 EDITOR: Platform-agnostic editor code depends on Windows-only VSAccessor headers #detail Source code access is now extensible via plugins, so any new editors can be easily added. #add Added SourceCodeAccess module that routes access via plugins. #change Moved much of the old VSAccessor code into a new VisualStudioSourceCodeAccess plugin. #add Added a counterpart XCode plugin & migrated the code from FSourceCodeNavigation (Applescript etc.) into there. #remove Removed applescript for XCode access (it is now done via code). #remove Removed source code access functionality from platform layer. #add Added details customization for source code access settings, so users can choose their own accessor. #remove Removed dependencies on VSAccessor. #change Changed API in SWidget to not require building a string to be parsed, instead this acesses and forwards filenames & line numbers. #extra Tested on Mac by Mark S. reviewed by Andrew.Brown [CL 2048697 by Thomas Sarkanen in Main branch]
2014-04-23 19:19:51 -04:00
#include "ISourceCodeAccessModule.h"
Copying //UE4/Dev-Build to //UE4/Dev-Main (Source: //UE4/Dev-Build @ 3209340) #lockdown Nick.Penwarden #rb none ========================== MAJOR FEATURES + CHANGES ========================== Change 3209340 on 2016/11/23 by Ben.Marsh Convert UE4 codebase to an "include what you use" model - where every header just includes the dependencies it needs, rather than every source file including large monolithic headers like Engine.h and UnrealEd.h. Measured full rebuild times around 2x faster using XGE on Windows, and improvements of 25% or more for incremental builds and full rebuilds on most other platforms. * Every header now includes everything it needs to compile. * There's a CoreMinimal.h header that gets you a set of ubiquitous types from Core (eg. FString, FName, TArray, FVector, etc...). Most headers now include this first. * There's a CoreTypes.h header that sets up primitive UE4 types and build macros (int32, PLATFORM_WIN64, etc...). All headers in Core include this first, as does CoreMinimal.h. * Every .cpp file includes its matching .h file first. * This helps validate that each header is including everything it needs to compile. * No engine code includes a monolithic header such as Engine.h or UnrealEd.h any more. * You will get a warning if you try to include one of these from the engine. They still exist for compatibility with game projects and do not produce warnings when included there. * There have only been minor changes to our internal games down to accommodate these changes. The intent is for this to be as seamless as possible. * No engine code explicitly includes a precompiled header any more. * We still use PCHs, but they're force-included on the compiler command line by UnrealBuildTool instead. This lets us tune what they contain without breaking any existing include dependencies. * PCHs are generated by a tool to get a statistical amount of coverage for the source files using it, and I've seeded the new shared PCHs to contain any header included by > 15% of source files. Tool used to generate this transform is at Engine\Source\Programs\IncludeTool. [CL 3209342 by Ben Marsh in Main branch]
2016-11-23 15:48:37 -05:00
#include "SourceControlHelpers.h"
Add analytics event for when Ctrl + Alt is used to show a rich tooltip [CL 2237209 by Marc Audy in Main branch]
2014-07-30 13:41:12 -04:00
#include "EngineAnalytics.h"
Copying //UE4/Dev-Build to //UE4/Dev-Main (Source: //UE4/Dev-Build @ 3209340) #lockdown Nick.Penwarden #rb none ========================== MAJOR FEATURES + CHANGES ========================== Change 3209340 on 2016/11/23 by Ben.Marsh Convert UE4 codebase to an "include what you use" model - where every header just includes the dependencies it needs, rather than every source file including large monolithic headers like Engine.h and UnrealEd.h. Measured full rebuild times around 2x faster using XGE on Windows, and improvements of 25% or more for incremental builds and full rebuilds on most other platforms. * Every header now includes everything it needs to compile. * There's a CoreMinimal.h header that gets you a set of ubiquitous types from Core (eg. FString, FName, TArray, FVector, etc...). Most headers now include this first. * There's a CoreTypes.h header that sets up primitive UE4 types and build macros (int32, PLATFORM_WIN64, etc...). All headers in Core include this first, as does CoreMinimal.h. * Every .cpp file includes its matching .h file first. * This helps validate that each header is including everything it needs to compile. * No engine code includes a monolithic header such as Engine.h or UnrealEd.h any more. * You will get a warning if you try to include one of these from the engine. They still exist for compatibility with game projects and do not produce warnings when included there. * There have only been minor changes to our internal games down to accommodate these changes. The intent is for this to be as seamless as possible. * No engine code explicitly includes a precompiled header any more. * We still use PCHs, but they're force-included on the compiler command line by UnrealBuildTool instead. This lets us tune what they contain without breaking any existing include dependencies. * PCHs are generated by a tool to get a statistical amount of coverage for the source files using it, and I've seeded the new shared PCHs to contain any header included by > 15% of source files. Tool used to generate this transform is at Engine\Source\Programs\IncludeTool. [CL 3209342 by Ben Marsh in Main branch]
2016-11-23 15:48:37 -05:00
#include "AnalyticsEventAttribute.h"
#include "Interfaces/IAnalyticsProvider.h"
#include "Widgets/Input/SHyperlink.h"
#include "Framework/Notifications/NotificationManager.h"
#include "Widgets/Notifications/SNotificationList.h"
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
void SDocumentationToolTip::Construct( const FArguments& InArgs )
{
TextContent = InArgs._Text;
Replacing legacy EditorStyle calls with AppStyle #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]
2022-05-09 13:12:28 -04:00
StyleInfo = FAppStyle::GetWidgetStyle<FTextBlockStyle>(InArgs._Style);
SubduedStyleInfo = FAppStyle::GetWidgetStyle<FTextBlockStyle>(InArgs._SubduedStyle);
HyperlinkTextStyleInfo = FAppStyle::GetWidgetStyle<FTextBlockStyle>(InArgs._HyperlinkTextStyle);
HyperlinkButtonStyleInfo = FAppStyle::GetWidgetStyle<FButtonStyle>(InArgs._HyperlinkButtonStyle);
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
ColorAndOpacity = InArgs._ColorAndOpacity;
DocumentationLink = InArgs._DocumentationLink;
IsDisplayingDocumentationLink = false;
[INTEGRATE] Change 2411673 by Chris.Gagnon@chris.gagnon_T4696 on 2015/01/19 19:20:57 SCS Editor now shows a root actor that you can select and see properties. Draging and dropping components to the graph from SCS editor creates Getters. Add components drop down has more common entries and better naming for some. [CL 2419383 by Ben Marsh in Main branch]
2015-01-26 18:13:04 -05:00
bAddDocumentation = InArgs._AddDocumentation;
DocumentationMargin = InArgs._DocumentationMargin;
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
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
[
[INTEGRATE] Change 2411673 by Chris.Gagnon@chris.gagnon_T4696 on 2015/01/19 19:20:57 SCS Editor now shows a root actor that you can select and see properties. Draging and dropping components to the graph from SCS editor creates Getters. Add components drop down has more common entries and better naming for some. [CL 2419383 by Ben Marsh in Main branch]
2015-01-26 18:13:04 -05:00
SAssignNew(WidgetContent, SBox)
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
[
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 )
Make Slate.ToolTipWrapWidth 1000 instead of 400 by default SDocumentationTooltip now uses Slate.ToolTipWrapWidth console variable instead of hardcoding 400 [CL 2230620 by Marc Audy in Main branch]
2014-07-24 16:36:06 -04:00
.WrapTextAt_Static( &SToolTip::GetToolTipWrapWidth )
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
]
];
}
else
{
SAssignNew( SimpleTipContent, SBox )
[
SAssignNew( VerticalBox, SVerticalBox )
+SVerticalBox::Slot()
.FillHeight( 1.0f )
[
[INTEGRATE] Change 2411673 by Chris.Gagnon@chris.gagnon_T4696 on 2015/01/19 19:20:57 SCS Editor now shows a root actor that you can select and see properties. Draging and dropping components to the graph from SCS editor creates Getters. Add components drop down has more common entries and better naming for some. [CL 2419383 by Ben Marsh in Main branch]
2015-01-26 18:13:04 -05:00
OverrideContent.ToSharedRef()
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
]
];
}
[INTEGRATE] Change 2411673 by Chris.Gagnon@chris.gagnon_T4696 on 2015/01/19 19:20:57 SCS Editor now shows a root actor that you can select and see properties. Draging and dropping components to the graph from SCS editor creates Getters. Add components drop down has more common entries and better naming for some. [CL 2419383 by Ben Marsh in Main branch]
2015-01-26 18:13:04 -05:00
if (bAddDocumentation)
{
AddDocumentation(VerticalBox);
}
}
void SDocumentationToolTip::AddDocumentation(TSharedPtr< SVerticalBox > VerticalBox)
{
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
if ( !DocumentationLink.IsEmpty() )
{
Added config migration path for newer versions of the engine. Newly installed versions of the engine will now attempt to copy the project-agnostic config settings from a previous engine installation. This happens by way of a versioned manifest that copies old versions when the manifest does not exist, or is a different version. This code path is benign for non-installed versions of the engine (or FPaths::ShouldSaveToUserDir() is false). EditorGameAgnosticSettings and EditorUserSettings ini paths have been renamed to EditorSettings and EditorPerProjectUserSettings respectively to better convey their purpose. In general, most settings should be saved in EditorSettings (project-agnostic) so that they apply regardless of which project is open. We have some way to go migrating existing settings for this to be the case, however. Some previously per-project configuration files are now project-agnostic (such as Editor.ini, EditorKeyBindings.ini, and EditorLayout.ini) GEditor->Access...Settings and GEditor->Get...Settings have been removed in favor of direct access of the CDO through GetMutableDefault<> and GetDefault<> respectively. Global config ini filenames that are not set up are now neither loaded nor saved on build machines, to handle the problem of indeterminate state more generically. This addresses UETOOL-270 (Most editor preferences should be project-agnostic) [CL 2517558 by Andrew Rodham in Main branch]
2015-04-20 10:12:55 -04:00
IsDisplayingDocumentationLink = GetDefault<UEditorPerProjectUserSettings>()->bDisplayDocumentationLink;
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
Added config migration path for newer versions of the engine. Newly installed versions of the engine will now attempt to copy the project-agnostic config settings from a previous engine installation. This happens by way of a versioned manifest that copies old versions when the manifest does not exist, or is a different version. This code path is benign for non-installed versions of the engine (or FPaths::ShouldSaveToUserDir() is false). EditorGameAgnosticSettings and EditorUserSettings ini paths have been renamed to EditorSettings and EditorPerProjectUserSettings respectively to better convey their purpose. In general, most settings should be saved in EditorSettings (project-agnostic) so that they apply regardless of which project is open. We have some way to go migrating existing settings for this to be the case, however. Some previously per-project configuration files are now project-agnostic (such as Editor.ini, EditorKeyBindings.ini, and EditorLayout.ini) GEditor->Access...Settings and GEditor->Get...Settings have been removed in favor of direct access of the CDO through GetMutableDefault<> and GetDefault<> respectively. Global config ini filenames that are not set up are now neither loaded nor saved on build machines, to handle the problem of indeterminate state more generically. This addresses UETOOL-270 (Most editor preferences should be project-agnostic) [CL 2517558 by Andrew Rodham in Main branch]
2015-04-20 10:12:55 -04:00
if ( IsDisplayingDocumentationLink )
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
{
FString OptionalExcerptName;
if ( !ExcerptName.IsEmpty() )
{
OptionalExcerptName = FString( TEXT(" [") ) + ExcerptName + TEXT("]");
}
VerticalBox->AddSlot()
Editor: Documentation: Updated the documentation code to allow proper fallback behavior for cultures missing documentation. [CL 2038747 by Justin Sargent in Main branch]
2014-04-23 16:43:22 -04:00
.AutoHeight()
[INTEGRATE] Change 2414097 by Mike.Fricker@MFRICKER_G3686_Alpha on 2015/01/21 13:43:14 New look and feel for Slate tool-tips - Tool-tips are now black on white so they stand out from the rest of the editor - Increased tool-tip font size by one point; increased the amount of padding - Only regular text-only tool-tips and documentation tool-tips are affected. We may update the various customized tool-tips later on. [CL 2419520 by Ben Marsh in Main branch]
2015-01-26 18:59:35 -05:00
.Padding(0, 5, 0, 0)
.HAlign( HAlign_Center )
Editor: Documentation: Updated the documentation code to allow proper fallback behavior for cultures missing documentation. [CL 2038747 by Justin Sargent in Main branch]
2014-04-23 16:43:22 -04:00
[
SNew( STextBlock )
Fixed code relying on SLATE_TEXT_ATTRIBUTE for STextBlock. UETOOL-213 - Minimize Slate FString -> FText conversion (remove SLATE_TEXT_ATTRIBUTE) This fixes any editor/engine specific code that was passing text to Slate as FString rather than FText. [CL 2399803 by Jamie Dale in Main branch]
2015-01-07 09:52:40 -05:00
.Text( FText::FromString(DocumentationLink + OptionalExcerptName) )
[INTEGRATE] Change 2414097 by Mike.Fricker@MFRICKER_G3686_Alpha on 2015/01/21 13:43:14 New look and feel for Slate tool-tips - Tool-tips are now black on white so they stand out from the rest of the editor - Increased tool-tip font size by one point; increased the amount of padding - Only regular text-only tool-tips and documentation tool-tips are affected. We may update the various customized tool-tips later on. [CL 2419520 by Ben Marsh in Main branch]
2015-01-26 18:59:35 -05:00
.TextStyle( &SubduedStyleInfo )
Editor: Documentation: Updated the documentation code to allow proper fallback behavior for cultures missing documentation. [CL 2038747 by Justin Sargent in Main branch]
2014-04-23 16:43:22 -04:00
];
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
}
if ( !DocumentationPage.IsValid() )
{
DocumentationPage = IDocumentation::Get()->GetPage( DocumentationLink, NULL );
}
if ( DocumentationPage->HasExcerpt( ExcerptName ) )
{
Swap Cmd+Alt to Command+Option to match modern Apple keyboards. #jira UE-70741 #rb will.damon [CL 16922491 by Richard Wallis in ue5-main branch]
2021-07-22 08:47:55 -04:00
FText MacShortcut = NSLOCTEXT("SToolTip", "MacRichTooltipShortcut", "(Command + Option)");
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
FText WinShortcut = NSLOCTEXT("SToolTip", "WinRichTooltipShortcut", "(Ctrl + Alt)");
FText KeyboardShortcut;
#if PLATFORM_MAC
KeyboardShortcut = MacShortcut;
#else
KeyboardShortcut = WinShortcut;
#endif
VerticalBox->AddSlot()
Editor: Documentation: Updated the documentation code to allow proper fallback behavior for cultures missing documentation. [CL 2038747 by Justin Sargent in Main branch]
2014-04-23 16:43:22 -04:00
.AutoHeight()
[INTEGRATE] Change 2414097 by Mike.Fricker@MFRICKER_G3686_Alpha on 2015/01/21 13:43:14 New look and feel for Slate tool-tips - Tool-tips are now black on white so they stand out from the rest of the editor - Increased tool-tip font size by one point; increased the amount of padding - Only regular text-only tool-tips and documentation tool-tips are affected. We may update the various customized tool-tips later on. [CL 2419520 by Ben Marsh in Main branch]
2015-01-26 18:59:35 -05:00
.HAlign( HAlign_Center )
.Padding(0, 5, 0, 0)
Editor: Documentation: Updated the documentation code to allow proper fallback behavior for cultures missing documentation. [CL 2038747 by Justin Sargent in Main branch]
2014-04-23 16:43:22 -04:00
[
SNew( STextBlock )
[INTEGRATE] Change 2414097 by Mike.Fricker@MFRICKER_G3686_Alpha on 2015/01/21 13:43:14 New look and feel for Slate tool-tips - Tool-tips are now black on white so they stand out from the rest of the editor - Increased tool-tip font size by one point; increased the amount of padding - Only regular text-only tool-tips and documentation tool-tips are affected. We may update the various customized tool-tips later on. [CL 2419520 by Ben Marsh in Main branch]
2015-01-26 18:59:35 -05:00
.TextStyle( &SubduedStyleInfo )
Editor: Documentation: Updated the documentation code to allow proper fallback behavior for cultures missing documentation. [CL 2038747 by Justin Sargent in Main branch]
2014-04-23 16:43:22 -04:00
.Text( FText::Format( NSLOCTEXT( "SToolTip", "AdvancedToolTipMessage", "hold {0} for more" ), KeyboardShortcut) )
];
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
}
else
{
Added config migration path for newer versions of the engine. Newly installed versions of the engine will now attempt to copy the project-agnostic config settings from a previous engine installation. This happens by way of a versioned manifest that copies old versions when the manifest does not exist, or is a different version. This code path is benign for non-installed versions of the engine (or FPaths::ShouldSaveToUserDir() is false). EditorGameAgnosticSettings and EditorUserSettings ini paths have been renamed to EditorSettings and EditorPerProjectUserSettings respectively to better convey their purpose. In general, most settings should be saved in EditorSettings (project-agnostic) so that they apply regardless of which project is open. We have some way to go migrating existing settings for this to be the case, however. Some previously per-project configuration files are now project-agnostic (such as Editor.ini, EditorKeyBindings.ini, and EditorLayout.ini) GEditor->Access...Settings and GEditor->Get...Settings have been removed in favor of direct access of the CDO through GetMutableDefault<> and GetDefault<> respectively. Global config ini filenames that are not set up are now neither loaded nor saved on build machines, to handle the problem of indeterminate state more generically. This addresses UETOOL-270 (Most editor preferences should be project-agnostic) [CL 2517558 by Andrew Rodham in Main branch]
2015-04-20 10:12:55 -04:00
if ( IsDisplayingDocumentationLink && FSlateApplication::Get().SupportsSourceAccess() )
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
{
#summary Internationalization now operates as a singleton with non-static initialization. Should no longer have issues with initializing before file server when applicable. Resolved related previous double initialization issue. API-breaking change for calls to most FInternationalization methods. #ttp 331776 - L10N: ICU: Executable size for engine and programs has regressed dramatically (ICU) [CL 2044493 by Saul Abreu in Main branch]
2014-04-23 18:30:01 -04:00
FString DocPath = FDocumentationLink::ToSourcePath( DocumentationLink, FInternationalization::Get().GetCurrentCulture() );
Editor: Documentation: Updated the documentation code to allow proper fallback behavior for cultures missing documentation. [CL 2038747 by Justin Sargent in Main branch]
2014-04-23 16:43:22 -04:00
if ( !FPaths::FileExists(DocPath) )
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
{
Editor: Documentation: Updated the documentation code to allow proper fallback behavior for cultures missing documentation. [CL 2038747 by Justin Sargent in Main branch]
2014-04-23 16:43:22 -04:00
DocPath = FPaths::ConvertRelativePathToFull(DocPath);
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
}
VerticalBox->AddSlot()
Editor: Documentation: Updated the documentation code to allow proper fallback behavior for cultures missing documentation. [CL 2038747 by Justin Sargent in Main branch]
2014-04-23 16:43:22 -04:00
.AutoHeight()
[INTEGRATE] Change 2414097 by Mike.Fricker@MFRICKER_G3686_Alpha on 2015/01/21 13:43:14 New look and feel for Slate tool-tips - Tool-tips are now black on white so they stand out from the rest of the editor - Increased tool-tip font size by one point; increased the amount of padding - Only regular text-only tool-tips and documentation tool-tips are affected. We may update the various customized tool-tips later on. [CL 2419520 by Ben Marsh in Main branch]
2015-01-26 18:59:35 -05:00
.Padding(0, 5, 0, 0)
.HAlign( HAlign_Center )
Editor: Documentation: Updated the documentation code to allow proper fallback behavior for cultures missing documentation. [CL 2038747 by Justin Sargent in Main branch]
2014-04-23 16:43:22 -04:00
[
SNew( SHyperlink )
.Text( NSLOCTEXT( "SToolTip", "EditDocumentationMessage_Create", "create" ) )
[INTEGRATE] Change 2414097 by Mike.Fricker@MFRICKER_G3686_Alpha on 2015/01/21 13:43:14 New look and feel for Slate tool-tips - Tool-tips are now black on white so they stand out from the rest of the editor - Increased tool-tip font size by one point; increased the amount of padding - Only regular text-only tool-tips and documentation tool-tips are affected. We may update the various customized tool-tips later on. [CL 2419520 by Ben Marsh in Main branch]
2015-01-26 18:59:35 -05:00
.TextStyle( &HyperlinkTextStyleInfo )
.UnderlineStyle( &HyperlinkButtonStyleInfo )
Editor: Documentation: Updated the documentation code to allow proper fallback behavior for cultures missing documentation. [CL 2038747 by Justin Sargent in Main branch]
2014-04-23 16:43:22 -04:00
.OnNavigate( this, &SDocumentationToolTip::CreateExcerpt, DocPath, ExcerptName )
];
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
}
}
}
}
Engine source (Main branch up to CL 2027006)
2014-03-15 01:14:25 -04:00
void SDocumentationToolTip::CreateExcerpt( FString FileSource, FString InExcerptName )
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
{
Editor: Added source control checkout or add when creating a new rich tooltip excerpt via the 'create' link #codereview nick.darnell [CL 2121411 by Michael Noland in Main branch]
2014-06-29 22:01:19 -04:00
FText CheckoutFailReason;
bool bNewFile = true;
bool bCheckoutOrAddSucceeded = true;
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
if (FPaths::FileExists(FileSource))
{
Editor: Added source control checkout or add when creating a new rich tooltip excerpt via the 'create' link #codereview nick.darnell [CL 2121411 by Michael Noland in Main branch]
2014-06-29 22:01:19 -04:00
// Check out the existing file
bNewFile = false;
bCheckoutOrAddSucceeded = SourceControlHelpers::CheckoutOrMarkForAdd(FileSource, NSLOCTEXT("SToolTip", "DocumentationSCCActionDesc", "tool tip excerpt"), FOnPostCheckOut(), /*out*/ CheckoutFailReason);
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
}
FArchive* FileWriter = IFileManager::Get().CreateFileWriter( *FileSource, EFileWrite::FILEWRITE_Append | EFileWrite::FILEWRITE_AllowRead | EFileWrite::FILEWRITE_EvenIfReadOnly );
Editor: Added source control checkout or add when creating a new rich tooltip excerpt via the 'create' link #codereview nick.darnell [CL 2121411 by Michael Noland in Main branch]
2014-06-29 22:01:19 -04:00
if (bNewFile)
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
{
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:";
Engine source (Main branch up to CL 2027006)
2014-03-15 01:14:25 -04:00
NewExcerpt += InExcerptName;
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
NewExcerpt += "]";
NewExcerpt += LINE_TERMINATOR;
NewExcerpt += TextContent.Get().ToString();
NewExcerpt += LINE_TERMINATOR;
NewExcerpt += "[/EXCERPT:";
Engine source (Main branch up to CL 2027006)
2014-03-15 01:14:25 -04:00
NewExcerpt += InExcerptName;
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
NewExcerpt += "]";
NewExcerpt += LINE_TERMINATOR;
Editor: Added source control checkout or add when creating a new rich tooltip excerpt via the 'create' link #codereview nick.darnell [CL 2121411 by Michael Noland in Main branch]
2014-06-29 22:01:19 -04:00
if (!bNewFile)
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
{
FileWriter->Seek( FMath::Max( FileWriter->TotalSize(), (int64)0 ) );
}
FileWriter->Serialize( TCHAR_TO_ANSI( *NewExcerpt ), NewExcerpt.Len() );
FileWriter->Close();
delete FileWriter;
Editor: Added source control checkout or add when creating a new rich tooltip excerpt via the 'create' link #codereview nick.darnell [CL 2121411 by Michael Noland in Main branch]
2014-06-29 22:01:19 -04:00
if (bNewFile)
{
// Add the new file
bCheckoutOrAddSucceeded = SourceControlHelpers::CheckoutOrMarkForAdd(FileSource, NSLOCTEXT("SToolTip", "DocumentationSCCActionDesc", "tool tip excerpt"), FOnPostCheckOut(), /*out*/ CheckoutFailReason);
}
#summary Source code access is now done via plugins #ttp 330039 EDITOR: Platform-agnostic editor code depends on Windows-only VSAccessor headers #detail Source code access is now extensible via plugins, so any new editors can be easily added. #add Added SourceCodeAccess module that routes access via plugins. #change Moved much of the old VSAccessor code into a new VisualStudioSourceCodeAccess plugin. #add Added a counterpart XCode plugin & migrated the code from FSourceCodeNavigation (Applescript etc.) into there. #remove Removed applescript for XCode access (it is now done via code). #remove Removed source code access functionality from platform layer. #add Added details customization for source code access settings, so users can choose their own accessor. #remove Removed dependencies on VSAccessor. #change Changed API in SWidget to not require building a string to be parsed, instead this acesses and forwards filenames & line numbers. #extra Tested on Mac by Mark S. reviewed by Andrew.Brown [CL 2048697 by Thomas Sarkanen in Main branch]
2014-04-23 19:19:51 -04:00
ISourceCodeAccessModule& SourceCodeAccessModule = FModuleManager::LoadModuleChecked<ISourceCodeAccessModule>("SourceCodeAccess");
SourceCodeAccessModule.GetAccessor().OpenFileAtLine(FileSource, 0);
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
Editor: Added source control checkout or add when creating a new rich tooltip excerpt via the 'create' link #codereview nick.darnell [CL 2121411 by Michael Noland in Main branch]
2014-06-29 22:01:19 -04:00
if (!bCheckoutOrAddSucceeded)
{
FNotificationInfo Info(CheckoutFailReason);
Info.ExpireDuration = 3.0f;
FSlateNotificationManager::Get().AddNotification(Info);
}
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
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 =
[INTEGRATE] Change 2411673 by Chris.Gagnon@chris.gagnon_T4696 on 2015/01/19 19:20:57 SCS Editor now shows a root actor that you can select and see properties. Draging and dropping components to the graph from SCS editor creates Getters. Add components drop down has more common entries and better naming for some. [CL 2419383 by Ben Marsh in Main branch]
2015-01-26 18:13:04 -05:00
SNew(SBox)
.Padding(DocumentationMargin)
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
[
[INTEGRATE] Change 2411673 by Chris.Gagnon@chris.gagnon_T4696 on 2015/01/19 19:20:57 SCS Editor now shows a root actor that you can select and see properties. Draging and dropping components to the graph from SCS editor creates Getters. Add components drop down has more common entries and better naming for some. [CL 2419383 by Ben Marsh in Main branch]
2015-01-26 18:13:04 -05:00
SAssignNew(Box, SVerticalBox)
+ SVerticalBox::Slot()
.HAlign(HAlign_Center)
.AutoHeight()
[
Excerpts[ExcerptIndex].Content.ToSharedRef()
]
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
];
FString* FullDocumentationLink = Excerpts[ ExcerptIndex ].Variables.Find( TEXT("ToolTipFullLink") );
if ( FullDocumentationLink != NULL && !FullDocumentationLink->IsEmpty() )
{
struct Local
{
static void OpenLink( FString Link )
{
Added information to documentation links URLs to be able to gather stats about where users are coming from when they view documentation. [CL 2406128 by Jeff Farris in Main branch]
2015-01-14 13:15:22 -05:00
if (!IDocumentation::Get()->Open(Link, FDocumentationSourceInfo(TEXT("rich_tooltips"))))
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
{
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" ) )
[INTEGRATE] Change 2414097 by Mike.Fricker@MFRICKER_G3686_Alpha on 2015/01/21 13:43:14 New look and feel for Slate tool-tips - Tool-tips are now black on white so they stand out from the rest of the editor - Increased tool-tip font size by one point; increased the amount of padding - Only regular text-only tool-tips and documentation tool-tips are affected. We may update the various customized tool-tips later on. [CL 2419520 by Ben Marsh in Main branch]
2015-01-26 18:59:35 -05:00
.TextStyle( &HyperlinkTextStyleInfo )
.UnderlineStyle( &HyperlinkButtonStyleInfo )
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
.OnNavigate_Static( &Local::OpenLink, *FullDocumentationLink )
];
}
Added config migration path for newer versions of the engine. Newly installed versions of the engine will now attempt to copy the project-agnostic config settings from a previous engine installation. This happens by way of a versioned manifest that copies old versions when the manifest does not exist, or is a different version. This code path is benign for non-installed versions of the engine (or FPaths::ShouldSaveToUserDir() is false). EditorGameAgnosticSettings and EditorUserSettings ini paths have been renamed to EditorSettings and EditorPerProjectUserSettings respectively to better convey their purpose. In general, most settings should be saved in EditorSettings (project-agnostic) so that they apply regardless of which project is open. We have some way to go migrating existing settings for this to be the case, however. Some previously per-project configuration files are now project-agnostic (such as Editor.ini, EditorKeyBindings.ini, and EditorLayout.ini) GEditor->Access...Settings and GEditor->Get...Settings have been removed in favor of direct access of the CDO through GetMutableDefault<> and GetDefault<> respectively. Global config ini filenames that are not set up are now neither loaded nor saved on build machines, to handle the problem of indeterminate state more generically. This addresses UETOOL-270 (Most editor preferences should be project-agnostic) [CL 2517558 by Andrew Rodham in Main branch]
2015-04-20 10:12:55 -04:00
if ( GetDefault<UEditorPerProjectUserSettings>()->bDisplayDocumentationLink && FSlateApplication::Get().SupportsSourceAccess() )
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
{
struct Local
{
#summary Source code access is now done via plugins #ttp 330039 EDITOR: Platform-agnostic editor code depends on Windows-only VSAccessor headers #detail Source code access is now extensible via plugins, so any new editors can be easily added. #add Added SourceCodeAccess module that routes access via plugins. #change Moved much of the old VSAccessor code into a new VisualStudioSourceCodeAccess plugin. #add Added a counterpart XCode plugin & migrated the code from FSourceCodeNavigation (Applescript etc.) into there. #remove Removed applescript for XCode access (it is now done via code). #remove Removed source code access functionality from platform layer. #add Added details customization for source code access settings, so users can choose their own accessor. #remove Removed dependencies on VSAccessor. #change Changed API in SWidget to not require building a string to be parsed, instead this acesses and forwards filenames & line numbers. #extra Tested on Mac by Mark S. reviewed by Andrew.Brown [CL 2048697 by Thomas Sarkanen in Main branch]
2014-04-23 19:19:51 -04:00
static void EditSource( FString Link, int32 LineNumber )
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
{
#summary Source code access is now done via plugins #ttp 330039 EDITOR: Platform-agnostic editor code depends on Windows-only VSAccessor headers #detail Source code access is now extensible via plugins, so any new editors can be easily added. #add Added SourceCodeAccess module that routes access via plugins. #change Moved much of the old VSAccessor code into a new VisualStudioSourceCodeAccess plugin. #add Added a counterpart XCode plugin & migrated the code from FSourceCodeNavigation (Applescript etc.) into there. #remove Removed applescript for XCode access (it is now done via code). #remove Removed source code access functionality from platform layer. #add Added details customization for source code access settings, so users can choose their own accessor. #remove Removed dependencies on VSAccessor. #change Changed API in SWidget to not require building a string to be parsed, instead this acesses and forwards filenames & line numbers. #extra Tested on Mac by Mark S. reviewed by Andrew.Brown [CL 2048697 by Thomas Sarkanen in Main branch]
2014-04-23 19:19:51 -04:00
ISourceCodeAccessModule& SourceCodeAccessModule = FModuleManager::LoadModuleChecked<ISourceCodeAccessModule>("SourceCodeAccess");
SourceCodeAccessModule.GetAccessor().OpenFileAtLine(Link, LineNumber);
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
}
};
Box->AddSlot()
.AutoHeight()
[INTEGRATE] Change 2414097 by Mike.Fricker@MFRICKER_G3686_Alpha on 2015/01/21 13:43:14 New look and feel for Slate tool-tips - Tool-tips are now black on white so they stand out from the rest of the editor - Increased tool-tip font size by one point; increased the amount of padding - Only regular text-only tool-tips and documentation tool-tips are affected. We may update the various customized tool-tips later on. [CL 2419520 by Ben Marsh in Main branch]
2015-01-26 18:59:35 -05:00
.HAlign( HAlign_Center )
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
[
SNew( SHyperlink )
.Text( NSLOCTEXT( "SToolTip", "EditDocumentationMessage_Edit", "edit" ) )
[INTEGRATE] Change 2414097 by Mike.Fricker@MFRICKER_G3686_Alpha on 2015/01/21 13:43:14 New look and feel for Slate tool-tips - Tool-tips are now black on white so they stand out from the rest of the editor - Increased tool-tip font size by one point; increased the amount of padding - Only regular text-only tool-tips and documentation tool-tips are affected. We may update the various customized tool-tips later on. [CL 2419520 by Ben Marsh in Main branch]
2015-01-26 18:59:35 -05:00
.TextStyle( &HyperlinkTextStyleInfo )
.UnderlineStyle( &HyperlinkButtonStyleInfo )
#summary Source code access is now done via plugins #ttp 330039 EDITOR: Platform-agnostic editor code depends on Windows-only VSAccessor headers #detail Source code access is now extensible via plugins, so any new editors can be easily added. #add Added SourceCodeAccess module that routes access via plugins. #change Moved much of the old VSAccessor code into a new VisualStudioSourceCodeAccess plugin. #add Added a counterpart XCode plugin & migrated the code from FSourceCodeNavigation (Applescript etc.) into there. #remove Removed applescript for XCode access (it is now done via code). #remove Removed source code access functionality from platform layer. #add Added details customization for source code access settings, so users can choose their own accessor. #remove Removed dependencies on VSAccessor. #change Changed API in SWidget to not require building a string to be parsed, instead this acesses and forwards filenames & line numbers. #extra Tested on Mac by Mark S. reviewed by Andrew.Brown [CL 2048697 by Thomas Sarkanen in Main branch]
2014-04-23 19:19:51 -04:00
.OnNavigate_Static(&Local::EditSource, FPaths::ConvertRelativePathToFull(FDocumentationLink::ToSourcePath(DocumentationLink, FInternationalization::Get().GetCurrentCulture())), Excerpts[ExcerptIndex].LineNumber)
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
];
}
}
}
}
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();
Added config migration path for newer versions of the engine. Newly installed versions of the engine will now attempt to copy the project-agnostic config settings from a previous engine installation. This happens by way of a versioned manifest that copies old versions when the manifest does not exist, or is a different version. This code path is benign for non-installed versions of the engine (or FPaths::ShouldSaveToUserDir() is false). EditorGameAgnosticSettings and EditorUserSettings ini paths have been renamed to EditorSettings and EditorPerProjectUserSettings respectively to better convey their purpose. In general, most settings should be saved in EditorSettings (project-agnostic) so that they apply regardless of which project is open. We have some way to go migrating existing settings for this to be the case, however. Some previously per-project configuration files are now project-agnostic (such as Editor.ini, EditorKeyBindings.ini, and EditorLayout.ini) GEditor->Access...Settings and GEditor->Get...Settings have been removed in favor of direct access of the CDO through GetMutableDefault<> and GetDefault<> respectively. Global config ini filenames that are not set up are now neither loaded nor saved on build machines, to handle the problem of indeterminate state more generically. This addresses UETOOL-270 (Most editor preferences should be project-agnostic) [CL 2517558 by Andrew Rodham in Main branch]
2015-04-20 10:12:55 -04:00
const bool NeedsUpdate = IsDisplayingDocumentationLink != GetDefault<UEditorPerProjectUserSettings>()->bDisplayDocumentationLink;
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
if ( !IsShowingFullTip && ModifierKeys.IsAltDown() && ModifierKeys.IsControlDown() )
{
if ( !FullTipContent.IsValid() && DocumentationPage.IsValid() && DocumentationPage->HasExcerpt( ExcerptName ) )
{
ConstructFullTipContent();
}
Added config migration path for newer versions of the engine. Newly installed versions of the engine will now attempt to copy the project-agnostic config settings from a previous engine installation. This happens by way of a versioned manifest that copies old versions when the manifest does not exist, or is a different version. This code path is benign for non-installed versions of the engine (or FPaths::ShouldSaveToUserDir() is false). EditorGameAgnosticSettings and EditorUserSettings ini paths have been renamed to EditorSettings and EditorPerProjectUserSettings respectively to better convey their purpose. In general, most settings should be saved in EditorSettings (project-agnostic) so that they apply regardless of which project is open. We have some way to go migrating existing settings for this to be the case, however. Some previously per-project configuration files are now project-agnostic (such as Editor.ini, EditorKeyBindings.ini, and EditorLayout.ini) GEditor->Access...Settings and GEditor->Get...Settings have been removed in favor of direct access of the CDO through GetMutableDefault<> and GetDefault<> respectively. Global config ini filenames that are not set up are now neither loaded nor saved on build machines, to handle the problem of indeterminate state more generically. This addresses UETOOL-270 (Most editor preferences should be project-agnostic) [CL 2517558 by Andrew Rodham in Main branch]
2015-04-20 10:12:55 -04:00
else if ( GetDefault<UEditorPerProjectUserSettings>()->bDisplayDocumentationLink )
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
{
ReloadDocumentation();
}
if ( FullTipContent.IsValid() )
{
WidgetContent->SetContent( FullTipContent.ToSharedRef() );
IsShowingFullTip = true;
Add analytics event for when Ctrl + Alt is used to show a rich tooltip [CL 2237209 by Marc Audy in Main branch]
2014-07-30 13:41:12 -04:00
// 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);
}
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
}
}
else if ( ( IsShowingFullTip || NeedsUpdate ) && ( !ModifierKeys.IsAltDown() || !ModifierKeys.IsControlDown() ) )
{
if ( NeedsUpdate )
{
ReloadDocumentation();
Added config migration path for newer versions of the engine. Newly installed versions of the engine will now attempt to copy the project-agnostic config settings from a previous engine installation. This happens by way of a versioned manifest that copies old versions when the manifest does not exist, or is a different version. This code path is benign for non-installed versions of the engine (or FPaths::ShouldSaveToUserDir() is false). EditorGameAgnosticSettings and EditorUserSettings ini paths have been renamed to EditorSettings and EditorPerProjectUserSettings respectively to better convey their purpose. In general, most settings should be saved in EditorSettings (project-agnostic) so that they apply regardless of which project is open. We have some way to go migrating existing settings for this to be the case, however. Some previously per-project configuration files are now project-agnostic (such as Editor.ini, EditorKeyBindings.ini, and EditorLayout.ini) GEditor->Access...Settings and GEditor->Get...Settings have been removed in favor of direct access of the CDO through GetMutableDefault<> and GetDefault<> respectively. Global config ini filenames that are not set up are now neither loaded nor saved on build machines, to handle the problem of indeterminate state more generically. This addresses UETOOL-270 (Most editor preferences should be project-agnostic) [CL 2517558 by Andrew Rodham in Main branch]
2015-04-20 10:12:55 -04:00
IsDisplayingDocumentationLink = GetDefault<UEditorPerProjectUserSettings>()->bDisplayDocumentationLink;
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
}
WidgetContent->SetContent( SimpleTipContent.ToSharedRef() );
IsShowingFullTip = false;
}
}
bool SDocumentationToolTip::IsInteractive() const
{
const FModifierKeysState ModifierKeys = FSlateApplication::Get().GetModifierKeys();
return ( DocumentationPage.IsValid() && ModifierKeys.IsAltDown() && ModifierKeys.IsControlDown() );
}
Reference in New Issue Copy Permalink