ISourceCodeAccessor

Interface for viewing/editing source code

Windows
MacOS
Linux

Inheritance Hierarchy

IModularFeature

ISourceCodeAccessor

References

Module

SourceCodeAccess

Header

/Engine/Source/Developer/SourceCodeAccess/Public/ISourceCodeAccessor.h

Include

#include "ISourceCodeAccessor.h"

Syntax

class ISourceCodeAccessor : public IModularFeature

Remarks

Interface for viewing/editing source code

Destructors

Name Description

Public function Virtual

~ISourceCodeAccessor()

Functions

Name Description

Public function

bool

 

AddSourceFiles

(
    const TArray< FString >& AbsoluteS...,
    const TArray< FString >& Available...
)

Add a group of source files to the current solution/project/workspace

Public function Const

bool

 

CanAccessSourceCode()

Check if we can currently access source code

Public function Const

bool

 

DoesSolutionExist()

Determine if the source code solution for the given accessor already exists

Public function Const

FText

 

GetDescriptionText()

Get the description text for this source code accessor

Public function Const

FName

 

GetFName()

Get the name of this source code accessor - used as a unique identifier

Public function Const

FText

 

GetNameText()

Get the name text for this source code accessor

Public function

bool

 

OpenFileAtLine

(
    const FString& FullPath,
    int32 LineNumber,
    int32 ColumnNumber
)

Opens a file in the correct running instance of this code accessor at a line and optionally to a column.

Public function

bool

 

OpenSolution()

Open the current code solution for editing

Public function

bool

 

OpenSolutionAtPath

(
    const FString& InSolutionPath
)

Open the code solution at a specific path for editing

Public function

bool

 

OpenSourceFiles

(
    const TArray< FString >& AbsoluteS...
)

Opens a group of source files.

Public function

void

 

RefreshAvailability()

Not necessary to call unless you know you're changing the state of any installed compilers.

Public function Const

bool

 

SaveAllOpenDocuments()

Saves all open code documents if they need to be saved.

Public function

void

 

Tick

(
    const float DeltaTime
)

Tick this source code accessor

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback