1 /****************************************************************************
3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
7 ** This file is part of the documentation of the Qt Toolkit.
9 ** $QT_BEGIN_LICENSE:LGPL$
10 ** No Commercial Usage
11 ** This file contains pre-release code and may not be distributed.
12 ** You may use this file in accordance with the terms and conditions
13 ** contained in the Technology Preview License Agreement accompanying
16 ** GNU Lesser General Public License Usage
17 ** Alternatively, this file may be used under the terms of the GNU Lesser
18 ** General Public License version 2.1 as published by the Free Software
19 ** Foundation and appearing in the file LICENSE.LGPL included in the
20 ** packaging of this file. Please review the following information to
21 ** ensure the GNU Lesser General Public License version 2.1 requirements
22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 ** In addition, as a special exception, Nokia gives you certain additional
25 ** rights. These rights are described in the Nokia Qt LGPL Exception
26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28 ** If you have questions regarding the use of this file, please contact
29 ** Nokia at qt-info@nokia.com.
40 ****************************************************************************/
46 This page provides a collection of documents grouped by topic.
48 The \l{Grouped Classes} page contains a similar list of groups for
49 Qt's class documentation.
51 \generatelist{related}
58 \brief Documents about Qt's architecture and design.
60 These documents describe aspects of Qt's architecture and design,
61 including overviews of core Qt features and technologies.
63 \generatelist{related}
70 \brief Tools to help automate building and installation of Qt applications.
72 Qt is provided with a set of build tools to help developers automate
73 the process of building and installing Qt applications.
76 \header \o Development \o Cross-Platform Issues \o Specific Tools
80 \o \l {Debugging Techniques}
82 \o \l {The Qt Resource System}
83 \o \l {Using Precompiled Headers}
87 \o \l {Cross Compiling Qt for Embedded Linux Applications}
88 \o \l {Deploying Qt Applications}
89 \o \l {Installation}{Installing Qt}
90 \o \l {Window System Specific Notes}
94 \o \l lupdate and \l lrelease
95 \o \l {moc}{Meta-Object Compiler (moc)}
96 \o \l {User Interface Compiler (uic)}
97 \o \l {Resource Compiler (rcc)}
106 \title Class and Function Indexes
108 \brief Collections of classes and functions grouped together into lists.
110 The following documents contain collections of classes, grouped by
111 subject area or related to particular functionality, or comprehensive
112 lists of classes and functions.
114 \generatelist{related}
121 \brief Codec support in Qt.
123 These codecs provide facilities for conversion between Unicode and
124 specific text encodings.
126 \generatelist{related}
130 \group gui-programming
131 \title GUI Programming
133 \brief Resources for developers of GUI applications.
135 The following list contains links to guides and other resources for
136 developers of graphical user interface (GUI) applications.
138 \generatelist{related}
143 \title How To Guides and Learning Resources
145 \brief Guides providing help on aspects of using Qt.
147 These guides provide specific help about specific Qt-related topics.
149 \generatelist{related}
154 \title Licensing Information
156 \brief Information about licenses and licensing issues.
158 These documents include information about Qt's licenses and the licenses
159 of third party components used in Qt.
161 \generatelist{related}
165 \group platform-notes
166 \title Platform-Specific Notes
168 \brief Documents describing platform-specific features of Qt.
170 These documents describe platform-specific features provided by Qt, and
171 discuss issues related to particular platforms and environments.
173 \generatelist{related}
178 \title Porting Guides
180 \brief Guides related to porting Qt applications and libraries.
182 A number of guides and documents are available that cover porting issues,
183 from detailed coverage of API differences between Qt 3 and Qt 4 to
184 platform and tool-specific documentation.
186 \generatelist{related}
190 \group text-processing
191 \title Text Processing
193 \brief Text processing guides and classes.
195 Qt provides an extensive collection of classes for text handling.
196 The following guides and references describe basic text handling, support
197 for internationalization and character encodings, and Qt's rich text
200 \generatelist{related}
207 \brief Tutorials, guides and overviews to help you learn Qt.
209 A collection of tutorials and "walkthrough" guides are provided with Qt to
210 help new users get started with Qt development. These documents cover a
211 range of topics, from basic use of widgets to step-by-step tutorials that
212 show how an application is put together.
214 \section1 \l{Widgets Tutorial}
216 \inlineimage widget-examples.png
218 A beginner's guide to getting started with widgets and layouts to create
221 \section1 \l{Address Book Tutorial}
223 \inlineimage addressbook-tutorial.png
225 A seven part guide to creating a fully-functioning address book
226 application. This tutorial is also available with
227 \l{Tutoriel "Carnet d'adresses"}{French explanation}.
232 \group activeqt-tools
233 \title Tools for ActiveQt
235 \brief Tools to help integrate Qt applications with ActiveX components.
237 These tools provide support for integrating Qt with ActiveX components.
239 \generatelist{related}
241 \sa {ActiveQt Framework}
246 \title Scripting with ECMAScript
248 \brief Guides and references covering application scripting with ECMAScript.
250 Qt 4.3 and later provides support for application scripting with ECMAScript.
251 The following guides and references cover aspects of programming with
254 \generatelist{related}
259 \title Threading and Concurrent Programming
261 \brief Guides and references covering threading and concurrent programming.
263 Qt provides a number of classes to handle the primitives used for multithreaded
264 programming. From Qt 4.4, the QtConcurrent namespace also provides a set of higher
265 level classes for concurrent programming.
267 \generatelist{related}
272 \title Qt for Windows CE
275 \brief Documents related to Qt on Windows CE
277 Qt for Windows CE is a C++ framework for GUI and application development
278 for embedded devices running Windows CE. It runs on a variety of processors,
279 including ARM, Intel x86, MIPS and SH-4.
282 \header \o Getting Started \o Reference \o Performance and Optimization
286 \o \l {Qt for Windows CE Requirements}
287 \o \l {Installing Qt on Windows CE}
288 \o \l {Windows CE - Introduction to using Qt}{Introduction to using Qt}
292 \o \l {Windows CE - Using shadow builds}{Using shadow builds}
293 \o \l {Windows CE - Working with Custom SDKs}{Working with Custom SDKs}
297 \o \l {Windows CE OpenGL ES}{OpenGL ES}
298 \o \l {Qt Performance Tuning}
299 \o \l {Fine-Tuning Features in Qt}