Changeset 561 for trunk/doc/src/modules.qdoc
- Timestamp:
- Feb 11, 2010, 11:19:06 PM (15 years ago)
- Location:
- trunk
- Files:
-
- 2 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk
-
Property svn:mergeinfo
set to (toggle deleted branches)
/branches/vendor/nokia/qt/4.6.1 merged eligible /branches/vendor/nokia/qt/current merged eligible /branches/vendor/trolltech/qt/current 3-149
-
Property svn:mergeinfo
set to (toggle deleted branches)
-
trunk/doc/src/modules.qdoc
r2 r561 2 2 ** 3 3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). 4 ** Contact: Qt Software Information ([email protected]) 4 ** All rights reserved. 5 ** Contact: Nokia Corporation ([email protected]) 5 6 ** 6 7 ** This file is part of the documentation of the Qt Toolkit. … … 21 22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. 22 23 ** 23 ** In addition, as a special exception, Nokia gives you certain 24 ** additional rights. These rights are described in the Nokia Qt LGPL 25 ** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this 26 ** package. 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 27 ** 28 28 ** GNU General Public License Usage … … 34 34 ** met: http://www.gnu.org/copyleft/gpl.html. 35 35 ** 36 ** If you are unsure which license is appropriate for your use, please37 ** contact the sales department at qt-sales@nokia.com.36 ** If you 37 ** @nokia.com. 38 38 ** $QT_END_LICENSE$ 39 39 ** … … 42 42 /*! 43 43 \group modules 44 \title Qt'sModules44 \title Modules 45 45 \startpage index.html Qt Reference Documentation 46 46 \nextpage QtCore 47 48 Qt 4 consists of several modules, each of which lives in a49 separate library. 50 51 Modules for general software development:47 48 49 50 \brief Qt 4 comprises several modules. Each module is a separate 51 52 52 53 53 \table 80% 54 54 55 \row \o \l{QtCore} \o Core non-graphical classes used by other modules 55 56 \row \o \l{QtGui} \o Graphical user interface (GUI) components 57 56 58 \row \o \l{QtNetwork} \o Classes for network programming 57 59 \row \o \l{QtOpenGL} \o OpenGL support classes 60 58 61 \row \o \l{QtScript} \o Classes for evaluating Qt Scripts 59 62 \row \o \l{QtScriptTools} \o Additional Qt Script components … … 65 68 \row \o \l{Phonon Module}{Phonon} \o Multimedia framework classes 66 69 \row \o \l{Qt3Support} \o Qt 3 compatibility classes 67 \endtable 68 69 Modules for working with Qt's tools: 70 71 \table 80% 70 \header \o {2,1} \bold{Modules for working with Qt's tools} 72 71 \row \o \l{QtDesigner} \o Classes for extending \QD 73 72 \row \o \l{QtUiTools} \o Classes for handling \QD forms in applications 74 73 \row \o \l{QtHelp} \o Classes for online help 75 \row \o \l{QtAssistant} \o Support for online help76 74 \row \o \l{QtTest} \o Tool classes for unit testing 77 \endtable 78 79 The following extension modules are available in the \l{Qt 80 Commercial Editions} on Windows: 81 82 \table 80% 75 \header \o {2,1} \bold{Modules for Windows developers} 83 76 \row \o \l{QAxContainer} \o Extension for accessing ActiveX controls 84 77 \row \o \l{QAxServer} \o Extension for writing ActiveX servers 85 \endtable 86 87 The following extension module is available in all \l {Qt Editions} 88 on Unix platforms: 89 90 \table 80% 78 \header \o {2,1} \bold{Modules for Unix developers} 91 79 \row \o \l{QtDBus} \o Classes for Inter-Process Communication using the D-Bus 92 80 \endtable … … 98 86 \snippet doc/src/snippets/code/doc_src_modules.qdoc 0 99 87 100 On Windows, if you do not use \l qmake, the \l{Visual Studio Integration} 101 available to \l{Qt Commercial Editions}{commercial licensees}, or other 102 build tools such as CMake, you also need to link against the \c qtmain library. 103 104 \sa {Qt's Classes} 105 */ 88 On Windows, if you do not use \l qmake 89 or other build tools such as CMake, you also need to link against 90 the \c qtmain library. 91 92 \sa {Class and Function Documentation} 93 */ 94 95 /*! 96 \module QtCore 97 \title QtCore Module 98 \contentspage All Qt Modules 99 \previouspage All Qt Modules 100 \nextpage QtGui 101 \ingroup modules 102 103 \keyword QtCore 104 105 \brief The QtCore module contains core non-GUI functionality. 106 107 All other Qt modules rely on this module. To include the 108 definitions of the module's classes, use the following directive: 109 110 \snippet doc/src/snippets/code/doc_src_qtcore.qdoc 0 111 112 The QtCore module is part of all \l{Qt editions}. 113 */ 114 115 116 /*! 117 \module QtGui 118 \title QtGui Module 119 \contentspage All Qt Modules 120 \previouspage QtCore 121 \nextpage QtNetwork 122 \ingroup modules 123 124 \brief The QtGui module extends QtCore with GUI functionality. 125 126 To include the definitions of both modules' classes, use the 127 following directive: 128 129 \snippet doc/src/snippets/code/doc_src_qtgui.qdoc 0 130 131 The QtGui module is part of the \l{Qt GUI Framework Edition}, 132 the \l{Qt Full Framework Edition}, and the \l{Open Source Versions of Qt}. 133 */ 134 135 /*! 136 \module QtMultimedia 137 \title QtMultimedia Module 138 \contentspage All Qt Modules 139 \previouspage QtCore 140 \nextpage QtNetwork 141 \ingroup modules 142 143 \brief The QtMultimedia module provides low-level multimedia functionality. 144 145 To include the definitions of the module's classes, use the 146 following directive: 147 148 \snippet doc/src/snippets/code/doc_src_qtmultimedia.qdoc 1 149 150 To link against the module, add this line to your \l qmake \c 151 .pro file: 152 153 \snippet doc/src/snippets/code/doc_src_qtmultimedia.qdoc 0 154 155 The functionality provided by the \l{Phonon Module} is on a higher level 156 and in many cases more suitable for application developers. 157 */ 158 159 /*! 160 \module QtNetwork 161 \title QtNetwork Module 162 \contentspage All Qt Modules 163 \previouspage QtMultimedia 164 \nextpage QtOpenGL 165 \ingroup modules 166 167 \brief The QtNetwork module provides classes to make network programming 168 easier and portable. 169 170 To include the definitions of the module's classes, use the 171 following directive: 172 173 \snippet doc/src/snippets/code/doc_src_qtnetwork.qdoc 1 174 175 To link against the module, add this line to your \l qmake \c 176 .pro file: 177 178 \snippet doc/src/snippets/code/doc_src_qtnetwork.qdoc 0 179 180 The QtNetwork module is part of the \l{Qt Full Framework Edition} and the 181 \l{Open Source Versions of Qt}. 182 */ 183 184 /*! 185 \module QtOpenGL 186 \title QtOpenGL Module 187 \contentspage All Qt Modules 188 \previouspage QtNetwork 189 \nextpage QtOpenVG 190 \ingroup modules 191 192 \brief The QtOpenGL module offers classes that make it easy to 193 use OpenGL in Qt applications. 194 195 OpenGL is a standard API for rendering 3D graphics. OpenGL only 196 deals with 3D rendering and provides little or no support for GUI 197 programming issues. The user interface for an OpenGL application 198 must be created with another toolkit, such as Motif on the X 199 platform, Microsoft Foundation Classes (MFC) under Windows, or Qt 200 on both platforms. 201 202 \note OpenGL is a trademark of Silicon Graphics, Inc. in 203 the United States and other countries. 204 205 The Qt OpenGL module makes it easy to use OpenGL in Qt applications. 206 It provides an OpenGL widget class that can be used just like any 207 other Qt widget, except that it opens an OpenGL display buffer where 208 you can use the OpenGL API to render the contents. 209 210 To include the definitions of the module's classes, use the 211 following directive: 212 213 \snippet doc/src/snippets/code/doc_src_qtopengl.qdoc 0 214 215 To link against the module, add this line to your \l qmake \c 216 .pro file: 217 218 \snippet doc/src/snippets/code/doc_src_qtopengl.qdoc 1 219 220 The Qt OpenGL module is implemented as a platform-independent Qt/C++ 221 wrapper around the platform-dependent GLX (version 1.3 or later), 222 WGL, or AGL C APIs. Although the basic functionality provided is very 223 similar to Mark Kilgard's GLUT library, applications using the Qt 224 OpenGL module can take advantage of the whole Qt API for 225 non-OpenGL-specific GUI functionality. 226 227 The QtOpenGL module is part of the \l{Qt Full Framework Edition} and the 228 \l{Open Source Versions of Qt}. It is available on Windows, X11, and Mac OS X. 229 \l{Qt for Embedded Linux and OpenGL} supports OpenGL ES (OpenGL for Embedded Systems). 230 \note To be able to use the OpenGL API in \l{Qt for Embedded Linux}, it must be 231 integrated with the Q Window System (QWS). See the 232 \l{Qt for Embedded Linux and OpenGL} documentation for details. 233 234 */ 235 236 /*! 237 \module QtOpenVG 238 \title QtOpenVG Module 239 \since 4.6 240 \contentspage All Qt Modules 241 \previouspage QtOpenGL 242 \nextpage QtScript 243 \ingroup modules 244 245 \brief The QtOpenVG module is a plugin that provides support for 246 OpenVG painting. 247 248 OpenVG is a standard API from the 249 \l{http://www.khronos.org/openvg}{Khronos Group} for accelerated 250 2D vector graphics that is appearing in an increasing number of 251 embedded devices. 252 253 OpenVG support can be enabled by passing the \c{-openvg} option 254 to configure. It is assumed that the following qmake variables 255 are set to appropriate values in the qmake.conf file for your 256 platform: 257 258 \list 259 \o QMAKE_INCDIR_OPENVG 260 \o QMAKE_LIBDIR_OPENVG 261 \o QMAKE_LIBS_OPENVG 262 \endlist 263 264 Most OpenVG implementations are based on EGL, so the following 265 variables may also need to be set: 266 267 \list 268 \o QMAKE_INCDIR_EGL 269 \o QMAKE_LIBDIR_EGL 270 \o QMAKE_LIBS_EGL 271 \endlist 272 273 See \l{qmake Variable Reference} for more information on these variables. 274 275 Two kinds of OpenVG engines are currently supported: EGL based, 276 and engines built on top of OpenGL such as 277 \l{http://sourceforge.net/projects/shivavg}{ShivaVG}. 278 EGL based engines are preferred. 279 280 Once the graphics system plugin has been built and installed, 281 applications can be run as follows to use the plugin: 282 283 \code 284 app -graphicssystem OpenVG 285 \endcode 286 287 If ShivaVG is being used, then substitute \c ShivaVG instead of 288 \c OpenVG in the line above. 289 */ 290 291 /*! 292 \module QtScript 293 \title QtScript Module 294 \since 4.3 295 \contentspage All Qt Modules 296 \previouspage QtOpenVG 297 \nextpage QtScriptTools 298 \ingroup modules 299 300 \brief The QtScript module provides classes for making Qt applications scriptable. 301 302 The QtScript module only provides core scripting facilities; the 303 QtScriptTools module provides additional Qt Script-related 304 components that application developers may find useful. 305 306 \tableofcontents 307 308 To include the definitions of the module's classes, use the 309 following directive: 310 311 \snippet doc/src/snippets/code/doc_src_qtscript.qdoc 0 312 313 To link against the module, add this line to your \l qmake \c .pro file: 314 315 \snippet doc/src/snippets/code/doc_src_qtscript.qdoc 1 316 317 For detailed information on how to make your application 318 scriptable with QtScript, see \l{Making Applications 319 Scriptable}. 320 321 The QtScript module is part of the \l{Qt Full Framework Edition} and the 322 \l{Open Source Versions of Qt}. 323 324 \section1 License Information 325 326 Qt Commercial Edition licensees that wish to distribute applications that 327 use the QtScript module need to be aware of their obligations under the 328 GNU Library General Public License (LGPL). 329 330 Developers using the Open Source Edition can choose to redistribute 331 the module under the appropriate version of the GNU LGPL. 332 333 \legalese 334 QtScript is licensed under the GNU Library General Public License. 335 Individual contributor names and copyright dates can be found 336 inline in the code. 337 338 This library is free software; you can redistribute it and/or 339 modify it under the terms of the GNU Library General Public 340 License as published by the Free Software Foundation; either 341 version 2 of the License, or (at your option) any later version. 342 343 This library is distributed in the hope that it will be useful, 344 but WITHOUT ANY WARRANTY; without even the implied warranty of 345 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 346 Library General Public License for more details. 347 348 You should have received a copy of the GNU Library General Public License 349 along with this library; see the file COPYING.LIB. If not, write to 350 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, 351 Boston, MA 02110-1301, USA. 352 \endlegalese 353 354 */ 355 356 /*! 357 \module QtScriptTools 358 \title QtScriptTools Module 359 \since 4.5 360 \contentspage All Qt Modules 361 \previouspage QtScript 362 \nextpage QtSql 363 \ingroup modules 364 365 \brief The QtScriptTools module provides additional components for applications that use Qt Script. 366 367 \tableofcontents 368 369 \section1 Configuring the Build Process 370 371 Applications that use the Qt Script Tools classes need to 372 be configured to be built against the QtScriptTools module. 373 To include the definitions of the module's classes, use the 374 following directive: 375 376 \snippet doc/src/snippets/code/doc.src.qtscripttools.qdoc 0 377 378 To link against the module, add this line to your \l qmake \c .pro file: 379 380 \snippet doc/src/snippets/code/doc.src.qtscripttools.qdoc 1 381 382 The QtScriptTools module is part of the \l{Qt Full Framework Edition} and 383 the \l{Open Source Versions of Qt}. 384 */ 385 386 /*! 387 \module QtSql 388 \title QtSql Module 389 \contentspage All Qt Modules 390 \previouspage QtScript 391 \nextpage QtSvg 392 \ingroup modules 393 394 To include the definitions of the module's classes, use the 395 following directive: 396 397 \snippet doc/src/snippets/code/doc_src_qtsql.qdoc 0 398 399 To link against the module, add this line to your \l qmake \c 400 .pro file: 401 402 \snippet doc/src/snippets/code/doc_src_qtsql.qdoc 1 403 404 The QtSql module is part of the \l{Qt Full Framework Edition} and the 405 \l{Open Source Versions of Qt}. 406 407 See the \l{SQL Programming} guide for information about using this 408 module in your applications. 409 */ 410 411 /*! 412 \module QtSvg 413 \title QtSvg Module 414 \since 4.1 415 \contentspage All Qt Modules 416 \previouspage QtSql 417 \nextpage QtWebKit 418 \ingroup modules 419 420 \brief The QtSvg module provides classes for displaying and creating SVG files. 421 422 To include the definitions of the module's classes, use the 423 following directive: 424 425 \snippet doc/src/snippets/code/doc_src_qtsvg.qdoc 0 426 427 To link against the module, add this line to your \l qmake \c 428 .pro file: 429 430 \snippet doc/src/snippets/code/doc_src_qtsvg.qdoc 1 431 432 The QtSvg module is part of the \l{Qt Full Framework Edition} and the 433 \l{Open Source Versions of Qt}. 434 435 \section1 License Information 436 437 Some code for arc handling in this module is derived from code with 438 the following license: 439 440 \legalese 441 Copyright 2002 USC/Information Sciences Institute 442 443 Permission to use, copy, modify, distribute, and sell this software 444 and its documentation for any purpose is hereby granted without 445 fee, provided that the above copyright notice appear in all copies 446 and that both that copyright notice and this permission notice 447 appear in supporting documentation, and that the name of 448 Information Sciences Institute not be used in advertising or 449 publicity pertaining to distribution of the software without 450 specific, written prior permission. Information Sciences Institute 451 makes no representations about the suitability of this software for 452 any purpose. It is provided "as is" without express or implied 453 warranty. 454 455 INFORMATION SCIENCES INSTITUTE DISCLAIMS ALL WARRANTIES WITH REGARD 456 TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF 457 MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL INFORMATION SCIENCES 458 INSTITUTE BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL 459 DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA 460 OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER 461 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 462 PERFORMANCE OF THIS SOFTWARE. 463 \endlegalese 464 */ 465 466 /*! 467 \module QtXml 468 \title QtXml Module 469 \contentspage All Qt Modules 470 \previouspage QtSvg 471 \nextpage QtXmlPatterns 472 \ingroup modules 473 474 \brief The QtXml module provides a stream reader and writer for 475 XML documents, and C++ implementations of SAX and DOM. 476 477 To include the definitions of the module's classes, use the 478 following directive: 479 480 \snippet doc/src/snippets/code/doc_src_qtxml.qdoc 0 481 482 To link against the module, add this line to your \l qmake \c 483 .pro file: 484 485 \snippet doc/src/snippets/code/doc_src_qtxml.qdoc 1 486 487 Further XML support is provided by the \l{Qt Solutions} group who 488 provide, for example, classes that support SOAP and MML with the 489 Qt XML classes. 490 491 This module is part of the \l{Qt Full Framework Edition} and the 492 \l{Open Source Versions of Qt}. 493 */ 494 495 /*! 496 \module QtXmlPatterns 497 \title QtXmlPatterns Module 498 \since 4.4 499 \contentspage All Qt Modules 500 \previouspage QtXml 501 \nextpage Phonon Module 502 \ingroup modules 503 504 \brief The QtXmlPatterns module provides support for XPath, 505 XQuery, XSLT and XML Schema validation. 506 507 To include the definitions of the module's classes, use the 508 following directive: 509 510 \snippet doc/src/snippets/code/doc_src_qtxmlpatterns.qdoc 0 511 512 To link against the module, add this line to your \l qmake \c 513 .pro file: 514 515 \snippet doc/src/snippets/code/doc_src_qtxmlpatterns.qdoc 1 516 517 This module is part of the \l{Qt Full Framework Edition} and the 518 \l{Open Source Versions of Qt}. 519 520 \section1 License Information 521 522 The XML Schema implementation provided by this module contains the \c xml.xsd file 523 (located in \c{src/xmlpatterns/schema/schemas}) which is licensed under the terms 524 given below. This module is always built with XML Schema support enabled. 525 526 \legalese 527 W3C\copyright SOFTWARE NOTICE AND LICENSE 528 529 This license came from: http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231 530 531 This work (and included software, documentation such as READMEs, or other 532 related items) is being provided by the copyright holders under the following 533 license. By obtaining, using and/or copying this work, you (the licensee) 534 agree that you have read, understood, and will comply with the following 535 terms and conditions. 536 537 Permission to copy, modify, and distribute this software and its 538 documentation, with or without modification, for any purpose and without 539 fee or royalty is hereby granted, provided that you include the following on 540 ALL copies of the software and documentation or portions thereof, including 541 modifications: 542 543 1. The full text of this NOTICE in a location viewable to users of the 544 redistributed or derivative work.\br 545 2. Any pre-existing intellectual property disclaimers, notices, or terms 546 and conditions. If none exist, the W3C Software Short Notice should be 547 included (hypertext is preferred, text is permitted) 548 within the body of any redistributed or derivative code.\br 549 3. Notice of any changes or modifications to the files, including the date 550 changes were made. (We recommend you provide URIs to the location from 551 which the code is derived.) 552 553 THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS 554 MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT 555 LIMITED TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR 556 PURPOSE OR THAT THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE 557 ANY THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS. 558 559 COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR 560 CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR 561 DOCUMENTATION. 562 563 The name and trademarks of copyright holders may NOT be used in 564 advertising or publicity pertaining to the software without specific, written 565 prior permission. Title to copyright in this software and any associated 566 documentation will at all times remain with copyright holders. 567 \endlegalese 568 */ 569 570 /*! 571 \page phonon-module.html 572 \module Phonon 573 \title Phonon Module 574 \contentspage All Qt Modules 575 \previouspage QtXmlPatterns 576 \nextpage Qt3Support 577 \ingroup modules 578 579 \brief The Phonon module contains namespaces and classes for multimedia functionality. 580 581 \generatelist{classesbymodule Phonon} 582 583 Phonon is a cross-platform multimedia framework that enables the use of 584 audio and video content in Qt applications. The \l{Phonon Overview} 585 document provides an introduction to the architecture and features included 586 in Phonon. The \l{Phonon} namespace contains a list of all classes, functions 587 and namespaces provided by the module. 588 589 Applications that use Phonon's classes need to 590 be configured to be built against the Phonon module. 591 The following declaration in a \c qmake project file ensures that 592 an application is compiled and linked appropriately: 593 594 \snippet doc/src/snippets/code/doc_src_phonon.qdoc 1 595 596 The Phonon module is part of the \l{Qt Full Framework Edition} and the 597 \l{Open Source Versions of Qt}. 598 599 \section1 Qt Backends 600 601 Qt Backends are currently developed for Phonon version 4.1. The Phonon 602 project has moved on and introduced new features that the Qt Backends do not 603 implement. We have chosen not to document the part of Phonon that we do not 604 support. Any class or function not appearing in our documentation can be 605 considered unsupported. 606 607 \section1 License Information 608 609 Qt Commercial Edition licensees that wish to distribute applications that 610 use the Phonon module need to be aware of their obligations under the 611 GNU Lesser General Public License (LGPL). 612 613 Developers using the Open Source Edition can choose to redistribute 614 the module under the appropriate version of the GNU LGPL; version 2.1 615 for applications and libraries licensed under the GNU GPL version 2, 616 or version 3 for applications and libraries licensed under the GNU 617 GPL version 3. 618 619 \legalese 620 This file is part of the KDE project 621 622 Copyright (C) 2004-2009 Matthias Kretz <[email protected]> \BR 623 Copyright (C) 2008 Ian Monroe <[email protected]> \BR 624 Copyright (C) 2007-2008 Trolltech ASA \BR 625 Copyright (C) 2008-2009 Nokia Corporation and/or its subsidiary(-ies). \BR 626 Contact: Nokia Corporation ([email protected]) 627 628 This library is free software; you can redistribute it and/or 629 modify it under the terms of the GNU Library General Public 630 License version 2 as published by the Free Software Foundation. 631 632 This library is distributed in the hope that it will be useful, 633 but WITHOUT ANY WARRANTY; without even the implied warranty of 634 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 635 Library General Public License for more details. 636 637 You should have received a copy of the GNU Library General Public License 638 along with this library; see the file COPYING.LIB. If not, write to 639 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, 640 Boston, MA 02110-1301, USA. 641 \endlegalese 642 */ 643 644 /*! 645 \module Qt3Support 646 \title Qt3Support Module 647 \contentspage All Qt Modules 648 \previouspage Phonon Module 649 \nextpage QtDesigner 650 \ingroup modules 651 652 \keyword Qt3Support 653 \brief The Qt3Support module provides classes that ease porting 654 from Qt 3 to Qt 4. 655 656 \warning The classes in this module are intended to be used in 657 intermediate stages of a porting process and are not intended 658 to be used in production code. 659 660 To include the definitions of the module's classes, use the 661 following directive: 662 663 \snippet doc/src/snippets/code/doc_src_qt3support.qdoc 0 664 665 To link against the module, add this line to your \l qmake \c 666 .pro file: 667 668 \snippet doc/src/snippets/code/doc_src_qt3support.qdoc 1 669 670 \note Since this module provides compatibility classes for 671 diverse parts of the Qt 3 API, it has dependencies on the QtCore, 672 QtGui, QtNetwork, QtSql, and QtXml modules. 673 674 This module is part of the \l{Qt Full Framework Edition} and the 675 \l{Open Source Versions of Qt}. Most classes offered by this module are 676 also part of the \l{Qt GUI Framework Edition}. 677 Classes that are not available for \l{Qt GUI Framework Edition} 678 users are marked as such in the class documentation. 679 680 \sa {Porting to Qt 4} 681 */ 682 683 /*! 684 \module QtDesigner 685 \title QtDesigner Module 686 \contentspage All Qt Modules 687 \previouspage Qt3Support 688 \nextpage QtUiTools 689 \ingroup modules 690 691 \brief The QtDesigner module provides classes that allow you to 692 create your own custom widget plugins for Qt Designer, and classes 693 that enable you to access Qt Designer's components. 694 695 In addition, the QFormBuilder class provides the possibility of 696 constructing user interfaces from UI files at run-time. 697 698 To include the definitions of the module's classes, use the 699 following directive: 700 701 \snippet doc/src/snippets/code/doc_src_qtdesigner.qdoc 0 702 703 To link against the module, add this line to your \c qmake .pro 704 file: 705 706 \snippet doc/src/snippets/code/doc_src_qtdesigner.qdoc 1 707 708 \note These classes are part of the \l{Open Source Versions of Qt} and 709 \l{Qt Commercial Editions}{Qt Full Framework Edition} for commercial 710 users. 711 */ 712 713 /*! 714 \module QtUiTools 715 \title QtUiTools Module 716 \since 4.1 717 \contentspage All Qt Modules 718 \previouspage QtDesigner 719 \nextpage QtHelp 720 \ingroup modules 721 722 \brief The QtUiTools module provides classes to handle forms created 723 with Qt Designer. 724 725 These forms are processed at run-time to produce dynamically-generated 726 user interfaces. In order to generate a form at run-time, a resource 727 file containing a UI file is needed. Applications that use the 728 form handling classes need to be configured to be built against the 729 QtUiTools module. This is done by including the following declaration 730 in a \c qmake project file to ensure that the application is compiled 731 and linked appropriately. 732 733 \snippet doc/src/snippets/code/doc_src_qtuiloader.qdoc 0 734 735 A form loader object, provided by the QUiLoader class, is used to 736 construct the user interface. This user interface can 737 be retrieved from any QIODevice; for example, a QFile object can be 738 used to obtain a form stored in a project's resources. The 739 QUiLoader::load() function takes the user interface description 740 contained in the file and constructs the form widget. 741 742 To include the definitions of the module's classes, use the following 743 directive: 744 745 \snippet doc/src/snippets/code/doc_src_qtuiloader.qdoc 1 746 747 \note These classes are part of the \l{Open Source Versions of Qt} and 748 \l{Qt Commercial Editions}{Qt Full Framework Edition} for commercial 749 users. 750 751 \sa{Calculator Builder Example}, {World Time Clock Builder Example} 752 */ 753 754 /*! 755 \module QtHelp 756 \title QtHelp Module 757 \contentspage All Qt Modules 758 \previouspage QtUiTools 759 \nextpage QtTest 760 \ingroup modules 761 762 \brief The QtHelp module provides classes for integrating 763 online documentation in applications. 764 765 To include the definitions of the module's classes, use the 766 following directive: 767 768 \snippet doc/src/snippets/code/doc_src_qthelp.qdoc 0 769 770 To link against the module, add this line to your \l qmake \c 771 .pro file: 772 773 \snippet doc/src/snippets/code/doc_src_qthelp.qdoc 1 774 775 These classes are part of the \l{Open Source Versions of Qt} and 776 \l{Qt Commercial Editions}{Qt Full Framework Edition} for commercial 777 users. 778 779 \section1 License Information 780 781 The QtHelp module uses the CLucene indexing library to provide full-text 782 searching capabilities for Qt Assistant and applications that use the 783 features of QtHelp. 784 785 Qt Commercial Edition licensees that wish to distribute applications that 786 use these features of the QtHelp module need to be aware of their 787 obligations under the GNU Lesser General Public License (LGPL). 788 789 Developers using the Open Source Edition can choose to redistribute 790 the module under the appropriate version of the GNU LGPL; version 2.1 791 for applications and libraries licensed under the GNU GPL version 2, 792 or version 3 for applications and libraries licensed under the GNU 793 GPL version 3. 794 795 \legalese 796 Copyright (C) 2003-2006 Ben van Klinken and the CLucene Team \BR 797 Changes are Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). 798 799 This library is free software; you can redistribute it and/or 800 modify it under the terms of the GNU Lesser General Public 801 License as published by the Free Software Foundation; either 802 version 2.1 of the License, or (at your option) any later version. 803 804 This library is distributed in the hope that it will be useful, 805 but WITHOUT ANY WARRANTY; without even the implied warranty of 806 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 807 Lesser General Public License for more details. 808 809 You should have received a copy of the GNU Lesser General Public 810 License along with this library; if not, write to the Free Software 811 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 812 \endlegalese 813 814 \sa {The Qt Help Framework} 815 */ 816 817 /*! 818 \module QtTest 819 \title QtTest Module 820 \contentspage All Qt Modules 821 \previouspage QtHelp 822 \nextpage QAxContainer 823 \ingroup modules 824 825 \keyword QtTest 826 827 \brief The QtTest module provides classes for unit testing Qt applications and libraries. 828 829 Applications that use Qt's unit testing classes need to 830 be configured to be built against the QtTest module. 831 To include the definitions of the module's classes, use the 832 following directive: 833 834 \snippet doc/src/snippets/code/doc_src_qttest.qdoc 0 835 836 To link against the module, add this line to your \l qmake \c 837 .pro file: 838 839 \snippet doc/src/snippets/code/doc_src_qttest.qdoc 1 840 841 See the \l{QTestLib Manual} for a detailed introduction on how to use 842 Qt's unit testing features with your applications. 843 844 The QtTest module is part of all \l{Qt editions}. 845 */ 846 847 /*! 848 \module QAxContainer 849 \title QAxContainer Module 850 \contentspage All Qt Modules 851 \previouspage QtTest 852 \nextpage QAxServer 853 \ingroup modules 854 855 \brief The QAxContainer module is a Windows-only extension for 856 accessing ActiveX controls and COM objects. 857 858 \section1 License Information 859 860 The QAxContainer module is not covered by the \l{GNU General Public License (GPL)}, 861 the \l{GNU Lesser General Public License (LGPL)}, or the 862 \l{Qt Commercial Editions}{Qt Commercial License}. Instead, it is distributed under 863 the following license. 864 865 \legalese 866 Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).\br 867 All rights reserved. 868 869 Contact: Nokia Corporation ([email protected])\br 870 871 You may use this file under the terms of the BSD license as follows:\br 872 873 "Redistribution and use in source and binary forms, with or without modification, 874 are permitted provided that the following conditions are met: 875 876 * Redistributions of source code must retain the above copyright notice, this list 877 of conditions and the following disclaimer.\br 878 * Redistributions in binary form must reproduce the above copyright notice, this 879 list of conditions and the following disclaimer in the documentation and/or other 880 materials provided with the distribution.\br 881 * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor the names of 882 its contributors may be used to endorse or promote products derived from this 883 software without specific prior written permission. 884 885 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY 886 EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 887 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 888 SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 889 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 890 TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 891 BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 892 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 893 ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." 894 \endlegalese 895 */ 896 897 /*! 898 \module QAxServer 899 \title QAxServer Module 900 \contentspage All Qt Modules 901 \previouspage QAxContainer 902 \nextpage QtDBus module 903 \ingroup modules 904 905 \brief The QAxServer module is a Windows-only static library that 906 you can use to turn a standard Qt binary into a COM server. 907 908 \section1 License Information 909 910 The QAxContainer module is not covered by the \l{GNU General Public License (GPL)}, 911 the \l{GNU Lesser General Public License (LGPL)}, or the 912 \l{Qt Commercial Editions}{Qt Commercial License}. Instead, it is distributed under 913 the following license. 914 915 \legalese 916 Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).\br 917 All rights reserved. 918 919 Contact: Nokia Corporation ([email protected])\br 920 921 You may use this file under the terms of the BSD license as follows:\br 922 923 "Redistribution and use in source and binary forms, with or without modification, 924 are permitted provided that the following conditions are met: 925 926 * Redistributions of source code must retain the above copyright notice, this list 927 of conditions and the following disclaimer.\br 928 * Redistributions in binary form must reproduce the above copyright notice, this 929 list of conditions and the following disclaimer in the documentation and/or other 930 materials provided with the distribution.\br 931 * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor the names of 932 its contributors may be used to endorse or promote products derived from this 933 software without specific prior written permission. 934 935 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY 936 EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 937 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 938 SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 939 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 940 TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 941 BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 942 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 943 ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." 944 \endlegalese 945 */ 946 947 /*! 948 \module QtDBus 949 \title QtDBus module 950 \contentspage All Qt Modules 951 \previouspage QAxServer 952 \ingroup modules 953 954 \keyword QtDBus 955 \target The QDBus compiler 956 957 \brief The QtDBus module is a Unix-only library that you can use 958 to perform Inter-Process Communication using the \l{Introduction to 959 D-Bus}{D-Bus} protocol. 960 961 Applications using the QtDBus module can provide services to 962 other, remote applications by exporting objects, as well as use 963 services exported by those applications by placing calls and 964 accessing properties. 965 966 The QtDBus module provides an interface that extends the Qt \l 967 {signalsandslots.html}{Signals and Slots} mechanism, allowing one 968 to connect to a signal emitted remotely as well as to connect a 969 local signal to remote slot. 970 971 To use this module, use the following code in your application: 972 973 \snippet doc/src/snippets/code/doc_src_qtdbus.qdoc 0 974 975 If you're using qmake to build your application, you can add this 976 line to your .pro file to make it link against the QtDBus 977 libraries: 978 979 \snippet doc/src/snippets/code/doc_src_qtdbus.qdoc 1 980 981 \note The source code for this module is located in the \c{src/qdbus} 982 directory. When installing Qt from source, this module is built when Qt's 983 tools are built. 984 985 See the \l {Introduction to D-Bus} page for detailed information on 986 how to use this module. 987 988 This module is part of all \l{Qt editions}. 989 */ 990 991 /*! 992 \page qtmain.html 993 \title The qtmain Library 994 \ingroup licensing 995 \ingroup platform-specific 996 \brief Describes the use and license of the qtmain helper library. 997 998 qtmain is a helper library that enables the developer to write a 999 cross-platform main() function on Windows and on the Symbian platform. 1000 If you do not use \l qmake or other build tools such as CMake, then you 1001 need to link against the \c qtmain library. 1002 1003 \section1 License Information 1004 1005 The QAxContainer module is not covered by the \l{GNU General Public License (GPL)}, 1006 the \l{GNU Lesser General Public License (LGPL)}, or the 1007 \l{Qt Commercial Editions}{Qt Commercial License}. Instead, it is distributed under 1008 the following license. 1009 1010 \legalese 1011 Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).\br 1012 All rights reserved. 1013 1014 Contact: Nokia Corporation ([email protected]) 1015 1016 You may use this file under the terms of the BSD license as follows: 1017 1018 "Redistribution and use in source and binary forms, with or without modification, 1019 are permitted provided that the following conditions are met: 1020 1021 * Redistributions of source code must retain the above copyright notice, this list 1022 of conditions and the following disclaimer.\br 1023 * Redistributions in binary form must reproduce the above copyright notice, this 1024 list of conditions and the following disclaimer in the documentation and/or other 1025 materials provided with the distribution.\br 1026 * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor the names of 1027 its contributors may be used to endorse or promote products derived from this 1028 software without specific prior written permission. 1029 1030 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY 1031 EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 1032 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 1033 SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 1034 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 1035 TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 1036 BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 1037 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 1038 ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." 1039 \endlegalese 1040 1041 The contents of the \c{qts60main.cpp} and \c{qts60main_mcrt0.cpp} files, 1042 located in the \c{src/s60main} directory are not covered by the 1043 \l{GNU General Public License (GPL)}, the 1044 \l{GNU Lesser General Public License (LGPL)}, or the 1045 \l{Qt Commercial Editions}{Qt Commercial License}. Instead, they are 1046 distributed under the following license. 1047 1048 \legalese 1049 Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).\br 1050 All rights reserved.\br 1051 Contact: Nokia Corporation ([email protected]) 1052 1053 This file is part of the Symbian application wrapper of the Qt Toolkit. 1054 1055 You may use this file under the terms of the BSD license as follows: 1056 1057 "Redistribution and use in source and binary forms, with or without 1058 modification, are permitted provided that the following conditions are 1059 met:\br 1060 * Redistributions of source code must retain the above copyright 1061 notice, this list of conditions and the following disclaimer.\br 1062 * Redistributions in binary form must reproduce the above copyright 1063 notice, this list of conditions and the following disclaimer in the 1064 documentation and/or other materials provided with the distribution.\br 1065 * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor 1066 the names of its contributors may be used to endorse or promote 1067 products derived from this software without specific prior written 1068 permission. 1069 1070 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS 1071 IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 1072 THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 1073 PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 1074 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 1075 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 1076 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 1077 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 1078 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 1079 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 1080 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." 1081 \endlegalese 1082 */ 1083 1084 /*! 1085 \page qtassistant.html 1086 \title QtAssistant 1087 1088 This module is no longer needed. Use the QtHelp module to integrate documentation 1089 into your application. 1090 1091 \sa {QtHelp} 1092 */
Note:
See TracChangeset
for help on using the changeset viewer.