Class CodeEditingManager

Editor utility to managed and use different code editors. Allows to open solution and source code files.

CodeEditingManager
Assembly: FlaxEngine.dll
File: Editor/Scripting/CodeEditor.h
Syntax
public class CodeEditingManager

Fields

AsyncOpenBegin

The asynchronous open begins.

Declaration
public static Action AsyncOpenBegin
Field Value
Action

AsyncOpenEnd

The asynchronous open ends.

Declaration
public static Action AsyncOpenEnd
Field Value
Action

Methods

GetCodeEditor(CodeEditorTypes editorType)

Gets the in-build code editor or null if not found.

Declaration
public static CodeEditor* GetCodeEditor(CodeEditorTypes editorType)
Parameters
CodeEditorTypes editorType

Type of the editor.
Returns
CodeEditor

The editor object or null if not found.

GetEditors()

Gets all found editors.

Declaration
public static Array<CodeEditor* > GetEditors()
Returns
Array<CodeEditor >

The editors. Read-only.

IsAsyncOpenRunning()

Determines whether asynchronous open action is running in a background.

Declaration
public static bool IsAsyncOpenRunning()
Returns
bool

true if asynchronous open action is running in a background; otherwise, false.

OnFileAdded(CodeEditorTypes editorType, 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 static void OnFileAdded(CodeEditorTypes editorType, const String& path)
Parameters
CodeEditorTypes editorType

The code editor type.
String path

The path.

OpenFile(CodeEditor* editor, const String& path, int32 line)

Opens the file. Handles async opening.

Declaration
public static void OpenFile(CodeEditor* editor, const String& path, int32 line)
Parameters
CodeEditor editor

The code editor.
String path

The file path.
int32 line

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

OpenFile(CodeEditorTypes editorType, const String& path, int32 line)

Opens the file. Handles async opening.

Declaration
public static void OpenFile(CodeEditorTypes editorType, const String& path, int32 line)
Parameters
CodeEditorTypes editorType

The code editor type.
String path

The file path.
int32 line

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

OpenSolution(CodeEditorTypes editorType)

Opens the solution project. Handles async opening.

Declaration
public static void OpenSolution(CodeEditorTypes editorType)
Parameters
CodeEditorTypes editorType

The code editor type.