Class CodeEditor

Base class for all code editors.

Inheritance

CodeEditor

Assembly: FlaxEngine.dll

File: Editor/Scripting/CodeEditor.h

Syntax

public class CodeEditor

Constructors

~CodeEditor()

Finalizes an instance of the CodeEditor class.

Declaration

public virtual ~CodeEditor() = default

Methods

GetName()

Gets the name of the editor.

Declaration

public virtual String GetName() const = 0

Returns

String The name

GetType()

Gets the type of the editor (used by the in-build editors).

Declaration

public virtual CodeEditorTypes GetType() const

Returns

CodeEditorTypes The name

OnFileAdded(const String& path)

Called when source file gets added to the workspace. Can be used to automatically include new files into the project files.

Declaration

public virtual void OnFileAdded(const String& path)

Parameters

String path The path.

OpenFile(const String& path, int32 line)

Opens the file.

Declaration

public virtual void OpenFile(const String& path, int32 line) = 0

Parameters

String path The file path.

int32 line The target line (use 0 to not use it).

OpenSolution()

Opens the solution project.

Declaration

public virtual void OpenSolution() = 0

UseAsyncForOpen()

Determines whether use the asynchronous task for open solution/file.

Declaration

public virtual bool UseAsyncForOpen() const

Returns

bool True if use async thread for open task.