qtcreator.qdoc 10.9 KB
Newer Older
hjk's avatar
hjk 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
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
    \QC provides a cross-platform, complete integrated development environment
    (IDE) for application developers to create applications for multiple desktop
35
    and mobile device platforms, such as \l{Connecting Android Devices}{Android}
36
    and \l{Connecting iOS Devices}{iOS}. It is available for Linux, OS X and
37
    Windows
38
    operating systems. For more information, see \l{Supported Platforms}.
39

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

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

122
    \omit
123
    \section1 Table Of Contents
124 125

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

        \endlist
266
        \li \l{Advanced Use}
267
        \list
268 269
            \li \l{Supported Platforms}
            \li \l{Using Other Build Systems}
270
            \list
271
                \li \l{Setting Up a CMake Project}
272
                \li \l{Setting Up a Qbs Project}
273 274
                \li \l{Setting Up an Autotools Project}
                \li \l{Setting Up a Generic Project}
275
            \endlist
276 277 278 279
            \li \l{Using Command Line Options}
            \li \l{Keyboard Shortcuts}
            \li \l{Using External Tools}
            \li \l{Showing Task List Files in Issues Pane}
280
        \endlist
281
        \li  \l{Getting Help}
282
        \list
283 284 285 286 287 288 289
            \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}
290
        \endlist
291
    \endlist
292
    \endomit
293
*/