1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of Qt Creator.
7 **
8 ** Commercial License Usage
9 ** Licensees holding valid commercial Qt licenses may use this file in
10 ** accordance with the commercial license agreement provided with the
11 ** Software or, alternatively, in accordance with the terms contained in
12 ** a written agreement between you and The Qt Company. For licensing terms
13 ** and conditions see https://www.qt.io/terms-conditions. For further
14 ** information use the contact form at https://www.qt.io/contact-us.
15 **
16 ** GNU General Public License Usage
17 ** Alternatively, this file may be used under the terms of the GNU
18 ** General Public License version 3 as published by the Free Software
19 ** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
20 ** included in the packaging of this file. Please review the following
21 ** information to ensure the GNU General Public License requirements will
22 ** be met: https://www.gnu.org/licenses/gpl-3.0.html.
23 **
24 ****************************************************************************/
25 
26 #pragma once
27 
28 #include "assistenums.h"
29 #include "iassistproposalmodel.h"
30 
31 #include <texteditor/texteditor_global.h>
32 
33 namespace TextEditor {
34 
35 class IAssistProposalWidget;
36 class TextEditorWidget;
37 
38 class TEXTEDITOR_EXPORT IAssistProposal
39 {
40 public:
41     IAssistProposal(int basePosition);
42     virtual ~IAssistProposal();
43 
44     int basePosition() const;
45     bool isFragile() const;
46     bool supportsPrefix() const;
hasItemsToPropose(const QString &,AssistReason)47     virtual bool hasItemsToPropose(const QString &, AssistReason) const { return true; }
48     virtual bool isCorrective(TextEditorWidget *editorWidget) const;
49     virtual void makeCorrection(TextEditorWidget *editorWidget);
50     virtual TextEditor::ProposalModelPtr model() const = 0;
51     virtual IAssistProposalWidget *createWidget() const = 0;
52 
53     void setFragile(bool fragile);
54     void setSupportsPrefix(bool supportsPrefix);
55 protected:
56     int m_basePosition;
57     bool m_isFragile = false;
58     bool m_supportsPrefix = true;
59 };
60 
61 } // TextEditor
62