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

/****************************************************************************
**
** Copyright (C) 2011 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:FDL$
** 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 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.
**
** If you have questions regarding the use of this file, please contact
** Nokia at [email protected].
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
   \group all-examples
   \title Qt Examples

   Qt includes a set of examples that cover nearly every aspect of Qt
   development. They aren't meant to be impressive when you run them,
   but in each case the source code has been carefully written to
   illustrate one or more best Qt programming practices.

   You can run the examples from the \l{Examples and Demos Launcher}
   application (except see \l{QML Examples and Demos} {QML Examples}
   for special instructions for running those examples).

   The examples are listed below by functional area. Each example
   listed in a particular functional area is meant to illustrate how
   best to use Qt to do some particular task in that functional area,
   but the examples will often use features from other functional
   areas as well for completeness.

   If you are new to Qt, you should probably start by going through
   the \l{Tutorials}, and then begin with the
   \l{mainwindows/application} {Application} example.

   In addition to these examples and the \l{Tutorials}{tutorials}, 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.

   These examples are provided under the terms of the
   \l{New and Modified BSD Licenses}{Modified BSD License}.


   \section1 Examples by Functional Area

   \generatelist{related}
*/

/*!
    \page examples-widgets.html
    \title Widget Examples
    \ingroup all-examples
    \brief Lots of examples of how to use different kinds of widgets.

    \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
    \ingroup all-examples
    \title Dialog Examples
    \brief Using Qt's standard dialogs and building and using custom dialogs.

    \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
    \ingroup all-examples
    \title Main Window Examples
    \brief Building applications around a main window.

    \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
    \ingroup all-examples
    \title Layout Examples
    \brief Using Qt's layout-based approach to widget management.

    \image layout-examples.png

    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.

    \list
    \o \l{layouts/basiclayouts}{Basic Layouts}\raisedaster
    \o \l{layouts/borderlayout}{Border Layout}
    \o \l{layouts/dynamiclayouts}{Dynamic Layouts}
    \o \l{layouts/flowlayout}{Flow Layout}
    \endlist

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

/*!
    \page examples-itemviews.html
    \ingroup all-examples
    \title Item Views Examples
    \brief Using the model/view design pattern to separate presentation from data.

    \image itemview-examples.png

    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.

    \list
    \o \l{itemviews/addressbook}{Address Book}\raisedaster
    \o \l{itemviews/basicsortfiltermodel}{Basic Sort/Filter Model}
    \o \l{itemviews/chart}{Chart}
    \o \l{itemviews/coloreditorfactory}{Color Editor Factory}\raisedaster
    \o \l{itemviews/combowidgetmapper}{Combo Widget Mapper}\raisedaster
    \o \l{itemviews/customsortfiltermodel}{Custom Sort/Filter Model}\raisedaster
    \o \l{itemviews/dirview}{Dir View}
    \o \l{itemviews/editabletreemodel}{Editable Tree Model}\raisedaster
    \o \l{itemviews/fetchmore}{Fetch More}\raisedaster
    \o \l{itemviews/frozencolumn}{Frozen Column}\raisedaster
    \o \l{itemviews/pixelator}{Pixelator}\raisedaster
    \o \l{itemviews/puzzle}{Puzzle}
    \o \l{itemviews/simpledommodel}{Simple DOM Model}\raisedaster
    \o \l{itemviews/simpletreemodel}{Simple Tree Model}\raisedaster
    \o \l{itemviews/simplewidgetmapper}{Simple Widget Mapper}\raisedaster
    \o \l{itemviews/spinboxdelegate}{Spin Box Delegate}\raisedaster
    \o \l{itemviews/stardelegate}{Star Delegate}\raisedaster
    \endlist

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

/*!
    \page examples-graphicsview.html
    \ingroup all-examples
    \title Graphics View Examples
    \brief Using Qt to manage and interact with a large (potentially) number of graphics items.

    \image graphicsview-examples.png

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

    These examples demonstrate the fundamental aspects of canvas programming
    with Qt.