source: trunk/doc/src/getting-started/examples.qdoc@ 788

/****************************************************************************
**
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation ([email protected])
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial Usage
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** If you have questions regarding the use of this file, please contact
** Nokia at [email protected].
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \page examples-overview.html
    \raw HTML
    <script>
    document.location.href = "examples.html";
    </script>
    \endraw
    Click this \l{Qt Examples}{link} if you don't get redirected.
*/

/*!
    \page examples.html
    \title Qt Examples
    \brief The example programs provided with Qt.

    \previouspage Tutorials
    \contentspage How to Learn Qt
    \nextpage Qt Demonstrations

    Qt is supplied with a variety of examples that cover almost every aspect
    of development. They are not all designed to be impressive when you run
    them, but their source code is carefully written to show good Qt
    programming practices. You can launch any of these programs from the
    \l{Examples and Demos Launcher} application.

    These examples are ordered by functional area, but many examples often
    use features from many parts of Qt to highlight one area in particular.
    If you are new to Qt, you should probably start by going through the
    \l{Tutorials} before you have a look at the
    \l{mainwindows/application}{Application} example.

    In addition to the examples and the tutorial, Qt includes a
    \l{Qt Demonstrations}{selection of demos} that deliberately show off
    Qt's features. You might want to look at these as well.

    \section1 \l{Widgets Examples}{Widgets}
    \beginfloatleft
    \l{Widgets Examples}{\inlineimage widget-examples.png
    }

    \endfloat
    Qt comes with a large range of standard widgets that users of modern
    applications have come to expect. You can also develop your own custom
    widgets and controls, and use them alongside standard widgets.

    It is even possible to provide custom styles and themes for widgets that can
    be used to change the appearance of standard widgets and appropriately
    written custom widgets.

    \clearfloat
    \section1 \l{Dialog Examples}{Dialogs}
    \beginfloatleft
    \l{Dialog Examples}{\inlineimage dialog-examples.png
    }

    \endfloat
    Qt includes standard dialogs for many common operations, such as file
    selection, printing, and color selection.

    Custom dialogs can also be created for specialized modal or modeless
    interactions with users.

    \clearfloat
    \section1 \l{Main Window Examples}{Main Windows}
    \beginfloatleft
    \l{Main Window Examples}{\inlineimage mainwindow-examples.png
    }

    \endfloat
    All the standard features of application main windows are provided by Qt.

    Main windows can have pull down menus, tool bars, and dock windows. These
    separate forms of user input are unified in an integrated action system that
    also supports keyboard shortcuts and accelerator keys in menu items.

    \clearfloat
    \section1 \l{Layout Examples}{Layouts}
    \beginfloatleft
    \l{Layout Examples}{\inlineimage layout-examples.png
    }

    \endfloat
    Qt uses a layout-based approach to widget management. Widgets are arranged in
    the optimal positions in windows based on simple layout rules, leading to a
    consistent look and feel.

    Custom layouts can be used to provide more control over the positions and
    sizes of child widgets.

    \clearfloat
    \section1 \l{Item Views Examples}{Item Views}
    \beginfloatleft
    \l{Item Views Examples}{\inlineimage itemview-examples.png
    }

    \endfloat
    Item views are widgets that typically display data sets. Qt 4's model/view
    framework lets you handle large data sets by separating the underlying data
    from the way it is represented to the user, and provides support for
    customized rendering through the use of delegates.

    \clearfloat
    \section1 \l{Graphics View Examples}{Graphics View}
    \beginfloatleft
    \l{Graphics View Examples}{\inlineimage graphicsview-examples.png
    }

    \endfloat
    Qt is provided with a comprehensive canvas through the GraphicsView
    classes.

    \clearfloat
    \section1 \l{Painting Examples}{Painting}
    \beginfloatleft
    \l{Painting Examples}{\inlineimage painting-examples.png
    }

    \endfloat
    Qt's painting system is able to render vector graphics, images, and outline
    font-based text with sub-pixel accuracy accuracy using anti-aliasing to
    improve rendering quality.

    \clearfloat
    \section1 \l{Rich Text Examples}{Rich Text}
    \beginfloatleft
    \l{Rich Text Examples}{\inlineimage richtext-examples.png
    }

    \endfloat
    Qt provides powerful document-oriented rich text engine that supports Unicode
    and right-to-left scripts. Documents can be manipulated using a cursor-based
    API, and their contents can be imported and exported as both HTML and in a
    custom XML format.

    \clearfloat
    \section1 \l{Desktop Examples}{Desktop}
    \beginfloatleft
    \l{Desktop Examples}{\inlineimage desktop-examples.png
    }

    \endfloat
    Qt provides features to enable applications to integrate with the user's
    preferred desktop environment.

    Features such as system tray icons, access to the desktop widget, and
    support for desktop services can be used to improve the appearance of
    applications and take advantage of underlying desktop facilities.

    \clearfloat
    \section1 \l{Drag and Drop Examples}{Drag and Drop}
    \beginfloatleft
    \l{Drag and Drop Examples}{\inlineimage draganddrop-examples.png
    }

    \endfloat
    Qt supports native drag and drop on all platforms via an extensible
    MIME-based system that enables applications to send data to each other in the
    most appropriate formats.

    Drag and drop can also be implemented for internal use by applications.

    \clearfloat
    \section1 \l{Threading and Concurrent Programming Examples}{Threading and Concurrent Programming}
    \beginfloatleft
    \l{Threading and Concurrent Programming Examples}{\inlineimage thread-examples.png
    }

    \endfloat
    Qt 4 makes it easier than ever to write multithreaded applications. More
    classes have been made usable from non-GUI threads, and the signals and slots
    mechanism can now be used to communicate between threads.

    The QtConcurrent namespace includes a collection of classes and functions
    for straightforward concurrent programming.

    \clearfloat
    \section1 \l{Tools Examples}{Tools}
    \beginfloatleft
    \l{Tools Examples}{\inlineimage tool-examples.png
    }

    \endfloat
    Qt is equipped with a range of capable tool classes, from containers and
    iterators to classes for string handling and manipulation.

    Other classes provide application infrastructure support, handling plugin
    loading and managing configuration files.

    \clearfloat
    \section1 \l{Network Examples}{Network}
    \beginfloatleft
    \l{Network Examples}{\inlineimage network-examples.png
    }

    \endfloat
    Qt is provided with an extensive set of network classes to support both
    client-based and server side network programming.

    \clearfloat
    \section1 \l{Inter-Process Communication Examples}{Inter-Process Communication}
    \beginfloatleft
    \l{Inter-Process Communication Examples}{\inlineimage ipc-examples.png
    }

    \endfloat
    Simple, lightweight inter-process communication can be performed using shared
    memory and local sockets.

    \clearfloat
    \section1 \l{OpenGL Examples}{OpenGL} and \l{OpenVG Examples}{OpenVG} Examples
    \beginfloatleft
    \l{OpenGL Examples}{\inlineimage opengl-examples.png
    }

    \endfloat
    Qt provides support for integration with OpenGL implementations on all
    platforms, giving developers the opportunity to display hardware accelerated
    3D graphics alongside a more conventional user interface.

    Qt provides support for integration with OpenVG implementations on
    platforms with suitable drivers.

    \clearfloat
    \section1 \l{Multimedia Examples}{Multimedia Framework}
    \beginfloatleft
    \l{Multimedia Examples}{\inlineimage phonon-examples.png
    }

    \endfloat
    Qt provides low-level audio support on linux,windows and mac platforms by default and
    an audio plugin API to allow developers to implement there own audio support for
    custom devices and platforms.

    The Phonon Multimedia Framework brings multimedia support to Qt applications.

    \clearfloat
    \section1 \l{SQL Examples}{SQL}
    \beginfloatleft
    \l{SQL Examples}{\inlineimage sql-examples.png
    }

    \endfloat
    Qt provides extensive database interoperability, with support for products
    from both open source and proprietary vendors.

    SQL support is integrated with Qt's model/view architecture, making it easier
    to provide GUI integration for your database applications.

    \clearfloat
    \section1 \l{XML Examples}{XML}
    \beginfloatleft
    \l{XML Examples}{\inlineimage xml-examples.png
    }

    \endfloat
    XML parsing and handling is supported through SAX and DOM compliant APIs
    as well as streaming classes.

    The XQuery/XPath and XML Schema engines in the QtXmlPatterns modules
    provide classes for querying XML files and custom data models.

    \clearfloat
    \section1 \l{Qt Designer Examples}{Qt Designer}
    \beginfloatleft
    \l{Qt Designer Examples}{\inlineimage designer-examples.png
    }

    \endfloat
    Qt Designer is a capable graphical user interface designer that lets you
    create and configure forms without writing code. GUIs created with
    Qt Designer can be compiled into an application or created at run-time.

    \clearfloat
    \section1 \l{UiTools Examples}{UiTools}
    \beginfloatleft
    \l{UiTools Examples}{\inlineimage uitools-examples.png
    }

    \endfloat
    User interfaces created with Qt Designer can be loaded and displayed at
    run-time using the facilities of the QtUiTools module without the need
    to generate code in advance.

    \clearfloat
    \section1 \l{Qt Linguist Examples}{Qt Linguist}
    \beginfloatleft
    \l{Qt Linguist Examples}{\inlineimage linguist-examples.png
    }

    \endfloat
    Internationalization is a core feature of Qt.

    \clearfloat
    \section1 \l{Qt Script Examples}{Qt Script}
    \beginfloatleft
    \l{Qt Script Examples}{\inlineimage qtscript-examples.png
    }

    \endfloat
    Qt is provided with a powerful embedded scripting environment through the QtScript
    classes.

    \clearfloat
    \section1 \l{WebKit Examples}{WebKit}
    \beginfloatleft
    \l{WebKit Examples}{\inlineimage webkit-examples.png
    }

    \endfloat
    Qt provides an integrated Web browser component based on WebKit, the popular
    open source browser engine.

    \clearfloat
    \section1 \l{Help System Examples}{Help System}
    \beginfloatleft
    \l{Help System Examples}{\inlineimage assistant-examples.png
    }

    \endfloat
    Support for interactive help is provided by the Qt Assistant application.
    Developers can take advantages of the facilities it offers to display
    specially-prepared documentation to users of their applications.

    \clearfloat
    \section1 \l{State Machine Examples}{State Machine}
    \beginfloatleft
    \l{State Machine Examples}{\inlineimage statemachine-examples.png
    }

    \endfloat
    Qt provides a powerful hierarchical finite state machine through the Qt State
    Machine classes.

    \clearfloat
    \section1 \l{Animation Framework Examples}{Animation Framework}
    \beginfloatleft
    \l{Animation Framework Examples}{\inlineimage animation-examples.png
    }

    \endfloat
    These examples show to to use the \l{The Animation Framework}{animation framework}
    to build highly animated, high-performance GUIs.

    \clearfloat
    \section1 \l{Multi-Touch Examples}{Multi-Touch Framework}
    \beginfloatleft
    \l{Multi-Touch Examples}{\inlineimage multitouch-examples.png
    }

    \endfloat
    Support for multi-touch input makes it possible for developers to create
    extensible and intuitive user interfaces.

    \clearfloat
    \section1 \l{Gestures Examples}{Gestures}
    \beginfloatleft
    \l{Gestures Examples}{\inlineimage gestures-examples.png
    }

    \endfloat
    Applications can be written to respond to gestures as a natural input method.
    These examples show how to enable support for standard and custom gestures in
    applications.

    \clearfloat
    \section1 \l{D-Bus Examples}{D-Bus}
    \beginfloatleft
    \l{D-Bus Examples}{\inlineimage dbus-examples.png
    }

    \endfloat
    Systems with limited resources, specialized hardware, and small
    screens require special attention.

    \clearfloat
    \section1 \l{Qt for Embedded Linux Examples}{Qt for Embedded Linux}
    \beginfloatleft
    \l{Qt for Embedded Linux Examples}{\inlineimage qt-embedded-examples.png
    }

    \endfloat
    D-Bus is an inter-process communication protocol for Unix/Linux systems.
    These examples demonstrate how to write application that communicate with
    each other.

    \clearfloat
    \section1 \l{ActiveQt Examples}{ActiveQt}
    \beginfloatleft
    \l{ActiveQt Examples}{\inlineimage activeqt-examples.png
    }

    \endfloat
    These examples demonstrate how to write ActiveX controls and control servers
    with Qt, and how to use ActiveX controls and COM objects in a Qt application.

    \clearfloat
    \section1 \l{Qt Quarterly}{Qt Quarterly}
    \beginfloatleft
    \l{Qt Quarterly}{\inlineimage qq-thumbnail.png
    }

    \endfloat
    One more valuable source for examples and explanations of Qt
    features is the archive of \l{Qt Quarterly}, a newsletter for
    Qt developers.

    \clearfloat
*/

