Search Results for

    Show / Hide Table of Contents

    Class VisualStudioCodeEditor

    Implementation of code editor utility that is using Microsoft Visual Studio Code.

    Inheritance
    CodeEditor
    VisualStudioCodeEditor
    Inherited Members
    CodeEditor::OnFileAdded(const String& path)
    CodeEditor::~CodeEditor()
    Assembly: FlaxEngine.dll
    File: Editor/Scripting/CodeEditors/VisualStudioCodeEditor.h
    Syntax
    public class VisualStudioCodeEditor : public CodeEditor

    Constructors

    VisualStudioCodeEditor(const String& execPath, const bool isInsiders)

    Initializes a new instance of the VisualStudioEditor class.

    Declaration
    public VisualStudioCodeEditor(const String& execPath, const bool isInsiders)
    Parameters
    String execPath

    Executable file path

    bool isInsiders

    Is insiders edition

    Methods

    FindEditors(Array<CodeEditor* >* output)

    Tries to find installed Visual Studio Code instance. Adds them to the result list.

    Declaration
    public static void FindEditors(Array<CodeEditor* >* output)
    Parameters
    Array<CodeEditor > output

    The output editors.

    GetName()

    Gets the name of the editor.

    Declaration
    public virtual String GetName() const override
    Returns
    String

    The name

    Overrides
    CodeEditor::GetName()

    GetType()

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

    Declaration
    public virtual CodeEditorTypes GetType() const override
    Returns
    CodeEditorTypes

    The name

    Overrides
    CodeEditor::GetType()

    OpenFile(const String& path, int32 line)

    Opens the file.

    Declaration
    public virtual void OpenFile(const String& path, int32 line) override
    Parameters
    String path

    The file path.

    int32 line

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

    Overrides
    CodeEditor::OpenFile(const String& path, int32 line)

    OpenSolution()

    Opens the solution project.

    Declaration
    public virtual void OpenSolution() override
    Overrides
    CodeEditor::OpenSolution()

    UseAsyncForOpen()

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

    Declaration
    public virtual bool UseAsyncForOpen() const override
    Returns
    bool

    True if use async thread for open task.

    Overrides
    CodeEditor::UseAsyncForOpen()
    • Improve this Doc
    • View Source
    In This Article
    Back to top Copyright © 2012-2024 Wojciech Figat