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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
|
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
**
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
**
****************************************************************************/
/*!
\page extending-index.html
\title Extending Qt Creator Manual
\QC is a cross-platform integrated development environment (IDE) tailored to
the needs of Qt developers.
\QC is extensible in various ways. For example, \QC architecture is based on
a plugin loader, which means that all functionality beyond plugin loading
is implemented in plugins. However, you can extend and tweak many parts of
\QC without the need to resort to coding in C++ and implementing such a
plugin.
This document gives you an overview of the various ways in which you can
extend \QC, depending on what you want to achieve, and points you to the
relevant documentation.
\section1 Generating Domain Specific Code and Templates
If you regularly need to write the same code, be it little code snippets,
whole files or classes spread over multiple files, or complete projects, you
can create code snippets, templates, and wizards for that purpose.
\section2 Snippets
Typically, snippets consist of a few lines of code (although they can also
be plain text) that you regularly want to insert into a bigger body of code,
but do not want to type each time. For example, \c while and \c for loops,
\c if-else and \c try-catch constructs, and class skeletons. Snippets are
triggered in the same way as normal code completion.
\QC contains a set of preconfigured snippets groups to which you can add
your own snippets.
\list
\li \l{https://doc.qt.io/qtcreator/creator-completing-code.html#editing-code-snippets}
{Snippets User Interface}
\omit
\li \l{Adding Snippets Groups}
\endomit
\endlist
\section2 File and Project Templates
You can extend the wizards in \uicontrol File >
\uicontrol {New File} or \uicontrol {New Project} with your own file and project templates by
writing JSON definition files for them.
\list
\li \l{https://doc.qt.io/qtcreator/creator-project-wizards.html}
{Adding New Custom Wizards}
\li \l{User Interface Text Guidelines}
\endlist
\section2 Custom Wizards
If the above methods for code snippets and templates are not sufficient for
your use case, you can create a custom \QC plugin. While this gives you
complete control over the wizard, it also requires you to write most of the
UI and the logic yourself.
\list
\li \l{Creating Plugins}
\li \l{Qt Creator Coding Rules}
\li \l{Creating Wizards in Code}
\li \l{User Interface Text Guidelines}
\endlist
\section1 Supporting Additional File Types
If you have files with extensions or MIME types that \QC does not handle by
default, you can edit the MIME type definitions, add highlight definition
files, and create your own text editors.
\section2 MIME Types
You might find that \QC could handle a particular file of yours if it knew
about the type of its contents. For example, C++ header or source files
with file extensions that are not known to \QC. You can adapt the MIME type
definitions in \QC to your specific setup, by adding or removing file
extensions and specifying magic headers.
\list
\li \l{https://doc.qt.io/qtcreator/creator-mime-types.html}
{Editing MIME Types}
\li \l{http://standards.freedesktop.org/shared-mime-info-spec/shared-mime-info-spec-latest.html}
{MIME Type Specification Files}
\endlist
\section2 Text Highlighting and Indentation
For text files, \QC provides an easy way to add highlighting and indentation
for file types that are not known to it by default. Generic highlighting is
based on highlight definition files that are provided by the Kate Editor.
You can download highlight definition files for use with \QC and create
your own definition files.
\list
\li \l{https://doc.qt.io/qtcreator/creator-highlighting.html#generic-highlighting}
{Generic Highlighting}
\li \l{https://docs.kde.org/stable5/en/applications/katepart/highlight.html}
{Working with Syntax Highlighting}
\endlist
\section2 Custom Text Editors
If you need more advanced features than the MIME type and highlighting
features described above, such as custom text completion or features that
rely on semantic analysis, you can extend \QC with a text editor of your
own. \QC provides a special API for text editors that gives you a basis to
build on, taking away some of the pain of implementing a text editor from
the ground up.
\list
\li \l{Creating Plugins}
\li \l{Qt Creator Coding Rules}
\omit
\li Text Editors
\li \l{CodeAssist}{Providing Code Assist}
\endomit
\endlist
\section2 Other Custom Editors
You can also add a completely custom editor to gain complete control over
its appearance and behavior.
\list
\li \l{Creating Plugins}
\li \l{Qt Creator Coding Rules}
\omit
\li \l{Editors}
\endomit
\endlist
\section1 Running External Tools
Most software projects and development processes require various external
tools. Several external tools, such as popular version control systems and
build tool chains are integrated into \QC. However, it is impossible for a
single tool to cover all the use cases, and therefore you can integrate
additional tools to \QC.
\section2 Simple External Tools
In \QC, you can specify tools that you can then run from a menu or by using
a keyboard shortcut that you assign. This allows you to accomplish several
things, with some limitations. You specify a command to run, arguments and
input for running it, and how to handle the output. To specify the values,
you can use a set of internal \QC variables, such as the file name of the
current document or project, or the currently selected text in a text
editor. If you find variables missing, please do not hesitate to fill a
feature suggestion. The tool descriptions are saved as XML files that you
can share.
\list
\li \l{https://doc.qt.io/qtcreator/creator-editor-external.html}
{Using External Tools}
\li \l{External Tool Specification Files}
\endlist
\section2 Complex External Tools
When you plan to integrate more complex tools, carefully consider whether
there really are advantages to be gained by tightly integrating the tool
into \QC over loosely integrating it by mainly providing a means of starting
the tool with fitting parameters.
\section3 Loosely Integrating Tools
If no interaction is needed between \QC and the external tool, just starting
an external application with its own user interface is preferable. That way
cluttering the \QC UI is avoided, and the tool will be available with a
nice interface even without using \QC at all.
Usually, you can use the external tool specification files to start the
tool. If starting the tool and handling its output require more complex
logic, you can add a menu item to \QC with a plugin. If you need a way to
configure the tool in \QC, you can add an \uicontrol Options page for it.
\list
\li \l{https://doc.qt.io/qtcreator/creator-editor-external.html}{Using External Tools}
\li \l{External Tool Specification Files}
\li \l{Creating Plugins}
\li \l{Qt Creator Coding Rules}
\omit
\li \l{Menus and Menu Items}
\li \l{Options Pages}
\endomit
\endlist
\section3 Interacting with Tool Output
In some cases, running an external tool would not require tight integration
with \QC, but investigating the output of the tool would benefit from it.
For example, some tools generate lists of issues in files that are part of
the project and some tools create output that is related to the code. For
these tools, it is useful to interactively switch between the output and
the corresponding code.
One way to handle that would be to let the tool create an output file, which
is then opened within \QC. You provide an editor (probably read-only) for
handling this file. For lists of issues, consider creating task list files
which are shown in the \uicontrol Issues output pane.
\list
\li \l{https://doc.qt.io/qtcreator/creator-task-lists.html}
{Showing Task List Files in the Issues Pane}
\li \l{Creating Plugins}
\li \l{Qt Creator Coding Rules}
\omit
\li \l{Menus and Menu Items}
\li \l{Options Pages}
\li \l{Editors}
\endomit
\endlist
\section1 All Topics
\list
\li Developing Qt Creator Plugins
\list
\li \l{Creating Plugins}
\omit
\li \l{Menus and Menu Items}
\endomit
\li \l{Creating Wizards in Code}
\omit
\li \l{Editors}
\li \l{Text Editors}
\li \l{Options Pages}
\endomit
\endlist
\li Reference
\list
\li \l{http://standards.freedesktop.org/shared-mime-info-spec/shared-mime-info-spec-latest.html}
{MIME Type Specification Files}
\li \l{External Tool Specification Files}
\li \l{http://kate-editor.org/2005/03/24/writing-a-syntax-highlighting-file/}
{Highlight Definition Files}
\li \l{https://doc.qt.io/qtcreator/creator-build-settings.html#using-qt-creator-variables}
{Qt Creator Variables}
\li \l{User Interface Text Guidelines}
\li \l{Writing Documentation}
\li \l{Qt Creator Coding Rules}
\li \l{Qt Creator API Reference}
\endlist
\endlist
*/
|
