blob: 8e8128d9267cac037cfb638c39413b5fa9b0d061 (
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
|
/****************************************************************************
**
** Copyright (C) 2014 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://www.qt.io/licensing. For further information
** use the contact form at http://www.qt.io/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 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** 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.
**
****************************************************************************/
#include "iassistinterface.h"
using namespace TextEditor;
/*!
\class TextEditor::IAssistInterface
\brief The IAssistInterface class acts as an interface for providing access
to the document from which a proposal is computed.
\ingroup CodeAssist
This interface existis in order to avoid a direct dependency on the text editor. This is
particularly important and safer for asynchronous providers, since in such cases computation
of the proposal is not done in the GUI thread.
In general this API tries to be as decoupled as possible from the base text editor.
This is in order to make the design a bit more generic and allow code assist to be
pluggable into different types of documents (there are still issues to be treated).
This class is part of the CodeAssist API.
\sa IAssistProposal, IAssistProvider, IAssistProcessor
*/
IAssistInterface::IAssistInterface()
{}
IAssistInterface::~IAssistInterface()
{}
/*!
\fn int TextEditor::IAssistInterface::position() const
Returns the cursor position.
*/
/*!
\fn QChar TextEditor::IAssistInterface::characterAt(int position) const
Returns the character at \a position.
*/
/*!
\fn QString TextEditor::IAssistInterface::textAt(int position, int length) const
Returns the text at \a position with the given \a length.
*/
/*!
\fn QString TextEditor::IAssistInterface::fileName() const
Returns the file associated.
*/
/*!
\fn QTextDocument *TextEditor::IAssistInterface::textDocument() const
Returns the document.
*/
/*!
\fn void TextEditor::IAssistInterface::detach(QThread *destination)
Detaches the interface. If it is necessary to take any special care in order to allow
this interface to be run in a separate thread \a destination this needs to be done
in this function.
*/
/*!
\fn AssistReason TextEditor::IAssistInterface::reason() const
The reason which triggered the assist.
*/
|
