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
|
/****************************************************************************
**
** 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.
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\previouspage creator-output-panes.html
\page creator-configuring.html
\nextpage creator-build-example-application.html
\title Configuring Qt Creator
If you install \QC as part of a Qt installation, you should be able to use
it out-of-the-box, with the default settings and configuration options.
However, if you install the stand-alone \QC package, build \QC from sources,
or install several Qt versions, you may need to tell \QC where to find the
Qt versions and compilers by adding the paths to them and by creating
\l{glossary-buildandrun-kit}{kits} that use them.
To make \QC behave more like your favorite code editor or IDE, you can
change the settings for keyboard shortcuts, color schemes, generic
highlighting, code snippets, and version control systems. In addition, you
can enable experimental plugins and disable plugins that you do not need.
The following sections summarize the options that you have and point you to
detailed information to help you specify any required settings and to make
using \QC a better experience for you.
\section1 Checking Build and Run Settings
\QC is an integrated development environment (IDE) that you can use to
develop Qt applications. While Qt installers typically install \QC,
stand-alone \QC installers never install Qt or any Qt tools, such as qmake.
To use \QC for Qt development, you also need to have a Qt version and a
compiler installed.
Qt installers, such as SDKs, often attempt to auto-detect the installed
compilers and Qt versions. If they succeed, the relevant kits will
automatically become available in \QC. If they do not, you must add the kits
yourself to tell \QC where everything is.
To add kits, select \uicontrol Tools > \uicontrol Options >
\uicontrol Kits > \uicontrol Add.
For more information, see \l{Adding Kits}.
Each kit consists of a set of values that define one environment, such as a
\l{glossary-device}{device}, compiler, and Qt version. If you know you have
installed a Qt version, but it is not listed in \uicontrol Tools >
\uicontrol Options > \uicontrol Kits > \uicontrol {Qt Versions}, select
\uicontrol {Link with Qt}.
If the Qt version is still not listed under \uicontrol Auto-detected, select
\uicontrol {Add} to add it manually.
For more information, see \l{Adding Qt Versions}.
Also check that your compiler is listed in \uicontrol Tools >
\uicontrol Options > \uicontrol Kits > \uicontrol {Compilers}.
For more information, see \l{Adding Compilers}.
You can connect devices to the development PC to run, debug, and
analyze applications on them from \QC. You can connect the device to the
development PC via USB. Additionally, you can connect Linux-based devices
over a WLAN. You must also configure a connection between \QC and the
development PC and specify the device in a kit.
To add devices, select \uicontrol Tools > \uicontrol Options >
\uicontrol Devices > \uicontrol Devices > \uicontrol Add.
For more information, see \l{Connecting Devices}.
\section1 Changing Keyboard Shortcuts
You can use \QC with your favorite keyboard shortcuts.
To view and edit all keyboard shortcuts defined in \QC, select
\uicontrol Tools > \uicontrol Options > \uicontrol Environment >
\uicontrol Keyboard. For more information, see \l{Keyboard Shortcuts}.
\section1 Changing Color Schemes
Themes enable you to customize the appearance of the \QC UI: widgets,
colors, and icons.
To switch themes, select \uicontrol Tools > \uicontrol Options >
\uicontrol Environment, and then select a theme
in the \uicontrol Theme field.
You can use the \QC text and code editors with your favorite color scheme
that defines how code elements are highlighted and which background color is
used. You can select one of the predefined color schemes or create custom
ones. The color schemes apply to highlighting C++ files, QML files, and
generic files.
To change the color scheme, select \uicontrol Tools > \uicontrol Options >
\uicontrol {Text Editor} > \uicontrol {Fonts & Color}.
For more information, see \l{Defining Color Schemes}.
Generic highlighting is provided by
\l{https://api.kde.org/frameworks/syntax-highlighting/html/index.html}
{KSyntaxHighlighting}, which is the syntax highlighting engine for Kate
syntax definitions. \QC comes with most of the commonly used syntax files,
and you can download additional files.
To download and use highlight definition files, select \uicontrol Tools >
\uicontrol Options > \uicontrol {Text Editor} > \uicontrol {Generic Highlighter}.
For more information, see \l{Generic Highlighting}.
\section1 Adding Your Own Code Snippets
As you write code, \QC suggests properties, IDs, and code snippets to
complete the code. It provides a list of context-sensitive suggestions to
the statement currently under your cursor. You can add, modify, and remove
snippets in the snippet editor.
To open the snippet editor, select \uicontrol Tools > \uicontrol Options >
\uicontrol {Text Editor} > \uicontrol Snippets.
For more information, see \l{Editing Code Snippets}.
\section1 Configuring Version Control Systems
\QC supports several version control systems. In most cases, you do not need
to configure the version control in any special way to make it work with
\QC. Once it is set up correctly on the development PC, it should just work.
However, some configuration options are available and you can set them in
\uicontrol Tools > \uicontrol Options > \uicontrol {Version Control} >
\uicontrol Common.
For more information about the supported functions, see
\l{Using Version Control Systems}.
\section1 Enabling and Disabling Plugins
New \QC plugins are often introduced as \e {experimental plugins} to let you
try them out before they are fully supported. Experimental plugins are
disabled by default and you must enable them for them to become visible
after you restart \QC. By default, all the plugins that the plugin depends
on are also enabled.
You can also disable plugins that you do not use, to streamline \QC.
By default, all the plugins that depend on the plugin are also disabled.
To enable and disable plugins, select \uicontrol Help >
\uicontrol {About Plugins}.
The \l{https://marketplace.qt.io/}{Qt Marketplace} contains \QC plugins
that you can download and install either for free or for a price set by
their publisher. You can browse the available plugins in the
\uicontrol Marketplace tab in the Welcome mode.
*/
|
