blob: 0680da44a4235cc183cf36fdd46346662d7b4a16 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/
#include "iexternaleditor.h"
#include "ieditorfactory_p.h"
namespace Core {
/*!
\class Core::IExternalEditor
\inheaderfile coreplugin/editormanager/iexternaleditor.h
\inmodule QtCreator
\ingroup mainclasses
\brief The IExternalEditor class enables registering an external
editor in the \uicontrol{Open With} dialog.
*/
/*!
\fn QString Core::IExternalEditor::displayName() const
Returns a user-visible description of the editor type.
*/
/*!
\fn Utils::Id Core::IExternalEditor::id() const
Returns the ID of the factory or editor type.
*/
/*!
\fn QStringList Core::IExternalEditor::mimeTypes() const
Returns a list of MIME types that the editor supports
*/
/*!
\fn bool Core::IExternalEditor::startEditor(const Utils::FilePath &fileName, QString *errorMessage)
Opens the editor with \a fileName. Returns \c true on success or \c false
on failure along with the error in \a errorMessage.
*/
static QList<IExternalEditor *> g_externalEditors;
/*!
\internal
*/
IExternalEditor::IExternalEditor(QObject *parent)
: QObject(parent)
{
g_externalEditors.append(this);
}
/*!
\internal
*/
IExternalEditor::~IExternalEditor()
{
g_externalEditors.removeOne(this);
}
/*!
Returns all available external editors.
*/
const ExternalEditorList IExternalEditor::allExternalEditors()
{
return g_externalEditors;
}
/*!
Returns all external editors available for this \a mimeType in the default
order (editors ordered by MIME type hierarchy).
*/
const ExternalEditorList IExternalEditor::externalEditors(const Utils::MimeType &mimeType)
{
ExternalEditorList rc;
const ExternalEditorList allEditors = IExternalEditor::allExternalEditors();
Internal::mimeTypeFactoryLookup(mimeType, allEditors, &rc);
return rc;
}
} // Core
|