Navigation
API > API/Developer > API/Developer/SourceCodeAccess
Interface for viewing/editing source code
| Name | ISourceCodeAccessor |
| Type | class |
| Header File | /Engine/Source/Developer/SourceCodeAccess/Public/ISourceCodeAccessor.h |
| Include Path | #include "ISourceCodeAccessor.h" |
Syntax
class ISourceCodeAccessor : public IModularFeature
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~ISourceCodeAccessor() |
ISourceCodeAccessor.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Add a group of source files to the current solution/project/workspace | ISourceCodeAccessor.h | ||
bool CanAccessSourceCode() |
Check if we can currently access source code | ISourceCodeAccessor.h | |
bool DoesSolutionExist() |
Determine if the source code solution for the given accessor already exists | ISourceCodeAccessor.h | |
FText GetDescriptionText() |
Get the description text for this source code accessor | ISourceCodeAccessor.h | |
FName GetFName() |
Get the name of this source code accessor - used as a unique identifier | ISourceCodeAccessor.h | |
FText GetNameText() |
Get the name text for this source code accessor | ISourceCodeAccessor.h | |
virtual FName GetOpenIconName() |
Get the icon that represents opening this source code editor | ISourceCodeAccessor.h | |
virtual FName GetRefreshIconName() |
Get the icon that represents refreshing this source code editor | ISourceCodeAccessor.h | |
virtual FName GetStyleSet () |
Get the style set where custom icons for the editors are defined. | ISourceCodeAccessor.h | |
bool OpenFileAtLine
(
const FString& FullPath, |
Opens a file in the correct running instance of this code accessor at a line and optionally to a column. | ISourceCodeAccessor.h | |
bool OpenSolution() |
Open the current code solution for editing | ISourceCodeAccessor.h | |
bool OpenSolutionAtPath
(
const FString& InSolutionPath |
Open the code solution at a specific path for editing | ISourceCodeAccessor.h | |
| Opens a group of source files. | ISourceCodeAccessor.h | ||
void RefreshAvailability () |
Not necessary to call unless you know you're changing the state of any installed compilers. | ISourceCodeAccessor.h | |
bool SaveAllOpenDocuments () |
Saves all open code documents if they need to be saved. | ISourceCodeAccessor.h | |
void Tick
(
const float DeltaTime |
Tick this source code accessor | ISourceCodeAccessor.h |