qtcreator.qdoc 10.4 KB
Newer Older
hjk's avatar
hjk committed
1
/**************************************************************************
2
**
3
** Copyright (c) 2013 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator
7
8
9
10
11
12
13
14
15
16
**
**
** 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.
**
**
hjk's avatar
hjk committed
17
**************************************************************************/
18
19
20
21
22
23
24
25
26
27
28

// **********************************************************************
// 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.
// **********************************************************************


/*!
    \contentspage{index.html}{Qt Creator}
    \page index.html
29
    \nextpage creator-getting-started.html
30
31
32

    \title Qt Creator Manual

33
34
35
36
    \QC provides a cross-platform, complete integrated development environment
    (IDE) for application developers to create applications for multiple desktop
    and mobile device platforms. It is available for Linux, Mac OS X and Windows
    operating systems. For more information, see \l{Supported Platforms}.
37

38
39
    \table
        \row
40
41
42
            \li \inlineimage creator_gettingstarted.png
            \li \inlineimage creator_managingprojects.png
            \li \inlineimage creator_designinguserinterface.png
43
        \row
Leena Miettinen's avatar
Leena Miettinen committed
44
            \li \b {\l{Getting Started}}
45
                \list
46
47
                    \li \l{IDE Overview}
                    \li \l{User Interface}
48
                    \li \l{Configuring Qt Creator}
49
50
                    \li \l{Building and Running an Example}
                    \li \l{Tutorials}
51
                \endlist
Leena Miettinen's avatar
Leena Miettinen committed
52
            \li \b {\l{Managing Projects}}
53
                \list
54
55
56
57
                    \li \l{Creating Projects}
                    \li \l{Using Version Control Systems}
                    \li \l{Configuring Projects}
                    \li \l{Managing Sessions}
58
                \endlist
59
            \li \b {\l{Designing User Interfaces}}
60
                \list
61
62
63
                    \li \l{Developing Qt Quick Applications}
                    \li \l{Developing Widget Based Applications}
                    \li \l{Optimizing Applications for Mobile Devices}
64
65
                \endlist
        \row
66
67
68
            \li \inlineimage creator_coding.png
            \li \inlineimage creator_buildingrunning.png
            \li \inlineimage creator_testing.png
69
        \row
70
            \li \b {\l{Coding}}
71
                \list
72
73
74
75
                    \li \l{Writing Code}
                    \li \l{Finding}
                    \li \l{Refactoring}
                    \li \l{Configuring the Editor}
76
            \endlist
77
            \li \b {\l{Building and Running}}
78
                \list
79
80
81
82
                    \li \l{Building for Multiple Platforms}
                    \li \l{Running on Multiple Platforms}
                    \li \l{Deploying to Mobile Devices}
                    \li \l{Connecting Mobile Devices}
83
            \endlist
84
            \li \b {\l{Debugging and Analyzing}}
85
                \list
86
87
                    \li \l{Debugging}
                    \li \l{Analyzing Code}
88
89
                \endlist
        \row
90
91
            \li \inlineimage creator_advanceduse.png
            \li \inlineimage creator_gettinghelp.png
92
            \li
93
        \row
94
            \li \b {\l{Advanced Use}}
95
                \list
96
97
98
99
100
                    \li \l{Supported Platforms}
                    \li \l{Using Other Build Systems}
                    \li \l{Using Command Line Options}
                    \li \l{Keyboard Shortcuts}
                    \li \l{Using External Tools}
101
                \endlist
102
            \li \b {\l{Getting Help}}
103
                \list
104
105
106
107
108
                    \li \l{Using the Help Mode}
                    \li \l{FAQ}
                    \li \l{Tips and Tricks}
                    \li \l{Known Issues}
                    \li \l{Glossary}
109
                \endlist
110
            \li
111
        \row
112
            \li {3,1} \note To report bugs and suggestions to the Qt Bug
113
                Tracker, select \gui {Help > Report Bug}.
114

115
                You can also join the \QC mailing list at:
116
117
                \l{http://lists.qt-project.org/mailman/listinfo/}
                {lists.qt-project.org Mailing Lists}.
118
    \endtable
119

120
    \omit
121
    \section1 Table Of Contents
122
123

    \list
124
        \li \l{Getting Started}
125
        \list
126
127
            \li \l{IDE Overview}
            \li \l{User Interface}
128
            \li \l{Configuring Qt Creator}
129
130
            \li \l{Building and Running an Example}
            \li \l{Tutorials}
131
            \list
132
                \li \l{Creating a Qt Quick Application}
133
                \li \l{Creating a Qt Widget Based Application}
134
                \li \l{Creating an Android Application}
135
            \endlist
136
        \endlist
137
        \li \l{Managing Projects}
138
        \list
139
            \li \l{Creating Projects}
140
            \list
141
142
143
                \li \l{Opening Projects}
                \li \l{Adding Libraries to Projects}
                \li \l{Adding New Custom Wizards}
144
            \endlist
145
146
            \li \l{Using Version Control Systems}
            \li \l{Configuring Projects}
147
            \list
148
149
150
                \li \l{Adding Kits}
                \li \l{Adding Qt Versions}
                \li \l{Adding Compilers}
151
                \li \l{Adding Debuggers}
152
153
154
155
156
157
                \li \l{Specifying Build Settings}
                \li \l{Specifying Run Settings}
                \li \l{Specifying Editor Settings}
                \li \l{Specifying Code Style Settings}
                \li \l{Specifying Dependencies}
                \li \l{Sharing Project Settings}
158
            \endlist
159
            \li \l{Managing Sessions}
160
        \endlist
161
        \li \l{Designing User Interfaces}
162
        \list
163
            \li \l{Developing Qt Quick Applications}
164
            \list
165
166
167
168
169
170
171
172
                \li \l {Creating Qt Quick Projects}
                \li \l {Using Qt Quick Designer}
                \li \l {Creating Components}
                \li \l {Creating Buttons}
                \li \l {Creating Scalable Buttons and Borders}
                \li \l {Creating Screens}
                \li \l {Exporting Designs from Graphics Software}
                \li \l {Using QML Modules with Plugins}
173
            \endlist
174
            \li \l{Developing Widget Based Applications}
175
            \list
176
                \li  \l{Adding Qt Designer Plugins}
177
            \endlist
178
            \li \l{Optimizing Applications for Mobile Devices}
179
        \endlist
180
        \li \l{Coding}
181
        \list
182
        \li \l{Writing Code}
183
            \list
184
185
186
187
                \li \l{Working in Edit Mode}
                \li \l{Semantic Highlighting}
                \li \l{Checking Code Syntax}
                \li \l{Completing Code}
188
                \li \l{Indenting Text or Code}
189
190
191
                \li \l{Using Qt Quick Toolbars}
                \li \l{Pasting and Fetching Code Snippets}
                \li \l{Using Text Editing Macros}
192
                \li \l{Comparing Files}
193
            \endlist
194
            \li \l{Finding}
195
            \list
196
197
                \li \l{Finding and Replacing}
                \li \l{Searching with the Locator}
198
            \endlist
199
200
            \li \l{Refactoring}
            \li \l{Configuring the Editor}
201
            \list
202
203
                \li \l{Specifying Text Editor Settings}
                \li \l{Using FakeVim Mode}
204
            \endlist
205
            \li \l{Editing MIME Types}
206
        \endlist
207
        \li \l{Building and Running}
208
        \list
209
210
211
            \li \l{Building for Multiple Platforms}
            \li \l{Running on Multiple Platforms}
            \li \l{Deploying to Mobile Devices}
212
            \list
213
                \li \l{Deploying Applications to Android Devices}
214
                \li \l{Deploying Applications to BlackBerry 10 Devices}
215
                \li \l{Deploying Applications to Embedded Linux Devices}
216
                \li \l{Deploying Applications to QNX Devices}
217
            \endlist
218
            \li \l{Connecting Mobile Devices}
219
            \list
220
                \li \l{Connecting Android Devices}
221
                \li \l{Connecting Bare Metal Devices}
222
                \li \l{Connecting BlackBerry 10 Devices}
223
                \li \l{Connecting Embedded Linux Devices}
Leena Miettinen's avatar
Leena Miettinen committed
224
                \li \l{Connecting iOS Devices}
225
                \li \l{Connecting QNX Devices}
226
            \endlist
227
            \li \l{Customizing the Build Process}
228
        \endlist
229
        \li \l{Debugging and Analyzing}
230
        \list
231
            \li \l{Debugging}
232
            \list
233
234
235
236
237
238
239
240
                \li \l{Setting Up Debugger}
                \li \l{Launching the Debugger}
                \li \l{Interacting with the Debugger}
                \li \l{Using Debugging Helpers}
                \li \l{Debugging Qt Quick Projects}
                \li \l{Debugging a C++ Example Application}
                \li \l{Debugging a Qt Quick Example Application}
                \li \l{Troubleshooting Debugger}
241
            \endlist
242
            \li \l{Analyzing Code}
243
            \list
244
245
                \li \l{Profiling QML Applications}
                \li \l{Using Valgrind Code Analysis Tools}
246
                \list
247
248
249
                    \li \l{Detecting Memory Leaks}
                    \li \l{Profiling Function Execution}
                    \li \l{Running Valgrind Tools Remotely}
250
251
                \endlist
            \endlist
252
253

        \endlist
254
255
        \li \l{Publishing}
        \li \l{Advanced Use}
256
        \list
257
258
            \li \l{Supported Platforms}
            \li \l{Using Other Build Systems}
259
            \list
260
                \li \l{Setting Up a CMake Project}
261
                \li \l{Setting Up a Qbs Project}
262
263
                \li \l{Setting Up an Autotools Project}
                \li \l{Setting Up a Generic Project}
264
            \endlist
265
266
267
268
            \li \l{Using Command Line Options}
            \li \l{Keyboard Shortcuts}
            \li \l{Using External Tools}
            \li \l{Showing Task List Files in Issues Pane}
269
        \endlist
270
        \li  \l{Getting Help}
271
        \list
272
273
274
275
276
277
278
            \li \l{Using the Help Mode}
            \li \l{FAQ}
            \li \l{Tips and Tricks}
            \li \l{Known Issues}
            \li \l{Glossary}
            \li \l{Technical Support}
            \li \l{Acknowledgements}
279
        \endlist
280
    \endlist
281
    \endomit
282
*/