blob: 18638529fe456d00283131ec2a63f6146506e8ca (
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
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#include "snippetprovider.h"
#include <utils/algorithm.h>
using namespace TextEditor;
static QList<SnippetProvider> g_snippetProviders;
const QList<SnippetProvider> &SnippetProvider::snippetProviders()
{
return g_snippetProviders;
}
/*!
\group Snippets
\title Snippets for Editors
Snippets typically consist of chunks of code in a programming language (although they
can also be plain text) which you would like to avoid re-typing every time. They
are triggered in the same way as the completions (see \l{CodeAssist}{Providing
Code Assist}).
In order to create a new group of snippets two steps are necessary:
\list
\li Register the group with TextEditor::SnippetProvider::registerGroup
\li Create an XML configuration file and place it in the
/share/qtcreator/snippets directory. As an example of the file format
please take a look at the already available ones. The meaning and consistency rules
of the fields are described below:
\list
\li group - This is the group in which the snippet belongs in the user interface.
It must match TextEditor::SnippetProvider::groupId().
\li id - A unique string that identifies this snippet among all others available.
The recommended practice is to prefix it with the group so it is easier to have
such control on a file level.
\li trigger - The sequence of characters to be compared by the completion engine
in order to display this snippet as a code assist proposal.
\li complement - Additional information that is displayed in the code assist
proposal so it is possible to disambiguate similar snippets that have the
same trigger.
\endlist
\endlist
All XML configuration files found in the directory mentioned above are parsed by
Qt Creator. However, only the ones which are associated with known groups (specified
by a provider) are taken into consideration.
*/
/*!
\class TextEditor::SnippetProvider
\brief The SnippetProvider class acts as an interface for providing groups of snippets.
\ingroup Snippets
*/
/*!
Returns the unique group id to which this provider is associated.
*/
QString SnippetProvider::groupId() const
{
return m_groupId;
}
/*!
Returns the name to be displayed in the user interface for snippets that belong to the group
associated with this provider.
*/
QString SnippetProvider::displayName() const
{
return m_displayName;
}
/*!
Applies customizations such as highlighting or indentation to the snippet editor.
*/
void SnippetProvider::decorateEditor(TextEditorWidget *editor, const QString &groupId)
{
for (const SnippetProvider &provider : std::as_const(g_snippetProviders)) {
if (provider.m_groupId == groupId && provider.m_editorDecorator)
provider.m_editorDecorator(editor);
}
}
/*!
Registers a snippet group with \a groupId, \a displayName and \a editorDecorator.
*/
void SnippetProvider::registerGroup(const QString &groupId, const QString &displayName,
EditorDecorator editorDecorator)
{
SnippetProvider provider;
provider.m_groupId = groupId;
provider.m_displayName = displayName;
provider.m_editorDecorator = editorDecorator;
g_snippetProviders.append(provider);
}
|
