1 | /**************************************************************************** |
2 | ** |
3 | ** Copyright (C) 2018 The Qt Company Ltd. |
4 | ** Contact: https://www.qt.io/licensing/ |
5 | ** |
6 | ** This file is part of the QtSCriptTools module of the Qt Toolkit. |
7 | ** |
8 | ** $QT_BEGIN_LICENSE:LGPL$ |
9 | ** Commercial License Usage |
10 | ** Licensees holding valid commercial Qt licenses may use this file in |
11 | ** accordance with the commercial license agreement provided with the |
12 | ** Software or, alternatively, in accordance with the terms contained in |
13 | ** a written agreement between you and The Qt Company. For licensing terms |
14 | ** and conditions see https://www.qt.io/terms-conditions. For further |
15 | ** information use the contact form at https://www.qt.io/contact-us. |
16 | ** |
17 | ** GNU Lesser General Public License Usage |
18 | ** Alternatively, this file may be used under the terms of the GNU Lesser |
19 | ** General Public License version 3 as published by the Free Software |
20 | ** Foundation and appearing in the file LICENSE.LGPL3 included in the |
21 | ** packaging of this file. Please review the following information to |
22 | ** ensure the GNU Lesser General Public License version 3 requirements |
23 | ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. |
24 | ** |
25 | ** GNU General Public License Usage |
26 | ** Alternatively, this file may be used under the terms of the GNU |
27 | ** General Public License version 2.0 or (at your option) the GNU General |
28 | ** Public license version 3 or any later version approved by the KDE Free |
29 | ** Qt Foundation. The licenses are as published by the Free Software |
30 | ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 |
31 | ** included in the packaging of this file. Please review the following |
32 | ** information to ensure the GNU General Public License requirements will |
33 | ** be met: https://www.gnu.org/licenses/gpl-2.0.html and |
34 | ** https://www.gnu.org/licenses/gpl-3.0.html. |
35 | ** |
36 | ** $QT_END_LICENSE$ |
37 | ** |
38 | ****************************************************************************/ |
39 | |
40 | #ifndef QSCRIPTCOMPLETIONTASKINTERFACE_P_H |
41 | #define QSCRIPTCOMPLETIONTASKINTERFACE_P_H |
42 | |
43 | // |
44 | // W A R N I N G |
45 | // ------------- |
46 | // |
47 | // This file is not part of the Qt API. It exists purely as an |
48 | // implementation detail. This header file may change from version to |
49 | // version without notice, or even be removed. |
50 | // |
51 | // We mean it. |
52 | // |
53 | |
54 | #include <QtCore/qobject.h> |
55 | |
56 | QT_BEGIN_NAMESPACE |
57 | |
58 | class QString; |
59 | |
60 | class QScriptCompletionTaskInterfacePrivate; |
61 | class Q_AUTOTEST_EXPORT QScriptCompletionTaskInterface |
62 | : public QObject |
63 | { |
64 | Q_OBJECT |
65 | public: |
66 | enum CompletionType { |
67 | NoCompletion, |
68 | CommandNameCompletion, |
69 | CommandArgumentCompletion, |
70 | ScriptIdentifierCompletion |
71 | }; |
72 | |
73 | ~QScriptCompletionTaskInterface(); |
74 | |
75 | virtual void start() = 0; |
76 | |
77 | CompletionType completionType() const; |
78 | |
79 | int resultCount() const; |
80 | QString resultAt(int index) const; |
81 | |
82 | int position() const; |
83 | int length() const; |
84 | |
85 | QString appendix() const; |
86 | |
87 | protected: |
88 | void addResult(const QString &result); |
89 | |
90 | Q_SIGNALS: |
91 | void finished(); |
92 | |
93 | protected: |
94 | QScriptCompletionTaskInterface( |
95 | QScriptCompletionTaskInterfacePrivate &dd, QObject *parent); |
96 | |
97 | private: |
98 | Q_DECLARE_PRIVATE(QScriptCompletionTaskInterface) |
99 | Q_DISABLE_COPY(QScriptCompletionTaskInterface) |
100 | }; |
101 | |
102 | QT_END_NAMESPACE |
103 | |
104 | #endif |
105 | |