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 "texteditor_global.h"
29 
30 QT_BEGIN_NAMESPACE
31 class QSettings;
32 QT_END_NAMESPACE
33 
34 namespace TextEditor {
35 
36 enum CaseSensitivity {
37     CaseInsensitive,
38     CaseSensitive,
39     FirstLetterCaseSensitive
40 };
41 
42 enum CompletionTrigger {
43     ManualCompletion,     // Display proposal only when explicitly invoked by the user.
44     TriggeredCompletion,  // When triggered by the user or upon contextual activation characters.
45     AutomaticCompletion   // The above plus an automatic trigger when the editor is "idle".
46 };
47 
48 /**
49  * Settings that describe how the code completion behaves.
50  */
51 class TEXTEDITOR_EXPORT CompletionSettings
52 {
53 public:
54     void toSettings(QSettings *s) const;
55     void fromSettings(QSettings *s);
56 
57     bool equals(const CompletionSettings &bs) const;
58 
59     CaseSensitivity m_caseSensitivity = CaseInsensitive;
60     CompletionTrigger m_completionTrigger = AutomaticCompletion;
61     int m_automaticProposalTimeoutInMs = 400;
62     int m_characterThreshold = 3;
63     bool m_autoInsertBrackets = true;
64     bool m_surroundingAutoBrackets = true;
65     bool m_autoInsertQuotes = true;
66     bool m_surroundingAutoQuotes = true;
67     bool m_partiallyComplete = true;
68     bool m_spaceAfterFunctionName = false;
69     bool m_autoSplitStrings = true;
70     bool m_animateAutoComplete = true;
71     bool m_highlightAutoComplete = true;
72     bool m_skipAutoCompletedText = true;
73     bool m_autoRemove = true;
74     bool m_overwriteClosingChars = false;
75 };
76 
77 inline bool operator==(const CompletionSettings &t1, const CompletionSettings &t2) { return t1.equals(t2); }
78 inline bool operator!=(const CompletionSettings &t1, const CompletionSettings &t2) { return !t1.equals(t2); }
79 
80 } // namespace TextEditor
81