IExternalEditor Class

(Core::IExternalEditor)

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

Header: #include <IExternalEditor>

Public Functions

~IExternalEditor() override
virtual QString displayName() const = 0
virtual Id id() const = 0
virtual QStringList mimeTypes() const = 0
virtual bool startEditor(const QString &fileName, QString *errorMessage) = 0

Static Public Members

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

Detailed Description

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

Member Function Documentation

IExternalEditor::~IExternalEditor()

Destroys the instance of IExternalEditor.

[static] const ExternalEditorList IExternalEditor::allExternalEditors()

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

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

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

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

Returns the mime type 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.