IExternalEditor Class

class Core::IExternalEditor

The IExternalEditor class enables registering an external editor in the Open With dialog. More...

Header: #include <coreplugin/editormanager/iexternaleditor.h>
Inherits: QObject

Public Functions

virtual QString displayName() const = 0
virtual Utils::Id id() const = 0
virtual QStringList mimeTypes() const = 0
virtual bool startEditor(const QString &fileName, QString *errorMessage) = 0

Static Public Members

const Core::ExternalEditorList allExternalEditors()
const Core::ExternalEditorList externalEditors(const Utils::MimeType &mimeType)

Detailed Description

Member Function Documentation

[static] const Core::ExternalEditorList IExternalEditor::allExternalEditors()

Returns all available external editors.

[pure virtual] QString IExternalEditor::displayName() const

Returns a user-visible description of the editor type.

[static] const Core::ExternalEditorList IExternalEditor::externalEditors(const Utils::MimeType &mimeType)

Returns all external editors available for this mimeType in the default order (editors ordered by MIME type hierarchy).

[pure virtual] Utils::Id IExternalEditor::id() const

Returns the ID of the factory or editor type.

[pure virtual] QStringList IExternalEditor::mimeTypes() const

Returns a list of MIME types that the editor supports

[pure virtual] bool IExternalEditor::startEditor(const QString &fileName, QString *errorMessage)

Opens the editor with fileName. Returns true on success or false on failure along with the error in errorMessage.

© 2020 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.