/*!
    \page examples-widgets.html
    \title Widgets Examples

    \contentspage Qt Examples
    \nextpage Dialog Examples

    \image widget-examples.png

    Qt comes with a large range of standard widgets that users of modern
    applications have come to expect.

    You can also develop your own custom widgets and controls, and use them
    alongside standard widgets.

    It is even possible to provide custom styles and themes for widgets that can
    be used to change the appearance of standard widgets and appropriately
    written custom widgets.

    \list
    \o \l{widgets/analogclock}{Analog Clock}\raisedaster
    \o \l{widgets/calculator}{Calculator}\raisedaster
    \o \l{widgets/calendarwidget}{Calendar Widget}\raisedaster
    \o \l{widgets/charactermap}{Character Map}\raisedaster
    \o \l{widgets/codeeditor}{Code Editor}\raisedaster
    \o \l{widgets/digitalclock}{Digital Clock}\raisedaster
    \o \l{widgets/groupbox}{Group Box}\raisedaster
    \o \l{widgets/icons}{Icons}\raisedaster
    \o \l{widgets/imageviewer}{Image Viewer}\raisedaster
    \o \l{widgets/lineedits}{Line Edits}\raisedaster
    \o \l{widgets/movie}{Movie}
    \o \l{widgets/scribble}{Scribble}\raisedaster
    \o \l{widgets/shapedclock}{Shaped Clock}\raisedaster
    \o \l{widgets/sliders}{Sliders}\raisedaster
    \o \l{widgets/softkeys}{Soft Keys}
    \o \l{widgets/spinboxes}{Spin Boxes}\raisedaster
    \o \l{widgets/styles}{Styles}\raisedaster
    \o \l{widgets/stylesheet}{Style Sheet}\raisedaster
    \o \l{widgets/tablet}{Tablet}\raisedaster
    \o \l{widgets/tetrix}{Tetrix}\raisedaster
    \o \l{widgets/tooltips}{Tooltips}\raisedaster
    \o \l{widgets/validators}{Validators}
    \o \l{widgets/wiggly}{Wiggly}\raisedaster
    \o \l{widgets/windowflags}{Window Flags}\raisedaster
    \endlist

    Examples marked with an asterisk (*) are fully documented.
*/

