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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** 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 Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
#ifndef TEXTEDITORQUICKFIX_H
#define TEXTEDITORQUICKFIX_H
#include "texteditor_global.h"
#include <QString>
#include <QMetaType>
#include <QSharedPointer>
namespace TextEditor {
class IAssistInterface;
/*!
Class to perform a single quick-fix.
Quick-fix operations cannot be copied, and must be passed around as explicitly
shared pointers ( QuickFixOperation::Ptr ).
Subclasses should make sure that they copy parts of, or the whole QuickFixState ,
which are needed to perform the quick-fix operation.
*/
class TEXTEDITOR_EXPORT QuickFixOperation
{
Q_DISABLE_COPY(QuickFixOperation)
public:
typedef QSharedPointer<QuickFixOperation> Ptr;
public:
QuickFixOperation(int priority = -1);
virtual ~QuickFixOperation();
/*!
\returns The priority for this quick-fix. See the QuickFixCollector for more
information.
*/
virtual int priority() const;
/// Sets the priority for this quick-fix operation.
void setPriority(int priority);
/*!
\returns The description for this quick-fix. This description is shown to the
user.
*/
virtual QString description() const;
/// Sets the description for this quick-fix, which will be shown to the user.
void setDescription(const QString &description);
/*!
Perform this quick-fix's operation.
Subclasses should implement this method to do the actual changes.
*/
virtual void perform() = 0;
private:
int _priority;
QString _description;
};
/*!
The QuickFixFactory is responsible for generating QuickFixOperation s which are
applicable to the given QuickFixState.
A QuickFixFactory should not have any state -- it can be invoked multiple times
for different QuickFixState objects to create the matching operations, before any
of those operations are applied (or released).
This way, a single factory can be used by multiple editors, and a single editor
can have multiple QuickFixCollector objects for different parts of the code.
*/
class TEXTEDITOR_EXPORT QuickFixFactory: public QObject
{
Q_OBJECT
public:
QuickFixFactory(QObject *parent = 0);
virtual ~QuickFixFactory();
virtual QList<QuickFixOperation::Ptr>
matchingOperations(const QSharedPointer<const IAssistInterface> &interface) = 0;
};
} // namespace TextEditor
Q_DECLARE_METATYPE(TextEditor::QuickFixOperation::Ptr)
#endif // TEXTEDITORQUICKFIX_H
|
