doc/src/topics.qdoc

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the documentation of the Qt Toolkit.
   8 **
   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
  14 ** this package.
  15 **
  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.
  23 **
  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.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 /*!
  43 \group topics
  44 \title Topics
  45
  46 This page provides a collection of documents grouped by topic.
  47
  48 The \l{Grouped Classes} page contains a similar list of groups for
  49 Qt's class documentation.
  50
  51 \generatelist{related}
  52 */
  53
  54 /*!
  55 \group architecture
  56 \title Architecture
  57 \ingroup topics
  58 \brief Documents about Qt's architecture and design.
  59
  60 These documents describe aspects of Qt's architecture and design,
  61 including overviews of core Qt features and technologies.
  62
  63 \generatelist{related}
  64 */
  65
  66 /*!
  67 \group buildsystem
  68 \title Build System
  69 \ingroup topics
  70 \brief Tools to help automate building and installation of Qt applications.
  71
  72 Qt is provided with a set of build tools to help developers automate
  73 the process of building and installing Qt applications.
  74
  75 \table 100%
  76 \header \o Development \o Cross-Platform Issues \o Specific Tools
  77 \row
  78 \o
  79  \list
  80     \o \l {Debugging Techniques}
  81     \o \l {Qt's Tools}
  82     \o \l {The Qt Resource System}
  83     \o \l {Using Precompiled Headers}
  84 \endlist
  85 \o
  86 \list
  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}
  91 \endlist
  92 \o
  93 \list
  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)}
  98 \endlist
  99 \endtable
 100
 101
 102 */
 103
 104 /*!
 105 \group classlists
 106 \title Class and Function Indexes
 107 \ingroup topics
 108 \brief Collections of classes and functions grouped together into lists.
 109
 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.
 113
 114 \generatelist{related}
 115 */
 116
 117 /*!
 118 \group codecs
 119 \title Codecs
 120 \ingroup topics
 121 \brief Codec support in Qt.
 122
 123 These codecs provide facilities for conversion between Unicode and
 124 specific text encodings.
 125
 126 \generatelist{related}
 127 */
 128
 129 /*!
 130 \group gui-programming
 131 \title GUI Programming
 132 \ingroup topics
 133 \brief Resources for developers of GUI applications.
 134
 135 The following list contains links to guides and other resources for
 136 developers of graphical user interface (GUI) applications.
 137
 138 \generatelist{related}
 139 */
 140
 141 /*!
 142 \group howto
 143 \title How To Guides and Learning Resources
 144 \ingroup topics
 145 \brief Guides providing help on aspects of using Qt.
 146
 147 These guides provide specific help about specific Qt-related topics.
 148
 149 \generatelist{related}
 150 */
 151
 152 /*!
 153 \group licensing
 154 \title Licensing Information
 155 \ingroup topics
 156 \brief Information about licenses and licensing issues.
 157
 158 These documents include information about Qt's licenses and the licenses
 159 of third party components used in Qt.
 160
 161 \generatelist{related}
 162 */
 163
 164 /*!
 165 \group platform-notes
 166 \title Platform-Specific Notes
 167 \ingroup topics
 168 \brief Documents describing platform-specific features of Qt.
 169
 170 These documents describe platform-specific features provided by Qt, and
 171 discuss issues related to particular platforms and environments.
 172
 173 \generatelist{related}
 174 */
 175
 176 /*!
 177 \group porting
 178 \title Porting Guides
 179 \ingroup topics
 180 \brief Guides related to porting Qt applications and libraries.
 181
 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.
 185
 186 \generatelist{related}
 187 */
 188
 189 /*!
 190 \group text-processing
 191 \title Text Processing
 192 \ingroup topics
 193 \brief Text processing guides and classes.
 194
 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
 198 system.
 199
 200 \generatelist{related}
 201 */
 202
 203 /*!
 204     \group tutorials
 205     \title Tutorials
 206     \ingroup topics
 207     \brief Tutorials, guides and overviews to help you learn Qt.
 208
 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.
 213
 214     \section1 \l{Widgets Tutorial}
 215
 216     \inlineimage widget-examples.png
 217
 218     A beginner's guide to getting started with widgets and layouts to create
 219     GUI applications.
 220
 221     \section1 \l{Address Book Tutorial}
 222
 223     \inlineimage addressbook-tutorial.png
 224
 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}.
 228
 229 */
 230
 231 /*!
 232 \group activeqt-tools
 233 \title Tools for ActiveQt
 234 \ingroup topics
 235 \brief Tools to help integrate Qt applications with ActiveX components.
 236
 237 These tools provide support for integrating Qt with ActiveX components.
 238
 239 \generatelist{related}
 240
 241 \sa {ActiveQt Framework}
 242 */
 243
 244 /*!
 245 \group scripting
 246 \title Scripting with ECMAScript
 247 \ingroup topics
 248 \brief Guides and references covering application scripting with ECMAScript.
 249
 250 Qt 4.3 and later provides support for application scripting with ECMAScript.
 251 The following guides and references cover aspects of programming with
 252 ECMAScript and Qt.
 253
 254 \generatelist{related}
 255 */
 256
 257 /*!
 258 \group threading
 259 \title Threading and Concurrent Programming
 260 \ingroup topics
 261 \brief Guides and references covering threading and concurrent programming.
 262
 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.
 266
 267 \generatelist{related}
 268 */
 269
 270 /*!
 271 \group qtce
 272 \title Qt for Windows CE
 273 \ingroup topics
 274 \ingroup qt-embedded
 275 \brief Documents related to Qt on Windows CE
 276
 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.
 280
 281 \table 100%
 282 \header \o Getting Started \o Reference \o Performance and Optimization
 283 \row
 284 \o
 285  \list
 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}
 289 \endlist
 290 \o
 291 \list
 292     \o \l {Windows CE - Using shadow builds}{Using shadow builds}
 293     \o \l {Windows CE - Working with Custom SDKs}{Working with Custom SDKs}
 294 \endlist
 295 \o
 296 \list
 297     \o \l {Windows CE OpenGL ES}{OpenGL ES}
 298     \o \l {Qt Performance Tuning}
 299     \o \l {Fine-Tuning Features in Qt}
 300 \endlist
 301 \endtable
 302 */