qtcreator-faq.qdoc 11.4 KB
Newer Older
Leena Miettinen's avatar
Leena Miettinen committed
1
2
/****************************************************************************
**
3
** Copyright (c) 2014 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
Leena Miettinen's avatar
Leena Miettinen committed
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator
Leena Miettinen's avatar
Leena Miettinen committed
7
8
9
10
11
12
13
14
15
16
17
18
**
**
** GNU Free Documentation License
**
** 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.
**
**
****************************************************************************/

Leena Miettinen's avatar
Leena Miettinen committed
19
/*!
20
    \contentspage {Qt Creator Manual}
21
    \previouspage creator-help.html
Leena Miettinen's avatar
Leena Miettinen committed
22
    \page creator-faq.html
23
    \nextpage creator-tips.html
Leena Miettinen's avatar
Leena Miettinen committed
24
25
26

    \title FAQ

27
28
    This section contains answers to some frequently asked questions about \QC.
    You might also find answers to your questions in the
Leena Miettinen's avatar
Leena Miettinen committed
29
30
31
32
33
34
    \l{Known Issues} and \l{Tips and Tricks} sections, or the Troubleshooting
    sections for a special area, such as
    \l{Troubleshooting Debugger}{debugging}.

    \section1 General Questions

35
    \b {How do I reset all \QC settings?}
Leena Miettinen's avatar
Leena Miettinen committed
36

37
    \QC creates the following files and directories:
Leena Miettinen's avatar
Leena Miettinen committed
38
39
40

    \list

41
        \li QtCreator.db
Leena Miettinen's avatar
Leena Miettinen committed
42

43
        \li QtCreator.ini
Leena Miettinen's avatar
Leena Miettinen committed
44

45
        \li qtversion.xml
Leena Miettinen's avatar
Leena Miettinen committed
46

47
        \li toolChains.xml
Leena Miettinen's avatar
Leena Miettinen committed
48

49
        \li qtcreator
Leena Miettinen's avatar
Leena Miettinen committed
50

51
        \li qtc-debugging-helper
52

53
        \li qtc-qmldump
54

Leena Miettinen's avatar
Leena Miettinen committed
55
56
    \endlist

57
    The location depends on the platform. On Linux and other Unix platforms, the files
58
    are located in \c {~/.config/QtProject} and \c {~/.local/share/data/QtProject/qtcreator}.
59

60
    On OS X, the files are located in \c {~/.config/QtProject} and
61
    \c {~/Library/Application Support/QtProject/Qt Creator}.
Leena Miettinen's avatar
Leena Miettinen committed
62
63

    On Windows XP, the files are located in
64
65
    \c {%SystemDrive%\Documents and Settings\%USERNAME%\Application Data\QtProject} and
    \c {%SystemDrive%\Documents and Settings\%USERNAME%\Local Settings\Application Data\QtProject}.
66
67

    On Windows Vista and Windows 7, the files are located in
68
69
    \c {%SystemDrive%\Users\%USERNAME%\AppData\Roaming\QtProject} and
    \c {%SystemDrive%\Users\%USERNAME%\AppData\Local\QtProject}.
Leena Miettinen's avatar
Leena Miettinen committed
70

71
    \b {\QC comes with MinGW, should I use this version with Qt?}
Leena Miettinen's avatar
Leena Miettinen committed
72
73
74

    Use the version that was built against the Qt version.

75
    \b {\QC does not find a helper application, such as Git or a
Leena Miettinen's avatar
Leena Miettinen committed
76
77
    compiler. What should I do?}

78
79
    Make sure that the application is in your system PATH when starting \QC.
    Also select \gui {Tools > Options} to check the settings specified
Leena Miettinen's avatar
Leena Miettinen committed
80
81
82
    for the application. Many plugins specify either the path to the tool they
    need or the environment they run in.

83
    This is especially relevant for the OS X where \c {/usr/local/bin} might
84
    not be in the path when \QC is started.
Leena Miettinen's avatar
Leena Miettinen committed
85

86
    \b {How do I change the interface language for \QC?}
Leena Miettinen's avatar
Leena Miettinen committed
87

88
    \QC has been localized into several languages. If the system
Leena Miettinen's avatar
Leena Miettinen committed
89
90
91
    language is one of the supported languages, it is automatically selected.
    To change the language, select \gui {Tools > Options > Environment} and
    select a language in the \gui Language field. The change takes effect after
92
    you restart \QC.
Leena Miettinen's avatar
Leena Miettinen committed
93

94
    \b {Has a reported issue been addressed?}
Leena Miettinen's avatar
Leena Miettinen committed
95
96

    You can look up any issue in the
97
    \l{http://bugreports.qt-project.org/}{Qt bug tracker}.
Leena Miettinen's avatar
Leena Miettinen committed
98

99
    \include widgets/creator-faq-qtdesigner.qdocinc
Leena Miettinen's avatar
Leena Miettinen committed
100
101
102

    \section1 Help Questions

103
    \b {The Qt API Reference Documentation is missing and context help does
Leena Miettinen's avatar
Leena Miettinen committed
104
105
    not find topics. What can I do?}

106
    \QC comes fully integrated with Qt documentation and examples using
Leena Miettinen's avatar
Leena Miettinen committed
107
    the Qt Help plugin. The integrated Qt Reference Documentation is available
108
    for Qt 4.4 and later. \QC and other Qt deliverables contain
Leena Miettinen's avatar
Leena Miettinen committed
109
110
111
112
    documentation as .qch files. All the documentation is accessible in the
    \gui Help mode.

    To view the documentation that is available and to add documentation,
113
    select \gui {Tools > Options > Help > Documentation}. For more
Leena Miettinen's avatar
Leena Miettinen committed
114
115
116
117
118
119
120
    information, see \l{Adding External Documentation}.

    \section1 Debugger Questions

    For information on troubleshooting debugger, see
    \l{Troubleshooting Debugger}.

121
    \b {If I have a choice of GDB versions, which should I use?}
Leena Miettinen's avatar
Leena Miettinen committed
122
123

    On Linux and Windows, use the Python-enabled GDB versions that are
124
    installed when you install \QC and \QSDK. On OS X, GDB is no longer
125
126
    officially supported. To build your own Python-enabled GDB, follow the
    instructions in
127
    \l{http://qt-project.org/wiki/QtCreatorBuildGdb}{Building GDB}.
Leena Miettinen's avatar
Leena Miettinen committed
128

hjk's avatar
hjk committed
129
    You must use Python version 2.6 or 2.7.
Leena Miettinen's avatar
Leena Miettinen committed
130
131
132

    For more information on setting up debugger, see \l{Setting Up Debugger}.

133
    \b {How do I generate a core file in \QC?}
134
135
136
137
138
139
140
141
142
143
144

    To trigger the GDB command that generates a core file while debugging,
    select \gui {Window > Views > Debugger Log}. In the \gui Command field,
    type \c gcore and press \key Enter. The core file is created in the
    current working directory. You can specify another location for the file,
    including a relative or absolute path, as an argument of the command.

    To generate a temporary core file, select \gui {Create Snapshot} in the
    context menu in the \gui Snapshot view. The core file is deleted when you
    stop debugging.

Leena Miettinen's avatar
Leena Miettinen committed
145
146
    \section1 Compiler Questions

147
    \b {How can I make use of my multi-core CPU with \QC?}
Leena Miettinen's avatar
Leena Miettinen committed
148

149
    On Linux and OS X, go to \gui Project mode, select your configuration
Leena Miettinen's avatar
Leena Miettinen committed
150
151
152
153
154
155
    in the \gui {Build Settings}, locate the \gui {Build Steps}, and add the
    following value, where \c{<num>} is the amount of cores in your CPU:
    \c{-j <num>}

    On Windows, nmake does not support the \c{-j} parameter. Instead, we
    provide a drop-in replacement called jom. You can download a precompiled
Eike Ziller's avatar
Eike Ziller committed
156
    version of jom from \l{http://releases.qt-project.org/jom/}{Qt Project Release server}.
Leena Miettinen's avatar
Leena Miettinen committed
157
158
159
    Put jom.exe in a location in the %PATH%. Go to the \gui {Build Settings}
    and set jom.exe as the make command.

Leena Miettinen's avatar
Leena Miettinen committed
160
    \note Unlike GNU make, jom automatically detects your cores and spawns as
Leena Miettinen's avatar
Leena Miettinen committed
161
162
163
    many parallel processes as your CPU has cores. You can override this
    behavior by using the \c{-j} parameter as described above.

164
    \section1 Qt Installation Questions
Leena Miettinen's avatar
Leena Miettinen committed
165

166
167
    \b {I cannot use QSslSocket with the Qt I installed from binary packages.
        What should I do?}
Leena Miettinen's avatar
Leena Miettinen committed
168

169
    The Qt in the binary packages is built with QT_NO_OPENSSL defined. Rebuilding it
Leena Miettinen's avatar
Leena Miettinen committed
170
     is possible. For more information, see
hjk's avatar
hjk committed
171
     \l{http://www.qtcentre.org/threads/19222-Qssl}.
Leena Miettinen's avatar
Leena Miettinen committed
172

173
    \b {Which development packages from the distribution are needed on
Leena Miettinen's avatar
Leena Miettinen committed
174
175
176
177
178
179
180
181
182
183
184
185
    Ubuntu or Debian?}

    \code
    sudo apt-get install libglib2.0-dev libSM-dev libxrender-dev libfontconfig1-dev libxext-dev
    \endcode

    If you use QtOpenGL, you also need:

    \code
    sudo apt-get install libgl-dev libglu-dev
    \endcode

Sergio Ahumada's avatar
Sergio Ahumada committed
186
    \section1 Platform Related Questions
Leena Miettinen's avatar
Leena Miettinen committed
187

188
    \b {Where is application output shown in \QC?}
189

190
    \b {On Unix (Linux and OS X):} \c qDebug() and related functions use
191
192
193
194
195
196
    the standard output and error output. When you run or debug the
    application, you can view the output in the \gui{Application Output} pane.

    For console applications that require input, select \gui {Projects > Run
    Settings > Run in terminal}.

197
    \b {On Windows:} Output is displayed differently for \e{console
198
199
200
201
202
203
204
    applications} and \e{GUI applications}.

    The setting \c {CONFIG += console} in the .pro file specifies that the
    application is built as a console application using some other runtime.
    When you run a console application, you can view the output in the console
    window of the calling application. If the
    calling application is a GUI application (for example, a release-built
205
    version of \QC), a new console window is opened.  For this
206
207
208
209
210
211
212
213
214
215
216
217
218
219
    type of application, \c qDebug() and related functions use standard output
    and error output.

    We recommend that you select \gui {Projects > Run Settings > Run in
    terminal} for console applications.

    For GUI applications, \c qDebug() and related functions use the Windows API
    function \c OutputDebugString(). The output is displayed in the
    \gui{Application Output} pane. However, only one output pane tab may be
    open at a time or the output is not displayed correctly. You can use an
    external debug output viewer, such as the
    \l{http://technet.microsoft.com/en-us/sysinternals/bb896647}{DebugView for Windows}
    to display output from GUI applications.

Leena Miettinen's avatar
Leena Miettinen committed
220
221
    \section1 Questions about New Features

222
    \b {Will a requested feature be implemented?}
Leena Miettinen's avatar
Leena Miettinen committed
223
224
225
226
227
228

    If it is a scheduled feature, you can see this in the task tracker. If a
    feature already has been implemented, it is mentioned in the
    \l{http://qt.gitorious.org/qt-creator/qt-creator/trees/master/dist}{changes file}
    for the upcoming release.

229
    \b {Why does \QC not use tabs for editors?}
Leena Miettinen's avatar
Leena Miettinen committed
230
231
232
233
234
235

    This question comes up from time to time, so we have considered it
    carefully. Here are our main reasons for not using tabs:

    \list

236
        \li Tabs do not scale. They work fine if you have 5 to 6 editors open,
Leena Miettinen's avatar
Leena Miettinen committed
237
238
239
            they become cumbersome with 10, and if you need more horizontal
            space than the tab bar, the interface does not work at all.

240
        \li Tabs do not adapt to your working set.
Leena Miettinen's avatar
Leena Miettinen committed
241

242
        \li The common solution is to give the user the ability to reorder
Leena Miettinen's avatar
Leena Miettinen committed
243
244
            tabs. Now user has to manage tabs instead of writing code.

245
        \li Tabs force you to limit the amount of open editors, because
Leena Miettinen's avatar
Leena Miettinen committed
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
            otherwise you get confused.

    \endlist

    Consider the following use case: \e {Developers want to switch editors.}

    In fact, developers do not want to switch editors, but might have to do so
    to accomplish their tasks. We need to figure out what the tasks are to
    provide developers with better ways to navigate while performing the tasks.

    One common factor in many use cases is switching editors while working on a
    set of open files. While working on files A and B, users sometimes need to
    look at file C. They can press \key Ctrl+Tab to move between the files and
    have the files open in the correct editor according to file type. The list
    is sorted by last used.

    Typically, users also work on multiple classes or functions that are
    related, even though they are defined or declared in different files.
264
    \QC provides two shortcuts for that: \key F2 to follow the symbol
Leena Miettinen's avatar
Leena Miettinen committed
265
266
267
268
269
270
    and \key Ctrl+Shift+U to find usages.

    In addition, developers can:

    \list

271
        \li Press \key F4 to switch between header and source.
Leena Miettinen's avatar
Leena Miettinen committed
272

273
        \li Press \key Alt+Left to move backwards in the navigation history.
Leena Miettinen's avatar
Leena Miettinen committed
274

275
        \li Use the locator (Ctrl+K) to simply tell \QC where to go.
Leena Miettinen's avatar
Leena Miettinen committed
276
277
278
279
280

    \endlist

    The locator can be used to open files, but opening files is also just a
    step on the way to accomplish a task. For example, consider the following
281
    use case: \e {Fix AFunction in SomeClass which comes from
Leena Miettinen's avatar
Leena Miettinen committed
282
283
284
    someclass.cpp/someclass.h}.

    With a tabbed user interface, developers would search for someclass.cpp in
285
286
    the tab bar, and then search for \c {::AFunction}, only to find out that the
    function is not located in that file. They would then search for someclass.h
Leena Miettinen's avatar
Leena Miettinen committed
287
288
289
    in the tab bar, find our that the function is inline, fix the problem, and
    forget where they came from.

290
291
    With \QC, developers can type \c {Ctrl+K m AFun} to find the function.
    Typically, they only need to type 3 to 4 characters of the function name.
Leena Miettinen's avatar
Leena Miettinen committed
292
293
294
295
296
297
298
    They can then fix the problem and press \key Alt+Back to go back to where
    they were.

    Other locator filters include \c c for classes, \c : for all symbols, and
    (thanks to a community contribution) \c . for symbols in the current file.

*/