1. Epic GamesDeveloper
  3. IDocumentation

IDocumentation

API > API/Editor > API/Editor/Documentation

   
Name IDocumentation
Type class
Header File /Engine/Source/Editor/Documentation/Public/IDocumentation.h
Include Path #include "IDocumentation.h"

Syntax

class IDocumentation

Functions

Public

Name Remarks Include Path Unreal Specifiers

TSharedRef< class SWidget > CreateAnchor ( const TAttribute< FString >& Link,
const FString& PreviewLink,
const FString& PreviewExcerptName,
const TAttribute< FString >& BaseUrlId
) const

   IDocumentation.h  

TSharedRef< class SToolTip > CreateToolTip ( const TAttribute< FText >& Text,
const TSharedPtr< SWidget >& OverrideContent,
const FString& Link,
const FString& ExcerptName
) const

   IDocumentation.h  

TSharedRef< class SToolTip > CreateToolTip ( const TAttribute< FText >& Text,
const TSharedPtr< SWidget >& OverrideContent,
const FString& Link,
const FString& ExcerptName,
const TAttribute< FText >& Shortcut
) const

   IDocumentation.h  

TSharedRef< class SToolTip > CreateToolTip ( const TAttribute< FText >& Text,
const TSharedRef< SWidget >& OverrideContent,
const TSharedPtr< class SVerticalBox >& DocVerticalBox,
const FString& Link,
const FString& ExcerptName
) const

   IDocumentation.h  

FString GetBaseUrl ( const FString& Id
) const

   IDocumentation.h  

TSharedRef< class IDocumentationPage > GetPage ( const FString& Link,
const TSharedPtr< FParserConfiguration >& Config,
const FDocumentationStyle& Style
)

   IDocumentation.h  

const TArray< FString > & GetSourcePaths()

   IDocumentation.h  

bool Open ( const FString& Link,
const FCultureRef& Culture,
FDocumentationSourceInfo Source,
const FString& BaseUrlId
) const

   IDocumentation.h  

bool Open ( const FString& Link,
FDocumentationSourceInfo Source,
const FString& BaseUrlId
) const

   IDocumentation.h  

bool OpenAPIHome ( FDocumentationSourceInfo Source
) const

   IDocumentation.h  

bool OpenHome ( const FCultureRef& Culture,
FDocumentationSourceInfo Source,
const FString& BaseUrlId
) const

   IDocumentation.h  

bool OpenHome ( FDocumentationSourceInfo Source,
const FString& BaseUrlId
) const

   IDocumentation.h  

bool PageExists ( const FString& Link,
const FCultureRef& Culture
) const

   IDocumentation.h  

bool PageExists ( const FString& Link
) const

   IDocumentation.h  

bool RegisterBaseUrl ( const FString& Id,
const FString& Url
)

   IDocumentation.h  

bool RegisterRedirect ( const FName& Owner,
const FDocumentationRedirect& Redirect
)

 Registers a documentation redirect for an owner IDocumentation.h  

void UnregisterRedirects ( const FName& Owner
)

 Unregisters all redirects owned by a specific owner IDocumentation.h  

Static

Name Remarks Include Path Unreal Specifiers

static TSharedRef< IDocumentation > Get()

   IDocumentation.h  

static bool IsAvailable()

   IDocumentation.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page