/*!
    \page examples-dialogs.html
    \title Dialog Examples

    \previouspage Widgets Examples
    \contentspage Qt Examples
    \nextpage Main Window Examples

    \image dialog-examples.png

    Qt includes standard dialogs for many common operations, such as file
    selection, printing, and color selection.

    Custom dialogs can also be created for specialized modal or modeless
    interactions with users.

    \list
    \o \l{dialogs/classwizard}{Class Wizard}\raisedaster
    \o \l{dialogs/configdialog}{Config Dialog}
    \o \l{dialogs/extension}{Extension}\raisedaster
    \o \l{dialogs/findfiles}{Find Files}\raisedaster
    \o \l{dialogs/licensewizard}{License Wizard}\raisedaster
    \o \l{dialogs/standarddialogs}{Standard Dialogs}
    \o \l{dialogs/tabdialog}{Tab Dialog}\raisedaster
    \o \l{dialogs/trivialwizard}{Trivial Wizard}
    \endlist

    Examples marked with an asterisk (*) are fully documented.
*/

/*!
    \page examples-mainwindow.html
    \title Main Window Examples

    \previouspage Dialog Examples
    \contentspage Qt Examples
    \nextpage Layout Examples

    \image mainwindow-examples.png

    All the standard features of application main windows are provided by Qt.

    Main windows can have pull down menus, tool bars, and dock windows. These
    separate forms of user input are unified in an integrated action system that
    also supports keyboard shortcuts and accelerator keys in menu items.

    \list
    \o \l{mainwindows/application}{Application}\raisedaster
    \o \l{mainwindows/dockwidgets}{Dock Widgets}\raisedaster
    \o \l{mainwindows/mdi}{MDI}
    \o \l{mainwindows/menus}{Menus}\raisedaster
    \o \l{mainwindows/recentfiles}{Recent Files}
    \o \l{mainwindows/sdi}{SDI}
    \endlist

    Examples marked with an asterisk (*) are fully documented.
*/

/*!
    \page examples-layouts.html