2014-12-07 19:09:38 -05:00
|
|
|
// Copyright 1998-2015 Epic Games, Inc. All Rights Reserved.
|
2014-03-14 14:13:41 -04:00
|
|
|
|
|
|
|
|
#include "DocumentationModulePrivatePCH.h"
|
|
|
|
|
#include "UDNParser.h"
|
|
|
|
|
#include "DocumentationPage.h"
|
|
|
|
|
#include "SDocumentationAnchor.h"
|
|
|
|
|
|
|
|
|
|
TSharedRef< IDocumentationPage > FDocumentationPage::Create( const FString& Link, const TSharedRef< FUDNParser >& Parser )
|
|
|
|
|
{
|
|
|
|
|
return MakeShareable( new FDocumentationPage( Link, Parser ) );
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
FDocumentationPage::~FDocumentationPage()
|
|
|
|
|
{
|
|
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
bool FDocumentationPage::GetExcerptContent( FExcerpt& Excerpt )
|
|
|
|
|
{
|
|
|
|
|
for (int32 Index = 0; Index < StoredExcerpts.Num(); ++Index)
|
|
|
|
|
{
|
|
|
|
|
if ( Excerpt.Name == StoredExcerpts[ Index ].Name )
|
|
|
|
|
{
|
|
|
|
|
Parser->GetExcerptContent( Link, StoredExcerpts[ Index ] );
|
|
|
|
|
Excerpt.Content = StoredExcerpts[ Index ].Content;
|
2014-08-14 07:02:50 -04:00
|
|
|
Excerpt.RichText = StoredExcerpts[ Index ].RichText;
|
2014-03-14 14:13:41 -04:00
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
bool FDocumentationPage::HasExcerpt( const FString& ExcerptName )
|
|
|
|
|
{
|
|
|
|
|
return StoredMetadata.ExcerptNames.Contains( ExcerptName );
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
int32 FDocumentationPage::GetNumExcerpts() const
|
|
|
|
|
{
|
|
|
|
|
return StoredExcerpts.Num();
|
|
|
|
|
}
|
|
|
|
|
|
2014-07-21 17:31:27 -04:00
|
|
|
bool FDocumentationPage::GetExcerpt(const FString& ExcerptName, FExcerpt& Excerpt)
|
|
|
|
|
{
|
|
|
|
|
for (const FExcerpt& StoredExcerpt : StoredExcerpts)
|
|
|
|
|
{
|
|
|
|
|
if (StoredExcerpt.Name == ExcerptName)
|
|
|
|
|
{
|
|
|
|
|
Excerpt = StoredExcerpt;
|
|
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
|
2014-03-14 14:13:41 -04:00
|
|
|
void FDocumentationPage::GetExcerpts( /*OUT*/ TArray< FExcerpt >& Excerpts )
|
|
|
|
|
{
|
|
|
|
|
Excerpts.Empty();
|
|
|
|
|
for (int32 i = 0; i < StoredExcerpts.Num(); ++i)
|
|
|
|
|
{
|
|
|
|
|
Excerpts.Add(StoredExcerpts[i]);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
FText FDocumentationPage::GetTitle()
|
|
|
|
|
{
|
|
|
|
|
return StoredMetadata.Title;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
void FDocumentationPage::Reload()
|
|
|
|
|
{
|
|
|
|
|
StoredExcerpts.Empty();
|
|
|
|
|
StoredMetadata = FUDNPageMetadata();
|
|
|
|
|
Parser->Parse( Link, StoredExcerpts, StoredMetadata );
|
|
|
|
|
}
|
|
|
|
|
|
Added a new documentation node to the blueprints to display udn documentation excerpts in the grapheditor.
#TTP 312311 - ROCKET: TASK: Add a "Documentation Node"
#Branch UE4
#Proj BlueprintGraph, EdGraph, Kismet, KismetCompiler, GraphEditor, Documentation, EditorStyle
#Change Updated UEdGraphSchema to include an interface call to retrieve an FEdGraphSchemaAction to create documentation nodes. At this point only the K2 interfaces implement this.
#Change Updated UEdGraphSchema_K2 to include a call to retrieve an FEdGraphSchemaAction to create documentation nodes. This is used to add the actions to the blueprint palette and context menus.
#Add Added FEdGraphSchemaAction_K2AddDocumentation in EdGraphSchema_K2_Actions.h/cpp to implement the calls in UEdGraphSchema to create documenation nodes from palette and context menus.
#Change Modified FK2ActionMenuBuilder to provide a static call to create a documentation action in the same style as the comment. Additionally added calls to FK2ActionMenuBuilder::GetPaletteActions and FK2ActionMenuBuilder::GetContextAllowedNodeTypes to call this to add entries in the palette and context menus.
#Add Added a new Brush GraphEditor.Documentation_16x, for the context menu icon in SlateEditorStyle.cpp.
#Change Modified GetPaletteItemIcon in SBlueprintPalette.cpp to return the new icon for the DocumentationNode
#Change Modified FKismetCompilerContext::IsNodePure to include the Documentaton node in the drop through ensure test to prevent asserts on compling if a documentation node is present.
#Change Added an entry for Documentation node in FNodeFactory::CreateNodeWidget.
#Change Modified IDocumentationPage interface to provide the ability to provide a TextWrapAt Attribute so this can be set before creating excerpt content if desired.
#Change Modified the UDNParser to control text wrap at values in the created widgets using a float Attribute WrapAt, Added a set call in the DocumentationPage and made the default behaviour mimic the code it replaced.
#Add Added the class UEdGraphNode_Documentation implemented in EdGraphNode_Documentation.h and UEdGraph.cpp, this is the UObject implementation for the documentation nodes.
#Add Added the class SGraphNodeDocumentation as the GraphPanel implementation of the EdGraphNode_Documentation.
#Change Moved the resizable code from SGraphNodeComment into a SGraphNodeResizable and changed SGraphNodeComment and SGraphNodeDocumentation inherit from it to avoid duplicating code.
#Change Added a documentation specific details customisation so the excerpts can be displayed as combo button.
#Change Added FBlueprintDocumentationDetails into BlueprintDetailsCustomization.h/cpp to handle the user interaction with the documentation node in the BP Editor.
ReviewedBy Chris.Wood, Mike.Beach
[CL 2247425 by Ben Cosh in Main branch]
2014-08-07 15:33:55 -04:00
|
|
|
void FDocumentationPage::SetTextWrapAt( TAttribute<float> WrapAt )
|
|
|
|
|
{
|
|
|
|
|
Parser->SetWrapAt( WrapAt );
|
|
|
|
|
}
|
|
|
|
|
|
2014-03-14 14:13:41 -04:00
|
|
|
FDocumentationPage::FDocumentationPage( const FString& InLink, const TSharedRef< FUDNParser >& InParser )
|
|
|
|
|
: Link( InLink )
|
|
|
|
|
, Parser( InParser )
|
|
|
|
|
{
|
|
|
|
|
Parser->Parse( Link, StoredExcerpts, StoredMetadata );
|
|
|
|
|
}
|