Interface ISourceCodeEditor

Interface for source code editing plugins.

Namespace: FlaxEditor.Modules.SourceCodeEditing
Assembly: FlaxEngine.CSharp.dll
Syntax
public interface ISourceCodeEditor

Properties

GenerateProjectCustomArgs

Gets the custom arguments for the Flax.Build tool to add when generating project files for this code editor. Can be used to pick a different project files generator. Empty by default.

Declaration
string GenerateProjectCustomArgs { get; }
Property Value
System.String

Name

Gets the editor name. Used to show in the UI.

Declaration
string Name { get; }
Property Value
System.String

Methods

OnAdded(Editor)

Called when editor gets added.

Declaration
void OnAdded(Editor editor)
Parameters
Editor editor

The editor.

OnDeselected(Editor)

Called when editor gets deselected.

Declaration
void OnDeselected(Editor editor)
Parameters
Editor editor

The editor.

OnFileAdded(String)

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

Declaration
void OnFileAdded(string path)
Parameters
System.String path

The path.

OnRemoved(Editor)

Called when editor gets removed.

Declaration
void OnRemoved(Editor editor)
Parameters
Editor editor

The editor.

OnSelected(Editor)

Called when editor gets selected.

Declaration
void OnSelected(Editor editor)
Parameters
Editor editor

The editor.

OpenFile(String, Int32)

Opens the source file.

Declaration
void OpenFile(string path, int line)
Parameters
System.String path

The file path to open.
System.Int32 line

The line number to navigate to. Use 0 to not use it.

OpenSolution()

Opens the solution file (source code project file).

Declaration
void OpenSolution()

Extension Methods