diff options
Diffstat (limited to 'doc')
340 files changed, 1274 insertions, 2124 deletions
diff --git a/doc/doc.pri b/doc/doc.pri index 9d67386..c51a621 100644 --- a/doc/doc.pri +++ b/doc/doc.pri @@ -17,6 +17,11 @@ COPYWEBKITGUIDE = $$QT_SOURCE_TREE/examples/webkit/webkit-guide COPYWEBKITTARGA = $$QT_BUILD_TREE/doc-build/html-qt COPYWEBKITTARGB = $$QT_BUILD_TREE/doc/html +EXAMPLESMANIFEST = $$QT_BUILD_TREE/doc/html/examples-manifest.xml +DEMOSMANIFEST = $$QT_BUILD_TREE/doc/html/demos-manifest.xml +EXAMPLESMANIFESTTARGET = $$QT_BUILD_TREE/examples +DEMOSMANIFESTTARGET = $$QT_BUILD_TREE/demos + $$unixstyle { QDOC = cd $$QT_SOURCE_TREE/tools/qdoc3/test && QT_BUILD_TREE=$$QT_BUILD_TREE QT_SOURCE_TREE=$$QT_SOURCE_TREE $$QT_BUILD_TREE/bin/qdoc3 $$DOCS_GENERATION_DEFINES } else { @@ -25,12 +30,18 @@ $$unixstyle { COPYWEBKITGUIDE = $$replace(COPYWEBKITGUIDE, "/", "\\") COPYWEBKITTARGA = $$replace(COPYWEBKITTARGA, "/", "\\") COPYWEBKITTARGB = $$replace(COPYWEBKITTARGB, "/", "\\") + EXAMPLESMANIFEST = $$replace(EXAMPLESMANIFEST, "/", "\\") + DEMOSMANIFEST = $$replace(DEMOSMANIFEST, "/", "\\") + EXAMPLESMANIFESTTARGET = $$replace(EXAMPLESMANIFESTTARGET, "/", "\\") + DEMOSMANIFESTTARGET = $$replace(DEMOSMANIFESTTARGET, "/", "\\") } ADP_DOCS_QDOCCONF_FILE = qt-build-docs-online.qdocconf QT_DOCUMENTATION = ($$QDOC qt-api-only.qdocconf assistant.qdocconf designer.qdocconf \ linguist.qdocconf qmake.qdocconf qdeclarative.qdocconf) && \ (cd $$QT_BUILD_TREE && \ $$QMAKE_COPY_DIR $$COPYWEBKITGUIDE $$COPYWEBKITTARGA && \ + $$QMAKE_COPY $$EXAMPLESMANIFEST $$EXAMPLESMANIFESTTARGET && \ + $$QMAKE_COPY $$DEMOSMANIFEST $$DEMOSMANIFESTTARGET && \ $$GENERATOR doc-build/html-qt/qt.qhp -o doc/qch/qt.qch && \ $$GENERATOR doc-build/html-assistant/assistant.qhp -o doc/qch/assistant.qch && \ $$GENERATOR doc-build/html-designer/designer.qhp -o doc/qch/designer.qch && \ @@ -74,6 +85,14 @@ htmldocs.files = $$QT_BUILD_TREE/doc/html htmldocs.path = $$[QT_INSTALL_DOCS] htmldocs.CONFIG += no_check_exist directory +examplesmanifest.files = $$EXAMPLESMANIFEST +examplesmanifest.path = $$[QT_INSTALL_EXAMPLES] +examplesmanifest.CONFIG += no_check_exist directory + +demosmanifest.files = $$DEMOSMANIFEST +demosmanifest.path = $$[QT_INSTALL_DEMOS] +demosmanifest.CONFIG += no_check_exist directory + qchdocs.files= $$QT_BUILD_TREE/doc/qch qchdocs.path = $$[QT_INSTALL_DOCS] qchdocs.CONFIG += no_check_exist directory @@ -85,4 +104,4 @@ sub-qdoc3.depends = sub-corelib sub-xml sub-qdoc3.commands += (cd tools/qdoc3 && $(MAKE)) QMAKE_EXTRA_TARGETS += sub-qdoc3 adp_docs qch_docs docs docs_zh_CN docs_ja_JP -INSTALLS += htmldocs qchdocs docimages +INSTALLS += htmldocs qchdocs docimages examplesmanifest demosmanifest diff --git a/doc/src/declarative/animation.qdoc b/doc/src/declarative/animation.qdoc index 4ec1503..2176db1 100644 --- a/doc/src/declarative/animation.qdoc +++ b/doc/src/declarative/animation.qdoc @@ -141,7 +141,7 @@ There are several methods of assigning behavior animations to properties. The \c{Behavior on <property>} declaration is a convenient way of assigning a behavior animation onto a property. -See the \l {declarative/animation/behaviors}{Behaviors example} for a +See the \l {declarative/animation/behaviors/behavior-example}{Behaviors example} for a demonstration of behavioral animations. \section1 Playing Animations in Parallel or in Sequence diff --git a/doc/src/declarative/declarativeui.qdoc b/doc/src/declarative/declarativeui.qdoc index cecccf6..692322c 100644 --- a/doc/src/declarative/declarativeui.qdoc +++ b/doc/src/declarative/declarativeui.qdoc @@ -82,8 +82,10 @@ Qt applications. \section1 QML Add-Ons \list +\o \l{Qt Quick Components for Symbian 1.1}{Qt Quick Components for Symbian} - a native component set for the Symbian^3 platform \o \l{QtWebKit QML Module} \o \l{http://doc.qt.nokia.com/qtmobility-1.1.0/qml-plugins.html}{Mobility QML Plugins} +\o \l {http://doc.qt.nokia.com/qt-components-symbian-1.1/index.html}{Qt Quick Components} \endlist \section1 Qt Quick Tools diff --git a/doc/src/declarative/elements.qdoc b/doc/src/declarative/elements.qdoc index 6b7a5fc..fd74ee3 100644 --- a/doc/src/declarative/elements.qdoc +++ b/doc/src/declarative/elements.qdoc @@ -185,6 +185,7 @@ should first be obtained and installed. \list \o \l{WebView}{QtWebKit QML Module - WebView Element} - For displaying Web contents \o \l{http://doc.qt.nokia.com/qtmobility-1.1.0/qml-plugins.html}{Mobility QML Plugins} +\o \l {http://doc.qt.nokia.com/qt-components-symbian-1.1/index.html}{Qt Quick Components} \endlist */ diff --git a/doc/src/declarative/examples.qdoc b/doc/src/declarative/examples.qdoc index 1003b22..303511e 100644 --- a/doc/src/declarative/examples.qdoc +++ b/doc/src/declarative/examples.qdoc @@ -116,10 +116,12 @@ The examples can be found in Qt's \c examples/declarative directory. \section2 Animation \list -\o \l{declarative/animation/basics}{Basics} -\o \l{declarative/animation/behaviors}{Behaviors} +\o \l{declarative/animation/basics/color-animation}{Color Animation} +\o \l{declarative/animation/behaviors/behavior-example}{Behaviors} \o \l{declarative/animation/easing}{Easing} +\o \l{declarative/animation/basics/property-animation}{Property Animation} \o \l{declarative/animation/states}{States} +\o \l{declarative/animation/behaviors/wigglytext}{Wiggly Text} \endlist \section2 Image Elements @@ -173,7 +175,7 @@ The examples can be found in Qt's \c examples/declarative directory. \section2 Models and Views \list \o \l{declarative/modelviews/gridview}{GridView} -\o \l{declarative/modelviews/listview}{ListView} +\o \l{Models and Views: ListView Examples}{ListView} \o \l{declarative/modelviews/pathview}{PathView} \o \l{declarative/modelviews/package}{Package} \o \l{declarative/modelviews/parallax}{Parallax} @@ -183,7 +185,7 @@ The examples can be found in Qt's \c examples/declarative directory. \o \l{declarative/modelviews/objectlistmodel}{Object ListModel} \o \l{declarative/modelviews/abstractitemmodel}{AbstractItemModel} -\o \l{declarative/modelviews/webview}{WebView} +\o \l{Models and Views: WebView Examples}{WebView} \endlist \section2 XML diff --git a/doc/src/demos/affine.qdoc b/doc/src/demos/affine.qdoc index adc1a78..912e412 100644 --- a/doc/src/demos/affine.qdoc +++ b/doc/src/demos/affine.qdoc @@ -29,7 +29,7 @@ \example demos/affine \title Affine Transformations - In this demo we show Qt's ability to perform affine transformations + \brief The Affine Transformations demo shows Qt's ability to perform affine transformations on painting operations. \image affine-demo.png diff --git a/doc/src/demos/anomaly.qdoc b/doc/src/demos/anomaly.qdoc index 9d19099..c6dfcf2 100644 --- a/doc/src/demos/anomaly.qdoc +++ b/doc/src/demos/anomaly.qdoc @@ -29,5 +29,7 @@ \example demos/embedded/anomaly \title Anomaly Demonstration + \brief The anomaly demo shows a QtWebKit browser for mobile devices. + \image anomaly-demo.png */ diff --git a/doc/src/demos/arthurplugin.qdoc b/doc/src/demos/arthurplugin.qdoc index c5daf18..3d168e3 100644 --- a/doc/src/demos/arthurplugin.qdoc +++ b/doc/src/demos/arthurplugin.qdoc @@ -29,7 +29,7 @@ \example demos/arthurplugin \title Arthur Plugin - In this demo we demonstrate the abilities of Qt's painting system + \brief The Arthur Plugin demo demonstrates the abilities of Qt's painting system in combination with \QD's custom widget plugin facilities. \image arthurplugin-demo.png diff --git a/doc/src/demos/books.qdoc b/doc/src/demos/books.qdoc index 7eccd5b..220f5eb 100644 --- a/doc/src/demos/books.qdoc +++ b/doc/src/demos/books.qdoc @@ -29,7 +29,7 @@ \example demos/books \title Books Demonstration - The Books demonstration shows how Qt's SQL classes can be used with the model/view + \brief The Books demonstration shows how Qt's SQL classes can be used with the model/view framework to create rich user interfaces for information stored in a database. \image books-demo.png diff --git a/doc/src/demos/boxes.qdoc b/doc/src/demos/boxes.qdoc index 52ee63b..ae2cbe6 100644 --- a/doc/src/demos/boxes.qdoc +++ b/doc/src/demos/boxes.qdoc @@ -29,7 +29,7 @@ \example demos/boxes \title Boxes - This demo shows Qt's ability to combine advanced OpenGL rendering with the + \brief The Boxes demo shows Qt's ability to combine advanced OpenGL rendering with the the \l{Graphics View Framework}. \image boxes-demo.png diff --git a/doc/src/demos/browser.qdoc b/doc/src/demos/browser.qdoc index 2cfc933..61b869c 100644 --- a/doc/src/demos/browser.qdoc +++ b/doc/src/demos/browser.qdoc @@ -29,7 +29,7 @@ \page demos-browser.html \title Web Browser - The Web Browser demonstration shows Qt's WebKit module in action, + \brief The Web Browser demonstration shows Qt's WebKit module in action, providing a little Web browser application. \image browser-demo.png diff --git a/doc/src/demos/chip.qdoc b/doc/src/demos/chip.qdoc index eda0bed..fd1b3c7 100644 --- a/doc/src/demos/chip.qdoc +++ b/doc/src/demos/chip.qdoc @@ -29,7 +29,7 @@ \example demos/chip \title 40000 Chips - This demo shows how to visualize a huge scene with 40000 chip items + \brief The 40000 Chips demo shows how to visualize a huge scene with 40000 chip items using Graphics View. It also shows Graphics View's powerful navigation and interaction features, allowing you to zoom and rotate each of four views independently, and you can select and move items around the scene. diff --git a/doc/src/demos/composition.qdoc b/doc/src/demos/composition.qdoc index c2eadc7..23a2815 100644 --- a/doc/src/demos/composition.qdoc +++ b/doc/src/demos/composition.qdoc @@ -29,7 +29,7 @@ \example demos/composition \title Composition Modes - This demo shows some of the more advanced composition modes supported by Qt. + \brief The Composition Modes demo shows some of the more advanced composition modes supported by Qt. \image composition-demo.png diff --git a/doc/src/demos/deform.qdoc b/doc/src/demos/deform.qdoc index 7b11a9a..aa2a1ae 100644 --- a/doc/src/demos/deform.qdoc +++ b/doc/src/demos/deform.qdoc @@ -29,7 +29,7 @@ \example demos/deform \title Vector Deformation - This demo shows how to use advanced vector techniques to draw text + \brief The Vector Deformation demo shows how to use advanced vector techniques to draw text using a \c QPainterPath. \image deform-demo.png diff --git a/doc/src/demos/desktopservices.qdoc b/doc/src/demos/desktopservices.qdoc index f1abed8..c83605d 100644 --- a/doc/src/demos/desktopservices.qdoc +++ b/doc/src/demos/desktopservices.qdoc @@ -29,5 +29,7 @@ \example demos/embedded/desktopservices \title Embedded Desktop Services Demonstration + \brief The Embedded Desktop Services demo shows the Qt Desktop Services API. + \image embeddeddesktopservices-demo.png */ diff --git a/doc/src/demos/digiflip.qdoc b/doc/src/demos/digiflip.qdoc index 33f083f..40172f2 100644 --- a/doc/src/demos/digiflip.qdoc +++ b/doc/src/demos/digiflip.qdoc @@ -27,5 +27,8 @@ /*! \example demos/embedded/digiflip + + \brief The Digiflip demo shows the Animation Framework in an embedded context. + \title Digiflip Demonstration */ diff --git a/doc/src/demos/embeddeddialogs.qdoc b/doc/src/demos/embeddeddialogs.qdoc index e80f76c..50ae6b6 100644 --- a/doc/src/demos/embeddeddialogs.qdoc +++ b/doc/src/demos/embeddeddialogs.qdoc @@ -29,7 +29,7 @@ \example demos/embeddeddialogs \title Embedded Dialogs - This example shows how to embed standard dialogs into + \brief The Embedded Dialogs demo shows how to embed standard dialogs into Graphics View. It also shows how you can customize the proxy class and add window shadows. diff --git a/doc/src/demos/embeddedsvgviewer.qdoc b/doc/src/demos/embeddedsvgviewer.qdoc index 044923a..063119f 100644 --- a/doc/src/demos/embeddedsvgviewer.qdoc +++ b/doc/src/demos/embeddedsvgviewer.qdoc @@ -29,5 +29,7 @@ \example demos/embedded/embeddedsvgviewer \title Embedded SVG Viewer Demonstration + \brief The Embedded SVG Viewer demo shows Graphics View SVG rendering in an embedded context. + \image embeddedsvgviewer-demo.png */ diff --git a/doc/src/demos/flickable.qdoc b/doc/src/demos/flickable.qdoc index 540857b..4baea5b 100644 --- a/doc/src/demos/flickable.qdoc +++ b/doc/src/demos/flickable.qdoc @@ -29,5 +29,7 @@ \example demos/embedded/flickable \title Flickable List Demonstration + \brief The Flickable List demo shows a flickable list in an embedded context. + \image flickable-demo.png */ diff --git a/doc/src/demos/flightinfo.qdoc b/doc/src/demos/flightinfo.qdoc index e812dbf..2942603 100644 --- a/doc/src/demos/flightinfo.qdoc +++ b/doc/src/demos/flightinfo.qdoc @@ -29,5 +29,7 @@ \example demos/embedded/flightinfo \title Flight Info Demonstration + \brief The Flight Info demo shows requesting data from an external server in a mbile device context. + \image flightinfo-demo.png */ diff --git a/doc/src/demos/fluidlauncher.qdoc b/doc/src/demos/fluidlauncher.qdoc index 42623e8..2fe602a 100644 --- a/doc/src/demos/fluidlauncher.qdoc +++ b/doc/src/demos/fluidlauncher.qdoc @@ -29,5 +29,7 @@ \example demos/embedded/fluidlauncher \title Fluid Launcher Demonstration + \brief The Fluid Launcher demo demonstrates an application launcher for mobile devices + \image fluidlauncher-demo.png */ diff --git a/doc/src/demos/glhypnotizer.qdoc b/doc/src/demos/glhypnotizer.qdoc index 468a4ac..0782e90 100644 --- a/doc/src/demos/glhypnotizer.qdoc +++ b/doc/src/demos/glhypnotizer.qdoc @@ -29,7 +29,7 @@ \example demos/glhypnotizer \title GL Hypnotizer - This demo shows how to use OpenGL from a seperate thread. + \brief The GL Hypnotizer demo shows how to use OpenGL from a seperate thread. \image glhypnotizer-demo.png diff --git a/doc/src/demos/gradients.qdoc b/doc/src/demos/gradients.qdoc index 1f29a4a..5c400a1 100644 --- a/doc/src/demos/gradients.qdoc +++ b/doc/src/demos/gradients.qdoc @@ -29,7 +29,7 @@ \example demos/gradients \title Gradients - In this demo we show the various types of gradients that can + \brief The Gradients demo shows the various types of gradients that can be used in Qt. \image gradients-demo.png diff --git a/doc/src/demos/guitartuner.qdoc b/doc/src/demos/guitartuner.qdoc index df15c04..8a1e875 100644 --- a/doc/src/demos/guitartuner.qdoc +++ b/doc/src/demos/guitartuner.qdoc @@ -27,16 +27,19 @@ /*! \page guitartuner_example.html - \title Guitar Tuner Example + \title Guitar Tuner Demonstration \example demos/mobile/guitartuner +\brief The Guitar Tuner demo demonstrates the audio-in and audio-out interfaces of +Qt Mobility Multimedia, and integrating Qt code in a Qt Quick UI. + The Guitar Tuner application can be used to tune guitar strings by analyzing the audio recorded by the device microphone. Guitar Tuner can be also used in the listening mode. It will then play the audio by the corresponding frequency, and the user can tune the guitar by ear. The application demonstrates the audio-in and the audio-out interfaces of \l{external: Mobility Multimedia}{Qt Mobility Multimedia} and integrating Qt -code to the Qt Quick UI. +code in a Qt Quick UI. The example is hosted in Projects Forum Nokia: https://projects.forum.nokia.com/guitartuner diff --git a/doc/src/demos/interview.qdoc b/doc/src/demos/interview.qdoc index fa40ed2..7050cc3 100644 --- a/doc/src/demos/interview.qdoc +++ b/doc/src/demos/interview.qdoc @@ -29,7 +29,7 @@ \example demos/interview \title Interview - The Interview demonstration explores the flexibility and scalability of the + \brief The Interview demonstration explores the flexibility and scalability of the model/view framework by presenting an infinitely deep data structure using a model and three different types of view. diff --git a/doc/src/demos/lightmaps.qdoc b/doc/src/demos/lightmaps.qdoc index a8594f9..11eb3c3 100644 --- a/doc/src/demos/lightmaps.qdoc +++ b/doc/src/demos/lightmaps.qdoc @@ -29,5 +29,7 @@ \example demos/embedded/lightmaps \title Light Maps Demonstration + \brief The Light Maps demo shows graphics effects in an embedded context. + \image lightmaps-demo.png */ diff --git a/doc/src/demos/macmainwindow.qdoc b/doc/src/demos/macmainwindow.qdoc index 31c0230..aaed304 100644 --- a/doc/src/demos/macmainwindow.qdoc +++ b/doc/src/demos/macmainwindow.qdoc @@ -29,7 +29,7 @@ \example demos/macmainwindow \title Mac Main Window Demo - This demo shows how to create a main window that has the + \brief The Mac Main Window demo shows how to create a main window that has the same appearance as other Mac OS X applications such as Mail or iTunes. This includes customizing the item views and QSplitter and wrapping native widgets such as the search field. diff --git a/doc/src/demos/mainwindow.qdoc b/doc/src/demos/mainwindow.qdoc index dee7202..0bd084f 100644 --- a/doc/src/demos/mainwindow.qdoc +++ b/doc/src/demos/mainwindow.qdoc @@ -29,7 +29,7 @@ \example demos/mainwindow \title Main Window - The Main Window demonstration shows Qt's extensive support for tool bars, + \brief The Main Window demonstration shows Qt's extensive support for tool bars, dock windows, menus, and other standard application features. \image mainwindow-demo.png diff --git a/doc/src/demos/mediaplayer.qdoc b/doc/src/demos/mediaplayer.qdoc index 8f35ee5..227b346 100644 --- a/doc/src/demos/mediaplayer.qdoc +++ b/doc/src/demos/mediaplayer.qdoc @@ -29,7 +29,7 @@ \example demos/qmediaplayer \title Media Player - The Media Player demonstration shows how \l{Phonon Module}{Phonon} + \brief The Media Player demonstration shows how \l{Phonon Module}{Phonon} can be used in Qt applications to handle audio and video playback. \image qmediaplayer-demo.png diff --git a/doc/src/demos/mobiledemos.qdoc b/doc/src/demos/mobiledemos.qdoc index 2aaa258..6af10f6 100644 --- a/doc/src/demos/mobiledemos.qdoc +++ b/doc/src/demos/mobiledemos.qdoc @@ -30,8 +30,10 @@ \example demos/mobile/quickhit \title Quick Hit Demo - This demo shows how to use Mobility APIs to access device audio - capabilities. Uses the multimedia and systeminfo modules of + \brief The Quick Hit demo shows how to use Mobility APIs to access device audio + capabilities. + + The demo uses the multimedia and systeminfo modules of \l{external: Qt Mobility Manual}{Qt Mobility}. \note This demonstration requires QtMobility libraries. diff --git a/doc/src/demos/pathstroke.qdoc b/doc/src/demos/pathstroke.qdoc index 8e864e2..97ee8ab 100644 --- a/doc/src/demos/pathstroke.qdoc +++ b/doc/src/demos/pathstroke.qdoc @@ -29,7 +29,7 @@ \example demos/pathstroke \title Path Stroking - In this demo we show some of the various types of pens that can be + \brief This Path Stroking demo shows some of the various types of pens that can be used in Qt. \image pathstroke-demo.png diff --git a/doc/src/demos/qcamera.qdoc b/doc/src/demos/qcamera.qdoc index f41afd7..be3f667 100644 --- a/doc/src/demos/qcamera.qdoc +++ b/doc/src/demos/qcamera.qdoc @@ -27,10 +27,10 @@ /*! \page qcamera_example.html - \title QCamera Example + \title QCamera Demo \example demos/mobile/qcamera - This Qt C++ application demonstrates how to use Multimedia, Messaging and Contacts modules from \l{external: Qt Mobility Manual}{Qt Mobility}. + \brief The QCamera demo shows how to use Multimedia, Messaging and Contacts modules from Qt Mobility. \image qcameraexample.png diff --git a/doc/src/demos/qml-qtbubblelevel.qdoc b/doc/src/demos/qml-qtbubblelevel.qdoc index 052dd50..146f604 100644 --- a/doc/src/demos/qml-qtbubblelevel.qdoc +++ b/doc/src/demos/qml-qtbubblelevel.qdoc @@ -27,13 +27,15 @@ /*! \page qtbubblelevel_example.html - \title Qt Bubble Level Example + \title Qt Bubble Level Demo \example demos/mobile/qtbubblelevel -Qt Bubble Level is a simple application that uses -\l{external: Qt Mobility Manual}{Qt Mobility's} accelerometer APIs and hardware +\brief Qt Bubble Level is a simple application that uses +Qt Mobility's accelerometer APIs and hardware sensor information to calculate the inclination of the device and presents this -as atraditional bubble level. The application provides a calibration feature to +as atraditional bubble level. + +The application provides a calibration feature to handle any possible errors in accelerometer readings. The example is hosted in Projects Forum Nokia: https://projects.forum.nokia.com/qtbubblelevel diff --git a/doc/src/demos/qtdemo.qdoc b/doc/src/demos/qtdemo.qdoc index f4d3cbf..9ecb824 100644 --- a/doc/src/demos/qtdemo.qdoc +++ b/doc/src/demos/qtdemo.qdoc @@ -31,7 +31,7 @@ \ingroup qttools \keyword qtdemo - The Examples and Demos Launcher (\c qtdemo) allows the user to browse the + \brief The Examples and Demos Launcher (\c qtdemo) allows the user to browse the examples and demonstrations included with Qt, access the documentation associated with each of them, and launch them as separate applications. diff --git a/doc/src/demos/raycasting.qdoc b/doc/src/demos/raycasting.qdoc index 5c03e20..6517e97 100644 --- a/doc/src/demos/raycasting.qdoc +++ b/doc/src/demos/raycasting.qdoc @@ -29,5 +29,7 @@ \example demos/embedded/raycasting \title Ray Casting Demonstration + \brief The Ray Casting demo shows how to use ray casting to build a mid-1990s style first-person game. + \image raycasting-demo.png */ diff --git a/doc/src/demos/spectrum.qdoc b/doc/src/demos/spectrum.qdoc index 7e98426..64eab09 100644 --- a/doc/src/demos/spectrum.qdoc +++ b/doc/src/demos/spectrum.qdoc @@ -29,7 +29,7 @@ \example demos/spectrum \title Spectrum Analyzer - The Spectrum Analyzer demo shows how the \l{QtMultimedia Module} can be + \brief The Spectrum Analyzer demo shows how the \l{QtMultimedia Module} can be used in Qt applications to capture and then play back an audio stream. \image spectrum-demo.png diff --git a/doc/src/demos/spreadsheet.qdoc b/doc/src/demos/spreadsheet.qdoc index 5c6b4df..3b74d8e 100644 --- a/doc/src/demos/spreadsheet.qdoc +++ b/doc/src/demos/spreadsheet.qdoc @@ -29,7 +29,7 @@ \example demos/spreadsheet \title Spreadsheet - The Spreadsheet demonstration shows how a table view can be used to create a + \brief The Spreadsheet demonstration shows how a table view can be used to create a simple spreadsheet application. Custom delegates are used to render different types of data in distinctive colors. diff --git a/doc/src/demos/sqlbrowser.qdoc b/doc/src/demos/sqlbrowser.qdoc index 53af037..b87d86f 100644 --- a/doc/src/demos/sqlbrowser.qdoc +++ b/doc/src/demos/sqlbrowser.qdoc @@ -29,7 +29,7 @@ \example demos/sqlbrowser \title SQL Browser - The SQL Browser demonstration shows how a data browser can be used to visualize + \brief The SQL Browser demonstration shows how a data browser can be used to visualize the results of SQL statements on a live database. \image sqlbrowser-demo.png diff --git a/doc/src/demos/styledemo.qdoc b/doc/src/demos/styledemo.qdoc index 415d284..d05d091 100644 --- a/doc/src/demos/styledemo.qdoc +++ b/doc/src/demos/styledemo.qdoc @@ -29,5 +29,7 @@ \example demos/embedded/styledemo \title Embedded Styles Demonstration + \brief The Embedded Styles demo shows how to use Qt Style APIs in embedded contexts + \image styledemo-demo.png */ diff --git a/doc/src/demos/sub-attaq.qdoc b/doc/src/demos/sub-attaq.qdoc index 247d0d1..2874473 100644 --- a/doc/src/demos/sub-attaq.qdoc +++ b/doc/src/demos/sub-attaq.qdoc @@ -29,7 +29,7 @@ \example demos/sub-attaq \title Sub-Attaq - This demo shows Qt's ability to combine \l{The Animation Framework}{the animation framework} + \brief The Sub-Attaq demo shows Qt's ability to combine \l{The Animation Framework}{the animation framework} and \l{The State Machine Framework}{the state machine framework} to create a game. \image sub-attaq-demo.png diff --git a/doc/src/demos/textedit.qdoc b/doc/src/demos/textedit.qdoc index 8c50dba..f068593 100644 --- a/doc/src/demos/textedit.qdoc +++ b/doc/src/demos/textedit.qdoc @@ -29,7 +29,7 @@ \example demos/textedit \title Text Edit - The Text Edit demonstration shows Qt's rich text editing facilities in action, + \brief The Text Edit demonstration shows Qt's rich text editing facilities in action, providing an example document for you to experiment with. \image textedit-demo.png diff --git a/doc/src/demos/undo.qdoc b/doc/src/demos/undo.qdoc index 7b64371..78804c0 100644 --- a/doc/src/demos/undo.qdoc +++ b/doc/src/demos/undo.qdoc @@ -29,7 +29,7 @@ \example demos/undo \title Undo Framework - This demo shows Qt's undo framework in action. + \brief This demo shows Qt's undo framework in action. \image undodemo.png diff --git a/doc/src/demos/weatherinfo.qdoc b/doc/src/demos/weatherinfo.qdoc index 1f8a3e8..21b8fc8 100644 --- a/doc/src/demos/weatherinfo.qdoc +++ b/doc/src/demos/weatherinfo.qdoc @@ -29,5 +29,7 @@ \example demos/embedded/weatherinfo \title Weather Info Demonstration + \brief The Weather Info demo shows how to use XML files to build an embedded UI. + \image weatherinfo-demo.png */ diff --git a/doc/src/development/designer-manual.qdoc b/doc/src/development/designer-manual.qdoc index 348931f..f979547 100644 --- a/doc/src/development/designer-manual.qdoc +++ b/doc/src/development/designer-manual.qdoc @@ -694,8 +694,10 @@ the object's name with the in-place editor. Since Qt 4.5, the \gui{Object Inspector} displays the layout state of - the containers. The broken layout icon ###ICON is displayed if there is - something wrong with the layouts. + the containers. The broken layout icon \inlineimage editbreaklayout.png + is displayed if there is something wrong (e.g. layout missing from the + container) with the layouts. + \endtable */ diff --git a/doc/src/development/developing-with-qt.qdoc b/doc/src/development/developing-with-qt.qdoc index 59aae83..2f56151 100644 --- a/doc/src/development/developing-with-qt.qdoc +++ b/doc/src/development/developing-with-qt.qdoc @@ -75,39 +75,37 @@ \table \row - \o - \list \o \l {Calling Qt Functions From Unix Signal Handlers} - \o \l {Compiler Notes} + \o Workaround for using Unix signal handlers. + \row \o \l {Developing Qt Applications for Mac OS X} - \o \l {Known Issues} - \o \l {Platform and Compiler Notes} - \o \l {Platform and Compiler Notes - Symbian} - \o \l {ActiveX in Qt} - \o \l {Qt for Embedded Linux Classes} - \o \l {Qt for Embedded Platforms} - \o \l {Qt for Mac OS X - Specific Issues} - \o \l {Qt is Mac OS X Native} - \o \l {Supported Platforms} - \o \l {The qtmain Library} - \o \l {Window System Specific Notes} - \endlist - \o - \list - \o Workaround to make it work. - \o Information about the C++ compilers and tools used to build Qt. \o Information for developing Qt applications for Mac OS X + \row + \o \l {Known Issues} \o A summary of known issues in this Qt version at the time of release. - \o Information about the platforms on which Qt can be used. - \o Information about the state of support for the Symbian platform. + \row + \o \l {ActiveX in Qt} \o Qt API's for using ActiveX controls, servers, and COM. + \row + \o \l {Qt for Embedded Linux Classes} \o Classes that are specific to Qt for Embedded Linux. + \row + \o \l {Qt for Embedded Platforms} \o Documents related to Qt for Embedded Platforms. + \row + \o \l {Qt for Mac OS X - Specific Issues} \o A description of issues with Qt that are specific to Mac OS X. + \row + \o \l {Qt is Mac OS X Native} \o An explanation of Qt's native features on Mac OS X. + \row + \o \l {Supported Platforms} \o The platforms supported by Nokia for Qt. + \row + \o \l {The qtmain Library} \o Describes the use and license of the qtmain helper library. + \row + \o \l {Window System Specific Notes} \o Collections of notes about Qt implementations on different window systems. - \endlist \endtable */ diff --git a/doc/src/development/qmake-manual.qdoc b/doc/src/development/qmake-manual.qdoc index 0f85469..eabf2b9 100644 --- a/doc/src/development/qmake-manual.qdoc +++ b/doc/src/development/qmake-manual.qdoc @@ -438,7 +438,10 @@ Note, that you must use "+=", not "=", or \l{qmake Manual#qmake}{\c qmake} will not be able to use Qt's configuration to determine the settings - needed for your project. + needed for your project. More information about operators can be found in the + \l{qmake Advanced Usage#Operators} + {Operators} section of the \l{qmake Advanced Usage} + chapter. \section1 Declaring Qt Libraries @@ -464,6 +467,11 @@ \snippet doc/src/snippets/code/doc_src_qmake-manual.pro 4 + More information about operators can be found in the + \l{qmake Advanced Usage#Operators} + {Operators} section of the \l{qmake Advanced Usage} + chapter. + The table below shows the options that can be used with the \c QT variable and the features that are associated with each of them: diff --git a/doc/src/examples/2dpainting.qdoc b/doc/src/examples/2dpainting.qdoc index c4a2695..bce9958 100644 --- a/doc/src/examples/2dpainting.qdoc +++ b/doc/src/examples/2dpainting.qdoc @@ -29,7 +29,7 @@ \example opengl/2dpainting \title 2D Painting Example - The 2D Painting example shows how QPainter and QGLWidget can be used + \brief The 2D Painting example shows how QPainter and QGLWidget can be used together to display accelerated 2D graphics on supported hardware. \image 2dpainting-example.png diff --git a/doc/src/examples/activeqt/comapp.qdoc b/doc/src/examples/activeqt/comapp.qdoc index 22cec65..3c74b60 100644 --- a/doc/src/examples/activeqt/comapp.qdoc +++ b/doc/src/examples/activeqt/comapp.qdoc @@ -29,10 +29,12 @@ \example activeqt/comapp \title COM App Example (ActiveQt) - The COM App example shows how to use ActiveQt to develop a Qt - application that can be automated via COM. Different QObject - based classes are exposed as COM objects that communicate with the - GUI of the running Qt application. The APIs of those COM objects + \brief The COM App example shows how to use ActiveQt to develop a Qt + application that can be automated via COM. + + Different QObject based classes are exposed as COM objects that + communicate with the GUI of the running Qt application. + The APIs of those COM objects has been designed to resemble the APIs of standard COM applications; i.e. those from Microsoft Office. diff --git a/doc/src/examples/activeqt/dotnet.qdoc b/doc/src/examples/activeqt/dotnet.qdoc index 24b9cd1..31ca490 100644 --- a/doc/src/examples/activeqt/dotnet.qdoc +++ b/doc/src/examples/activeqt/dotnet.qdoc @@ -29,7 +29,7 @@ \page activeqt-dotnet.html \title Dot Net Example (ActiveQt) - The Dot Net example demonstrates how Qt objects can be used in a + \brief The Dot Net example demonstrates how Qt objects can be used in a .NET environment, and how .NET objects can be used in a Qt environment. diff --git a/doc/src/examples/activeqt/hierarchy.qdoc b/doc/src/examples/activeqt/hierarchy.qdoc index 50fb025..e4fa60f 100644 --- a/doc/src/examples/activeqt/hierarchy.qdoc +++ b/doc/src/examples/activeqt/hierarchy.qdoc @@ -36,7 +36,7 @@ \example activeqt/hierarchy \title Hierarchy Example (ActiveQt) - The Hierarchy example is shows how to write an in-process ActiveX + \brief The Hierarchy example is shows how to write an in-process ActiveX control. The control is a QWidget subclass with child widgets that are accessible as sub-types. diff --git a/doc/src/examples/activeqt/multiple.qdoc b/doc/src/examples/activeqt/multiple.qdoc index 96bb6f5..fb069a9 100644 --- a/doc/src/examples/activeqt/multiple.qdoc +++ b/doc/src/examples/activeqt/multiple.qdoc @@ -36,9 +36,10 @@ \example activeqt/multiple \title Multiple Example (ActiveQt) - The Multiple example demonstrates the implementation of a + \brief The Multiple example demonstrates the implementation of a QAxFactory to provide multiple ActiveX controls in a single in process ActiveX server using the \c QAXFACTORY_EXPORT() macro. + The ActiveX controls in this example are simple QWidget subclasses that reimplement QWidget::paintEvent(). diff --git a/doc/src/examples/activeqt/qutlook.qdoc b/doc/src/examples/activeqt/qutlook.qdoc index fe77fd5..82e3424 100644 --- a/doc/src/examples/activeqt/qutlook.qdoc +++ b/doc/src/examples/activeqt/qutlook.qdoc @@ -29,7 +29,7 @@ \example activeqt/qutlook \title Qutlook Example (ActiveQt) - The Qutlook example demonstrates the use of ActiveQt to automate + \brief The Qutlook example demonstrates the use of ActiveQt to automate Outlook. The example makes use of the \l dumpcpp tool to generate a C++ namespace for the type library describing the Outlook Object Model. diff --git a/doc/src/examples/activeqt/webbrowser.qdoc b/doc/src/examples/activeqt/webbrowser.qdoc index 7eca270..35e4524 100644 --- a/doc/src/examples/activeqt/webbrowser.qdoc +++ b/doc/src/examples/activeqt/webbrowser.qdoc @@ -29,7 +29,7 @@ \example activeqt/webbrowser \title Web Browser Example (ActiveQt) - The Web Browser example uses the Microsoft Web Browser + \brief The Web Browser example uses the Microsoft Web Browser ActiveX control to implement a fully functional Web Browser application. The user interface has been developed using the Qt Designer integration of the QAxWidget class. diff --git a/doc/src/examples/activeqt/wrapper.qdoc b/doc/src/examples/activeqt/wrapper.qdoc index caecae9..8c7755e 100644 --- a/doc/src/examples/activeqt/wrapper.qdoc +++ b/doc/src/examples/activeqt/wrapper.qdoc @@ -37,9 +37,11 @@ \example activeqt/wrapper \title Wrapper Example (ActiveQt) - The Wrapper example demonstrates how to export existing QWidget + \brief The Wrapper example demonstrates how to export existing QWidget classes as ActiveX controls, and the use of QAxFactory together - with the \c QAXFACTORY_EXPORT() macro. ActiveX controls in this + with the \c QAXFACTORY_EXPORT() macro. + + ActiveX controls in this example are the standard button classes QPushButton, QCheckBox and QRadioButton as provided by Qt. diff --git a/doc/src/examples/analogclock.qdoc b/doc/src/examples/analogclock.qdoc index 18dc479..3b12ebe 100644 --- a/doc/src/examples/analogclock.qdoc +++ b/doc/src/examples/analogclock.qdoc @@ -29,7 +29,7 @@ \example widgets/analogclock \title Analog Clock Example - The Analog Clock example shows how to draw the contents of a custom + \brief The Analog Clock example shows how to draw the contents of a custom widget. \image analogclock-example.png Screenshot of the Analog Clock example diff --git a/doc/src/examples/animatedtiles.qdoc b/doc/src/examples/animatedtiles.qdoc index f562829..8155c4a 100644 --- a/doc/src/examples/animatedtiles.qdoc +++ b/doc/src/examples/animatedtiles.qdoc @@ -29,7 +29,7 @@ \example animation/animatedtiles \title Animated Tiles Example - The Animated Tiles example animates items in a graphics scene. + \brief The Animated Tiles example animates items in a graphics scene. \image animatedtiles-example.png */ diff --git a/doc/src/examples/appchooser.qdoc b/doc/src/examples/appchooser.qdoc index 63cbb0e..64c5144 100644 --- a/doc/src/examples/appchooser.qdoc +++ b/doc/src/examples/appchooser.qdoc @@ -29,7 +29,7 @@ \example animation/appchooser \title Application Chooser Example - The Application Chooser example shows how to use the Qt state + \brief The Application Chooser example shows how to use the Qt state machine and the animation framework to select between applications. diff --git a/doc/src/examples/application.qdoc b/doc/src/examples/application.qdoc index 9e03bc4..5f7b9fe 100644 --- a/doc/src/examples/application.qdoc +++ b/doc/src/examples/application.qdoc @@ -29,7 +29,7 @@ \example mainwindows/application \title Application Example - The Application example shows how to implement a standard GUI + \brief The Application example shows how to implement a standard GUI application with menus, toolbars, and a status bar. The example itself is a simple text editor program built around QPlainTextEdit. diff --git a/doc/src/examples/applicationicon.qdoc b/doc/src/examples/applicationicon.qdoc index 87942e5..f3f222e 100644 --- a/doc/src/examples/applicationicon.qdoc +++ b/doc/src/examples/applicationicon.qdoc @@ -29,7 +29,8 @@ \group all-examples \title Application Icon Example - The example shows how to add an application icon to a mobile application. + \brief The Application Icon example shows how to add an application icon to a + mobile application. \image appicon_screenshot.png The icon on a Nokia XPressMusic 5800 diff --git a/doc/src/examples/arrowpad.qdoc b/doc/src/examples/arrowpad.qdoc index f3ba332..ef0bd27 100644 --- a/doc/src/examples/arrowpad.qdoc +++ b/doc/src/examples/arrowpad.qdoc @@ -29,7 +29,7 @@ \example linguist/arrowpad \title Arrow Pad Example - This example is a slightly more involved and introduces a key \e + \brief ThArrow Pad Linguist example is a slightly more involved and introduces a key \e {Qt Linguist} concept: "contexts". It also shows how to use two or more languages. diff --git a/doc/src/examples/audiodevices.qdoc b/doc/src/examples/audiodevices.qdoc index 7c95678..1690f34 100644 --- a/doc/src/examples/audiodevices.qdoc +++ b/doc/src/examples/audiodevices.qdoc @@ -29,7 +29,7 @@ \example multimedia/audiodevices \title Audio Devices Example - The Audio Devices example demonstrates the basic use of QAudioDeviceInfo class + \brief The Audio Devices example demonstrates the basic use of QAudioDeviceInfo class provided with Qt. \image audiodevices-example.png diff --git a/doc/src/examples/audioinput.qdoc b/doc/src/examples/audioinput.qdoc index 1b6d461..d5af63f 100644 --- a/doc/src/examples/audioinput.qdoc +++ b/doc/src/examples/audioinput.qdoc @@ -29,7 +29,7 @@ \example multimedia/audioinput \title AudioInput Example - The Audio Input example demonstrates the basic use of QAudioInput class + \brief The Audio Input example demonstrates the basic use of QAudioInput class provided with Qt. \image audioinput-example.png diff --git a/doc/src/examples/audiooutput.qdoc b/doc/src/examples/audiooutput.qdoc index 47a09fa..9362029 100644 --- a/doc/src/examples/audiooutput.qdoc +++ b/doc/src/examples/audiooutput.qdoc @@ -29,7 +29,7 @@ \example multimedia/audiooutput \title Audio Output Example - The Audio Output example demonstrates the basic use of the QAudioOutput class + \brief The Audio Output example demonstrates the basic use of the QAudioOutput class provided with Qt. \image audiooutput-example.png diff --git a/doc/src/examples/basicdrawing.qdoc b/doc/src/examples/basicdrawing.qdoc index fbc34e6..f18907c 100644 --- a/doc/src/examples/basicdrawing.qdoc +++ b/doc/src/examples/basicdrawing.qdoc @@ -29,7 +29,7 @@ \example painting/basicdrawing \title Basic Drawing Example - The Basic Drawing example shows how to display basic graphics + \brief The Basic Drawing example shows how to display basic graphics primitives in a variety of styles using the QPainter class. QPainter performs low-level painting on widgets and other paint diff --git a/doc/src/examples/basicgraphicslayouts.qdoc b/doc/src/examples/basicgraphicslayouts.qdoc index 2742870..27c9cb6 100644 --- a/doc/src/examples/basicgraphicslayouts.qdoc +++ b/doc/src/examples/basicgraphicslayouts.qdoc @@ -29,7 +29,7 @@ \example graphicsview/basicgraphicslayouts \title Basic Graphics Layouts Example - The Basic Graphics Layouts example shows how to use the layout classes + \brief The Basic Graphics Layouts example shows how to use the layout classes in QGraphicsView: QGraphicsLinearLayout and QGraphicsGridLayout. In addition to that it shows how to write your own custom layout item. @@ -161,4 +161,4 @@ \snippet examples/graphicsview/basicgraphicslayouts/layoutitem.cpp 5 -*/
\ No newline at end of file +*/ diff --git a/doc/src/examples/basiclayouts.qdoc b/doc/src/examples/basiclayouts.qdoc index a8c64f0..ade0b08 100644 --- a/doc/src/examples/basiclayouts.qdoc +++ b/doc/src/examples/basiclayouts.qdoc @@ -29,7 +29,7 @@ \example layouts/basiclayouts \title Basic Layouts Example - The Basic Layouts example shows how to use the standard layout + \brief The Basic Layouts example shows how to use the standard layout managers that are available in Qt: QBoxLayout, QGridLayout and QFormLayout. diff --git a/doc/src/examples/basicsortfiltermodel.qdoc b/doc/src/examples/basicsortfiltermodel.qdoc index dbe9f02..92c000e 100644 --- a/doc/src/examples/basicsortfiltermodel.qdoc +++ b/doc/src/examples/basicsortfiltermodel.qdoc @@ -29,7 +29,7 @@ \example itemviews/basicsortfiltermodel \title Basic Sort/Filter Model Example - The Basic Sort/Filter Model example illustrates how to use + \brief The Basic Sort/Filter Model example illustrates how to use QSortFilterProxyModel to perform basic sorting and filtering. \image basicsortfiltermodel-example.png Screenshot of the Basic Sort/Filter Model Example diff --git a/doc/src/examples/bearercloud.qdoc b/doc/src/examples/bearercloud.qdoc index 18a4ddf..f549eb4 100644 --- a/doc/src/examples/bearercloud.qdoc +++ b/doc/src/examples/bearercloud.qdoc @@ -29,7 +29,7 @@ \example network/bearercloud \title Bearer Cloud Example - The Bearer Cloud example shows how to use the Bearer Management API to monitor the + \brief The Bearer Cloud example shows how to use the Bearer Management API to monitor the connectivity state of the local device. \image bearercloud-example.png Screenshot of the Bearer Cloud example diff --git a/doc/src/examples/bearermonitor.qdoc b/doc/src/examples/bearermonitor.qdoc index a638d12..ec5d091 100644 --- a/doc/src/examples/bearermonitor.qdoc +++ b/doc/src/examples/bearermonitor.qdoc @@ -29,7 +29,7 @@ \example network/bearermonitor \title Bearer Monitor Example - The Bearer Monitor example shows how to use the Bearer Management API. + \brief The Bearer Monitor example shows how to use the Bearer Management API. \image bearermonitor-example.png Screenshot of the Bearer Monitor example */ diff --git a/doc/src/examples/blockingfortuneclient.qdoc b/doc/src/examples/blockingfortuneclient.qdoc index d35ed4c..5549ebb 100644 --- a/doc/src/examples/blockingfortuneclient.qdoc +++ b/doc/src/examples/blockingfortuneclient.qdoc @@ -29,7 +29,7 @@ \example network/blockingfortuneclient \title Blocking Fortune Client Example - The Blocking Fortune Client example shows how to create a client for a + \brief The Blocking Fortune Client example shows how to create a client for a network service using QTcpSocket's synchronous API in a non-GUI thread. \image blockingfortuneclient-example.png diff --git a/doc/src/examples/blurpicker.qdoc b/doc/src/examples/blurpicker.qdoc index 3a6d433..00c822d 100644 --- a/doc/src/examples/blurpicker.qdoc +++ b/doc/src/examples/blurpicker.qdoc @@ -29,5 +29,7 @@ \example effects/blurpicker \title Blur Picker Effect Example + \brief The Blur Picker Example shows the QGraphicsBlurEffect in action. + \image blurpickereffect-example.png */ diff --git a/doc/src/examples/borderlayout.qdoc b/doc/src/examples/borderlayout.qdoc index 94cd3d9..cf8a4fc 100644 --- a/doc/src/examples/borderlayout.qdoc +++ b/doc/src/examples/borderlayout.qdoc @@ -29,7 +29,7 @@ \example layouts/borderlayout \title Border Layout Example - The Border Layout example shows how to create a custom layout that arranges + \brief The Border Layout example shows how to create a custom layout that arranges child widgets according to a simple set of rules. \image borderlayout-example.png diff --git a/doc/src/examples/broadcastreceiver.qdoc b/doc/src/examples/broadcastreceiver.qdoc index 409b491..e716a74 100644 --- a/doc/src/examples/broadcastreceiver.qdoc +++ b/doc/src/examples/broadcastreceiver.qdoc @@ -29,7 +29,7 @@ \example network/broadcastreceiver \title Broadcast Receiver Example - The Broadcast Receiver example shows how to receive information that is broadcasted + \brief The Broadcast Receiver example shows how to receive information that is broadcasted over a local network. \image broadcastreceiver-example.png diff --git a/doc/src/examples/broadcastsender.qdoc b/doc/src/examples/broadcastsender.qdoc index 2cb0a13..a272e88 100644 --- a/doc/src/examples/broadcastsender.qdoc +++ b/doc/src/examples/broadcastsender.qdoc @@ -29,7 +29,7 @@ \example network/broadcastsender \title Broadcast Sender Example - The Broadcast Sender example shows how to broadcast information to multiple clients + \brief The Broadcast Sender example shows how to broadcast information to multiple clients on a local network. \image broadcastsender-example.png diff --git a/doc/src/examples/cachedtable.qdoc b/doc/src/examples/cachedtable.qdoc index 5a20329..7660dbf 100644 --- a/doc/src/examples/cachedtable.qdoc +++ b/doc/src/examples/cachedtable.qdoc @@ -29,7 +29,7 @@ \example sql/cachedtable \title Cached Table Example - The Cached Table example shows how a table view can be used to access a database, + \brief The Cached Table example shows how a table view can be used to access a database, caching any changes to the data until the user explicitly submits them using a push button. diff --git a/doc/src/examples/calculator.qdoc b/doc/src/examples/calculator.qdoc index c7dc013..7941698 100644 --- a/doc/src/examples/calculator.qdoc +++ b/doc/src/examples/calculator.qdoc @@ -29,7 +29,7 @@ \example widgets/calculator \title Calculator Example - The example shows how to use signals and slots to implement the + \brief The example shows how to use signals and slots to implement the functionality of a calculator widget, and how to use QGridLayout to place child widgets in a grid. diff --git a/doc/src/examples/calculatorbuilder.qdoc b/doc/src/examples/calculatorbuilder.qdoc index ac9db9f..97f6f06 100644 --- a/doc/src/examples/calculatorbuilder.qdoc +++ b/doc/src/examples/calculatorbuilder.qdoc @@ -29,7 +29,7 @@ \example designer/calculatorbuilder \title Calculator Builder Example - The Calculator Builder example shows how to create a user interface from + \brief The Calculator Builder example shows how to create a user interface from a \QD form at run-time, using the QUiLoader class. \image calculatorbuilder-example.png diff --git a/doc/src/examples/calculatorform.qdoc b/doc/src/examples/calculatorform.qdoc index e1025b6..945659f 100644 --- a/doc/src/examples/calculatorform.qdoc +++ b/doc/src/examples/calculatorform.qdoc @@ -29,9 +29,11 @@ \example designer/calculatorform \title Calculator Form Example - The Calculator Form Example shows how to use a form created with + \brief The Calculator Form Example shows how to use a form created with \QD in an application by using the user interface information from - a QWidget subclass. We use \l{Using a Designer UI File in Your Application} + a QWidget subclass. + + We use \l{Using a Designer UI File in Your Application} {uic's auto-connection} feature to automatically connect signals from widgets on the form to slots in our code. diff --git a/doc/src/examples/calendar.qdoc b/doc/src/examples/calendar.qdoc index 32bc547..2221e1f 100644 --- a/doc/src/examples/calendar.qdoc +++ b/doc/src/examples/calendar.qdoc @@ -29,7 +29,7 @@ \example richtext/calendar \title Calendar Example - The Calendar example shows how to create rich text content and display it using + \brief The Calendar example shows how to create rich text content and display it using a rich text editor. \image calendar-example.png diff --git a/doc/src/examples/calendarwidget.qdoc b/doc/src/examples/calendarwidget.qdoc index f72082a..ed3cd32 100644 --- a/doc/src/examples/calendarwidget.qdoc +++ b/doc/src/examples/calendarwidget.qdoc @@ -29,7 +29,7 @@ \title Calendar Widget Example \example widgets/calendarwidget - The Calendar Widget example shows use of \c QCalendarWidget. + \brief The Calendar Widget example shows use of \c QCalendarWidget. \image calendarwidgetexample.png diff --git a/doc/src/examples/capabilitiesexample.qdoc b/doc/src/examples/capabilitiesexample.qdoc index 636044b..c0c4f93 100644 --- a/doc/src/examples/capabilitiesexample.qdoc +++ b/doc/src/examples/capabilitiesexample.qdoc @@ -29,7 +29,7 @@ \example phonon/capabilities \title Capabilities Example - The Backend Capabilities example shows how to check which MIME + \brief The Backend Capabilities example shows how to check which MIME types, audio devices, and audio effects are available. \image capabilitiesexample.png diff --git a/doc/src/examples/charactermap.qdoc b/doc/src/examples/charactermap.qdoc index 285d6a4..fa82d7e 100644 --- a/doc/src/examples/charactermap.qdoc +++ b/doc/src/examples/charactermap.qdoc @@ -29,7 +29,7 @@ \example widgets/charactermap \title Character Map Example -The Character Map example shows how to create a custom widget that can +\brief The Character Map example shows how to create a custom widget that can both display its own content and respond to user input. The example displays an array of characters which the user can click on diff --git a/doc/src/examples/chart.qdoc b/doc/src/examples/chart.qdoc index af82f1b..d18a8fa 100644 --- a/doc/src/examples/chart.qdoc +++ b/doc/src/examples/chart.qdoc @@ -29,7 +29,7 @@ \example itemviews/chart \title Chart Example - The Chart example shows how to create a custom view for the model/view framework. + \brief The Chart example shows how to create a custom view for the model/view framework. \image chart-example.png diff --git a/doc/src/examples/classwizard.qdoc b/doc/src/examples/classwizard.qdoc index 53d0936..d29b956 100644 --- a/doc/src/examples/classwizard.qdoc +++ b/doc/src/examples/classwizard.qdoc @@ -29,7 +29,7 @@ \example dialogs/classwizard \title Class Wizard Example - The License Wizard example shows how to implement linear + \brief The License Wizard example shows how to implement linear wizards using QWizard. \image classwizard.png Screenshot of the Class Wizard example diff --git a/doc/src/examples/codecs.qdoc b/doc/src/examples/codecs.qdoc index 91fb6a2..02248e9 100644 --- a/doc/src/examples/codecs.qdoc +++ b/doc/src/examples/codecs.qdoc @@ -29,7 +29,7 @@ \example tools/codecs \title Codecs Example - The Codecs example demonstrates the principles behind importing and exporting text + \brief The Codecs example demonstrates the principles behind importing and exporting text using codecs to ensure that characters are encoded properly, avoiding loss of data and retaining the correct symbols used in various scripts. diff --git a/doc/src/examples/codeeditor.qdoc b/doc/src/examples/codeeditor.qdoc index 1718d52..9935e88 100644 --- a/doc/src/examples/codeeditor.qdoc +++ b/doc/src/examples/codeeditor.qdoc @@ -29,7 +29,7 @@ \example widgets/codeeditor \title Code Editor Example - The Code Editor example shows how to create a simple editor that + \brief The Code Editor example shows how to create a simple editor that has line numbers and that highlights the current line. \image codeeditor-example.png diff --git a/doc/src/examples/collidingmice-example.qdoc b/doc/src/examples/collidingmice-example.qdoc index 4bdd79d..e7c475a 100644 --- a/doc/src/examples/collidingmice-example.qdoc +++ b/doc/src/examples/collidingmice-example.qdoc @@ -29,7 +29,7 @@ \example graphicsview/collidingmice \title Colliding Mice Example - The Colliding Mice example shows how to use the Graphics View + \brief The Colliding Mice example shows how to use the Graphics View framework to implement animated items and detect collision between items. @@ -265,4 +265,4 @@ Doing the animation with a single timer connect to advance the scene ensures that all the mice are moved at one point and, more importantly, only one update is sent to the screen after all the mice have moved. -*/
\ No newline at end of file +*/ diff --git a/doc/src/examples/coloreditorfactory.qdoc b/doc/src/examples/coloreditorfactory.qdoc index 34060bd..e7c6e7d 100644 --- a/doc/src/examples/coloreditorfactory.qdoc +++ b/doc/src/examples/coloreditorfactory.qdoc @@ -29,8 +29,8 @@ \example itemviews/coloreditorfactory \title Color Editor Factory Example - This example shows how to create an editor that can be used by - a QItemDelegate. + \brief The Color Editor Factory example shows how to create an editor that + can be used by a QItemDelegate. \image coloreditorfactoryimage.png diff --git a/doc/src/examples/combowidgetmapper.qdoc b/doc/src/examples/combowidgetmapper.qdoc index e852f5e..61d69c1 100644 --- a/doc/src/examples/combowidgetmapper.qdoc +++ b/doc/src/examples/combowidgetmapper.qdoc @@ -29,7 +29,7 @@ \example itemviews/combowidgetmapper \title Combo Widget Mapper Example - The Combo Widget Mapper example shows how to use a custom delegate to + \brief The Combo Widget Mapper example shows how to use a custom delegate to map information from a model to specific widgets on a form. \image combowidgetmapper-example.png diff --git a/doc/src/examples/completer.qdoc b/doc/src/examples/completer.qdoc index 408de6b..298bbc4 100644 --- a/doc/src/examples/completer.qdoc +++ b/doc/src/examples/completer.qdoc @@ -29,7 +29,7 @@ \example tools/completer \title Completer Example - The Completer example shows how to provide string-completion facilities + \brief The Completer example shows how to provide string-completion facilities for an input widget based on data provided by a model. \image completer-example.png diff --git a/doc/src/examples/complexpingpong.qdoc b/doc/src/examples/complexpingpong.qdoc index 677353b..2013744 100644 --- a/doc/src/examples/complexpingpong.qdoc +++ b/doc/src/examples/complexpingpong.qdoc @@ -29,7 +29,7 @@ \example dbus/complexpingpong \title Complex Ping Pong Example - The Complex Ping Pong example improves on the \l{D-Bus Ping Pong Example} by providing + \brief The Complex Ping Pong example improves on the \l{D-Bus Ping Pong Example} by providing a more useful demonstration of D-Bus interfaces. \quotefile doc/src/snippets/complexpingpong-example.txt diff --git a/doc/src/examples/concentriccircles.qdoc b/doc/src/examples/concentriccircles.qdoc index 37c8f83..bfa24d9 100644 --- a/doc/src/examples/concentriccircles.qdoc +++ b/doc/src/examples/concentriccircles.qdoc @@ -29,7 +29,7 @@ \example painting/concentriccircles \title Concentric Circles Example - The Concentric Circles example shows the improved rendering + \brief The Concentric Circles example shows the improved rendering quality that can be obtained using floating point precision and anti-aliasing when drawing custom widgets. The example also shows how to do simple animations. diff --git a/doc/src/examples/configdialog.qdoc b/doc/src/examples/configdialog.qdoc index 166b25a..d83dbdb 100644 --- a/doc/src/examples/configdialog.qdoc +++ b/doc/src/examples/configdialog.qdoc @@ -29,7 +29,7 @@ \example dialogs/configdialog \title Config Dialog Example - The Config Dialog examples shows how a configuration dialog can be created by + \brief The Config Dialog examples shows how a configuration dialog can be created by using an icon view with a stacked widget. \image configdialog-example.png diff --git a/doc/src/examples/containerextension.qdoc b/doc/src/examples/containerextension.qdoc index ca7ef13..606da2d 100644 --- a/doc/src/examples/containerextension.qdoc +++ b/doc/src/examples/containerextension.qdoc @@ -29,7 +29,7 @@ \example designer/containerextension \title Container Extension Example - The Container Extension example shows how to create a custom + \brief The Container Extension example shows how to create a custom multi-page plugin for Qt Designer using the QDesignerContainerExtension class. diff --git a/doc/src/examples/context2d.qdoc b/doc/src/examples/context2d.qdoc index 729e56b..9d9d0c6 100644 --- a/doc/src/examples/context2d.qdoc +++ b/doc/src/examples/context2d.qdoc @@ -29,7 +29,7 @@ \example script/context2d \title Context2D Example - This Qt Script example is an implementation of the Context2D API. + \brief This Qt Script example is an implementation of the Context2D API. \image context2d-example.png diff --git a/doc/src/examples/contextsensitivehelp.qdoc b/doc/src/examples/contextsensitivehelp.qdoc index 42e4a11..32b59bc 100644 --- a/doc/src/examples/contextsensitivehelp.qdoc +++ b/doc/src/examples/contextsensitivehelp.qdoc @@ -29,5 +29,5 @@ \example help/contextsensitivehelp \title Context-Sensitive Help Example - This example shows how to use the services of the QHelpEngineCore class. + \brief The Context Sensitive Help example shows how to use the services of the QHelpEngineCore class. */ diff --git a/doc/src/examples/contiguouscache.qdoc b/doc/src/examples/contiguouscache.qdoc index d0b39e6..52e8b15 100644 --- a/doc/src/examples/contiguouscache.qdoc +++ b/doc/src/examples/contiguouscache.qdoc @@ -29,8 +29,10 @@ \example tools/contiguouscache \title Contiguous Cache Example - The Contiguous Cache example shows how to use QContiguousCache to manage memory usage for - very large models. In some environments memory is limited and, even when it + \brief The Contiguous Cache example shows how to use QContiguousCache to manage memory usage for + very large models. + + In some environments memory is limited and, even when it isn't, users still dislike an application using excessive memory. Using QContiguousCache to manage a list, rather than loading the entire list into memory, allows the application to limit the amount diff --git a/doc/src/examples/cube.qdoc b/doc/src/examples/cube.qdoc index e1fd172..e28d4b2 100644 --- a/doc/src/examples/cube.qdoc +++ b/doc/src/examples/cube.qdoc @@ -44,8 +44,10 @@ \group all-examples \title Cube OpenGL ES 2.0 example - The Cube OpenGL ES 2.0 example shows how to write mouse rotateable - textured 3D cube using OpenGL ES 2.0 with Qt. It shows how to handle + \brief The Cube OpenGL ES 2.0 example shows how to write mouse rotateable + textured 3D cube using OpenGL ES 2.0 with Qt. + + It shows how to handle polygon geometries efficiently and how to write simple vertex and fragment shader for programmable graphics pipeline. In addition it shows how to use quaternions for representing 3D object orientation. diff --git a/doc/src/examples/customcompleter.qdoc b/doc/src/examples/customcompleter.qdoc index f0d5698..27e2ea7 100644 --- a/doc/src/examples/customcompleter.qdoc +++ b/doc/src/examples/customcompleter.qdoc @@ -29,9 +29,9 @@ \example tools/customcompleter \title Custom Completer Example - The Custom Completer example shows how to provide string-completion - facilities for an input widget based on data provided by a model. The - completer pops up suggestions for possible words based on the first three + \brief The Custom Completer example shows how to provide string-completion + facilities for an input widget based on data provided by a model. + The completer pops up suggestions for possible words based on the first three characters input by the user and the user's choice of word is inserted into the \c TextEdit using QTextCursor. diff --git a/doc/src/examples/customsortfiltermodel.qdoc b/doc/src/examples/customsortfiltermodel.qdoc index e145e82..41f8b04 100644 --- a/doc/src/examples/customsortfiltermodel.qdoc +++ b/doc/src/examples/customsortfiltermodel.qdoc @@ -29,7 +29,7 @@ \example itemviews/customsortfiltermodel \title Custom Sort/Filter Model Example - The Custom Sort/Filter Model example illustrates how to subclass + \brief The Custom Sort/Filter Model example illustrates how to subclass QSortFilterProxyModel to perform advanced sorting and filtering. \image customsortfiltermodel-example.png Screenshot of the Custom Sort/Filter Model Example diff --git a/doc/src/examples/customtype.qdoc b/doc/src/examples/customtype.qdoc index b969354..8ff97f3 100644 --- a/doc/src/examples/customtype.qdoc +++ b/doc/src/examples/customtype.qdoc @@ -29,7 +29,7 @@ \example tools/customtype \title Custom Type Example - The Custom Type example shows how to integrate a custom type into Qt's + \brief The Custom Type example shows how to integrate a custom type into Qt's meta-object system. Contents: diff --git a/doc/src/examples/customtypesending.qdoc b/doc/src/examples/customtypesending.qdoc index fc6b793..4ffb40e 100644 --- a/doc/src/examples/customtypesending.qdoc +++ b/doc/src/examples/customtypesending.qdoc @@ -29,7 +29,7 @@ \example tools/customtypesending \title Custom Type Sending Example - The Custom Type Sending example shows how to use a custom type with signals + \brief The Custom Type Sending example shows how to use a custom type with signals and slots. \image customtypesending-example.png diff --git a/doc/src/examples/customwidgetplugin.qdoc b/doc/src/examples/customwidgetplugin.qdoc index dadfbaf..81277ce 100644 --- a/doc/src/examples/customwidgetplugin.qdoc +++ b/doc/src/examples/customwidgetplugin.qdoc @@ -29,7 +29,7 @@ \example designer/customwidgetplugin \title Custom Widget Plugin Example - The Custom Widget example shows how to create a custom widget plugin for \QD. + \brief The Custom Widget example shows how to create a custom widget plugin for \QD. \image customwidgetplugin-example.png diff --git a/doc/src/examples/dbscreen.qdoc b/doc/src/examples/dbscreen.qdoc index 7f6bb18..c2b88cd 100644 --- a/doc/src/examples/dbscreen.qdoc +++ b/doc/src/examples/dbscreen.qdoc @@ -29,7 +29,7 @@ \example qws/dbscreen \title Double Buffered Graphics Driver Example - The Double Buffered Graphics Driver example shows how to write your own + \brief The Double Buffered Graphics Driver example shows how to write your own double buffered graphics driver and add it to Qt for Embedded Linux. Similar to the \l{Accelerated Graphics Driver Example}, there are three steps diff --git a/doc/src/examples/dbus-chat.qdoc b/doc/src/examples/dbus-chat.qdoc index a435cc9..c00166d 100644 --- a/doc/src/examples/dbus-chat.qdoc +++ b/doc/src/examples/dbus-chat.qdoc @@ -29,7 +29,7 @@ \example dbus/dbus-chat \title D-Bus Chat Example - The D-Bus Chat example shows how to use D-Bus to communicate between two + \brief The D-Bus Chat example shows how to use D-Bus to communicate between two applications. \image dbus-chat-example.png diff --git a/doc/src/examples/dbus-listnames.qdoc b/doc/src/examples/dbus-listnames.qdoc index 3d359f7..9807c30 100644 --- a/doc/src/examples/dbus-listnames.qdoc +++ b/doc/src/examples/dbus-listnames.qdoc @@ -29,5 +29,5 @@ \example dbus/listnames \title D-Bus List Names Example - The D-Bus List Names examples shows how to query D-Bus for a list of service names. + \brief The D-Bus List Names examples shows how to query D-Bus for a list of service names. */ diff --git a/doc/src/examples/dbus-pingpong.qdoc b/doc/src/examples/dbus-pingpong.qdoc index dc0f50b..2463877 100644 --- a/doc/src/examples/dbus-pingpong.qdoc +++ b/doc/src/examples/dbus-pingpong.qdoc @@ -29,7 +29,7 @@ \example dbus/pingpong \title D-Bus Ping Pong Example - The D-Bus Ping Pong example provides a basic demonstration of D-Bus + \brief The D-Bus Ping Pong example provides a basic demonstration of D-Bus interfaces. \quotefile doc/src/snippets/dbus-pingpong-example.txt diff --git a/doc/src/examples/dbus-remotecontrolledcar.qdoc b/doc/src/examples/dbus-remotecontrolledcar.qdoc index 3f0af9a..7152e21 100644 --- a/doc/src/examples/dbus-remotecontrolledcar.qdoc +++ b/doc/src/examples/dbus-remotecontrolledcar.qdoc @@ -29,7 +29,7 @@ \example dbus/remotecontrolledcar \title D-Bus Remote Controlled Car Example - The Remote Controlled Car example shows how to use D-Bus to control one + \brief The Remote Controlled Car example shows how to use D-Bus to control one application using another. \image remotecontrolledcar-car-example.png diff --git a/doc/src/examples/defaultprototypes.qdoc b/doc/src/examples/defaultprototypes.qdoc index a6c79f0..493a3bb 100644 --- a/doc/src/examples/defaultprototypes.qdoc +++ b/doc/src/examples/defaultprototypes.qdoc @@ -29,7 +29,7 @@ \example script/defaultprototypes \title Default Prototypes Example - This Qt Script example shows how to use default prototypes + \brief The Default Prototypes QtScript example shows how to use default prototypes to make a non-QObject-based type scriptable. \image defaultprototypes-example.png diff --git a/doc/src/examples/delayedencoding.qdoc b/doc/src/examples/delayedencoding.qdoc index 8ac2c7f..d94b589 100644 --- a/doc/src/examples/delayedencoding.qdoc +++ b/doc/src/examples/delayedencoding.qdoc @@ -29,7 +29,7 @@ \example draganddrop/delayedencoding \title Delayed Encoding Example - The Delayed Encoding example shows how to delay preparing of data + \brief The Delayed Encoding example shows how to delay preparing of data for drag and drop operations until a drop target is found. \image delayedecoding-example.png diff --git a/doc/src/examples/diagramscene.qdoc b/doc/src/examples/diagramscene.qdoc index 7d3c0e6..0518a33 100644 --- a/doc/src/examples/diagramscene.qdoc +++ b/doc/src/examples/diagramscene.qdoc @@ -29,12 +29,12 @@ \example graphicsview/diagramscene \title Diagram Scene Example - This example shows use of Qt's graphics framework. + \brief The Diagram Scene example is an application in which you can + create a flowchart diagram using the graphics view framework. \image diagramscene.png - The Diagram Scene example is an application in which you can - create a flowchart diagram. It is possible to add flowchart shapes + In this example it is possible to add flowchart shapes and text and connect the shapes by arrows as shown in the image above. The shapes, arrows, and text can be given different colors, and it is possible to change the font, style, and @@ -149,11 +149,11 @@ Example}{application example} if you need a high-level introduction to actions. - The is the \c createMenus() function: + Here is the \c createMenus() function: \snippet examples/graphicsview/diagramscene/mainwindow.cpp 24 - We create the three menus' of the example. + We create the three menus of the example. The \c createToolbars() function sets up the examples tool bars. The three \l{QToolButton}s in the \c colorToolBar, the \c @@ -199,7 +199,7 @@ each button; we store the diagram's type, i.e., the DiagramItem::DiagramType enum. We use the stored diagram type when we create new diagram items for the scene. The widgets created - with this function is used in the tool box. + with this function are used in the tool box. Here is the \c createColorMenu() function: @@ -443,7 +443,7 @@ In the \c DiagramScene a mouse click can give three different actions: the item under the mouse can be moved, an item may be - inserted, or an arrow may be connected between to diagram items. + inserted, or an arrow may be connected between two diagram items. Which action a mouse click has depends on the mode, given by the Mode enum, the scene is in. The mode is set with the \c setMode() function. @@ -456,7 +456,7 @@ inserted is set with the \c setItemType() slot. The \c MainWindow and \c DiagramScene share responsibility for - the examples functionality. \c MainWindow handles the following + the example's functionality. \c MainWindow handles the following tasks: the deletion of items, text, and arrows; moving diagram items to the back and front; and setting the scale of the scene. @@ -624,7 +624,7 @@ \snippet examples/graphicsview/diagramscene/diagramitem.cpp 0 - In the constructor we create the items polygon according to + In the constructor we create the item's polygon according to \a diagramType. \l{QGraphicsItem}s are not movable or selectable by default, so we must set these properties. diff --git a/doc/src/examples/digitalclock.qdoc b/doc/src/examples/digitalclock.qdoc index acee4d6..90ee710 100644 --- a/doc/src/examples/digitalclock.qdoc +++ b/doc/src/examples/digitalclock.qdoc @@ -29,7 +29,7 @@ \example widgets/digitalclock \title Digital Clock Example - The Digital Clock example shows how to use QLCDNumber to display a + \brief The Digital Clock example shows how to use QLCDNumber to display a number with LCD-like digits. \image digitalclock-example.png Screenshot of the Digital Clock example diff --git a/doc/src/examples/dirview.qdoc b/doc/src/examples/dirview.qdoc index 6d2ce7a..6a45d9a 100644 --- a/doc/src/examples/dirview.qdoc +++ b/doc/src/examples/dirview.qdoc @@ -29,7 +29,7 @@ \example itemviews/dirview \title Dir View Example - The Dir View example shows a tree view onto the local filing system. It uses the + \brief The Dir View example shows a tree view onto the local filing system. It uses the QDirModel class to provide supply file and directory information. \image dirview-example.png diff --git a/doc/src/examples/dockwidgets.qdoc b/doc/src/examples/dockwidgets.qdoc index b46a286..c6cebcc 100644 --- a/doc/src/examples/dockwidgets.qdoc +++ b/doc/src/examples/dockwidgets.qdoc @@ -29,7 +29,7 @@ \example mainwindows/dockwidgets \title Dock Widgets Example - The Dock Widgets example shows how to add dock windows to an + \brief The Dock Widgets example shows how to add dock windows to an application. It also shows how to use Qt's rich text engine. \image dockwidgets-example.png Screenshot of the Dock Widgets example diff --git a/doc/src/examples/dombookmarks.qdoc b/doc/src/examples/dombookmarks.qdoc index 03e3ec6..e25766a 100644 --- a/doc/src/examples/dombookmarks.qdoc +++ b/doc/src/examples/dombookmarks.qdoc @@ -29,9 +29,10 @@ \example xml/dombookmarks \title DOM Bookmarks Example - The DOM Bookmarks example provides a reader for XML Bookmark Exchange Language (XBEL) - files that uses Qt's DOM-based XML API to read and parse the files. The SAX Bookmarks - example provides an alternative way to read this type of file. + \brief The DOM Bookmarks example provides a reader for XML Bookmark Exchange Language (XBEL) + files that uses Qt's DOM-based XML API to read and parse the files. + + The SAX Bookmarks example provides an alternative way to read this type of file. \image dombookmarks-example.png diff --git a/doc/src/examples/domtraversal.qdoc b/doc/src/examples/domtraversal.qdoc index d0456c4..657b0dd 100644 --- a/doc/src/examples/domtraversal.qdoc +++ b/doc/src/examples/domtraversal.qdoc @@ -29,7 +29,7 @@ \example webkit/domtraversal \title DOM Traversal Example - The DOM Traversal example shows how to use the QWebElement class to access + \brief The DOM Traversal example shows how to use the QWebElement class to access the structure of a Web page. \image webkit-domtraversal.png diff --git a/doc/src/examples/draganddroppuzzle.qdoc b/doc/src/examples/draganddroppuzzle.qdoc index e89c8fc..4bb1ccb 100644 --- a/doc/src/examples/draganddroppuzzle.qdoc +++ b/doc/src/examples/draganddroppuzzle.qdoc @@ -29,7 +29,7 @@ \example draganddrop/puzzle \title Drag and Drop Puzzle Example - The Drag and Drop Puzzle example demonstrates a way of using the drag and drop system with + \brief The Drag and Drop Puzzle example demonstrates a way of using the drag and drop system with item view widgets. \image draganddroppuzzle-example.png diff --git a/doc/src/examples/dragdroprobot.qdoc b/doc/src/examples/dragdroprobot.qdoc index 84d8af4..aba30ad 100644 --- a/doc/src/examples/dragdroprobot.qdoc +++ b/doc/src/examples/dragdroprobot.qdoc @@ -29,7 +29,7 @@ \example graphicsview/dragdroprobot \title Drag and Drop Robot Example - The Drag and Drop Robot example shows how to implement Drag and Drop in a + \brief The Drag and Drop Robot example shows how to implement Drag and Drop in a QGraphicsItem subclass, as well as how to animate items using Qt's \l{Animation Framework}. diff --git a/doc/src/examples/draggableicons.qdoc b/doc/src/examples/draggableicons.qdoc index 0337431..1484a60 100644 --- a/doc/src/examples/draggableicons.qdoc +++ b/doc/src/examples/draggableicons.qdoc @@ -29,7 +29,7 @@ \example draganddrop/draggableicons \title Draggable Icons Example - The Draggable Icons example shows how to drag and drop image data between widgets + \brief The Draggable Icons example shows how to drag and drop image data between widgets in the same application, and between different applications. \image draggableicons-example.png diff --git a/doc/src/examples/draggabletext.qdoc b/doc/src/examples/draggabletext.qdoc index 14d07b6..ae9cfb9 100644 --- a/doc/src/examples/draggabletext.qdoc +++ b/doc/src/examples/draggabletext.qdoc @@ -29,7 +29,7 @@ \example draganddrop/draggabletext \title Draggable Text Example - The Draggable Text example shows how to drag and drop textual data between widgets + \brief The Draggable Text example shows how to drag and drop textual data between widgets in the same application, and between different applications. \image draggabletext-example.png diff --git a/doc/src/examples/drilldown.qdoc b/doc/src/examples/drilldown.qdoc index 1903df6..d11a71f 100644 --- a/doc/src/examples/drilldown.qdoc +++ b/doc/src/examples/drilldown.qdoc @@ -29,7 +29,7 @@ \example sql/drilldown \title Drill Down Example - The Drill Down example shows how to read data from a database as + \brief The Drill Down example shows how to read data from a database as well as submit changes, using the QSqlRelationalTableModel and QDataWidgetMapper classes. diff --git a/doc/src/examples/dropsite.qdoc b/doc/src/examples/dropsite.qdoc index bf17427..815618a 100644 --- a/doc/src/examples/dropsite.qdoc +++ b/doc/src/examples/dropsite.qdoc @@ -29,7 +29,7 @@ \example draganddrop/dropsite \title Drop Site Example - The example shows how to distinguish the various MIME formats available + \brief The Drop Site example shows how to distinguish the various MIME formats available in a drag and drop operation. \image dropsite-example.png Screenshot of the Drop Site example diff --git a/doc/src/examples/dynamiclayouts.qdoc b/doc/src/examples/dynamiclayouts.qdoc index b8314e3..c93fc74 100644 --- a/doc/src/examples/dynamiclayouts.qdoc +++ b/doc/src/examples/dynamiclayouts.qdoc @@ -29,6 +29,6 @@ \example layouts/dynamiclayouts \title Dynamic Layouts Example - The Dynamic Layouts example shows how to move widgets around in + \brief The Dynamic Layouts example shows how to move widgets around in existing layouts. */ diff --git a/doc/src/examples/easing.qdoc b/doc/src/examples/easing.qdoc index 1a7657d..42f00f1 100644 --- a/doc/src/examples/easing.qdoc +++ b/doc/src/examples/easing.qdoc @@ -29,7 +29,7 @@ \example animation/easing \title Easing Curves Example - The Easing Curves example shows how to use easing curves to + \brief The Easing Curves example shows how to use easing curves to control the speed of an animation. \image easing-example.png diff --git a/doc/src/examples/echoplugin.qdoc b/doc/src/examples/echoplugin.qdoc index cadd485..c920c2b 100644 --- a/doc/src/examples/echoplugin.qdoc +++ b/doc/src/examples/echoplugin.qdoc @@ -29,7 +29,7 @@ \example tools/echoplugin \title Echo Plugin Example - This example shows how to create a Qt plugin. + \brief The Echo Plugin example shows how to create a Qt plugin. \image echopluginexample.png diff --git a/doc/src/examples/editabletreemodel.qdoc b/doc/src/examples/editabletreemodel.qdoc index 8be3037..00f20f6 100644 --- a/doc/src/examples/editabletreemodel.qdoc +++ b/doc/src/examples/editabletreemodel.qdoc @@ -29,8 +29,8 @@ \example itemviews/editabletreemodel \title Editable Tree Model Example - This example shows how to implement a simple item-based tree model that can - be used with other classes the model/view framework. + \brief The Editable Tree Model example shows how to implement a simple item-based tree model that can + be used with other classes in the model/view framework. \image itemviews-editabletreemodel.png diff --git a/doc/src/examples/elasticnodes.qdoc b/doc/src/examples/elasticnodes.qdoc index e5399b1..30ebc6f 100644 --- a/doc/src/examples/elasticnodes.qdoc +++ b/doc/src/examples/elasticnodes.qdoc @@ -29,8 +29,10 @@ \example graphicsview/elasticnodes \title Elastic Nodes Example - The Elastic Nodes example shows how to implement edges between nodes in a - graph, with basic interaction. You can click to drag a node around, and + \brief The Elastic Nodes example shows how to implement edges between nodes in a + graph, with basic interaction. + + You can click to drag a node around, and zoom in and out using the mouse wheel or the keyboard. Hitting the space bar will randomize the nodes. The example is also resolution independent; as you zoom in, the graphics remain crisp. diff --git a/doc/src/examples/elidedlabel.qdoc b/doc/src/examples/elidedlabel.qdoc index 5bfe0f8..9a5b476 100644 --- a/doc/src/examples/elidedlabel.qdoc +++ b/doc/src/examples/elidedlabel.qdoc @@ -30,7 +30,7 @@ \group all-examples \title Elided Label Example - This example creates a widget similar to QLabel, that elides the last + \brief The Elided Label example creates a widget similar to QLabel, that elides the last visible line, if the text is too long to fit the widget's geometry. \image elidedlabel-example.png Elided Label example on XPressMusic 5800 diff --git a/doc/src/examples/eventtransitions.qdoc b/doc/src/examples/eventtransitions.qdoc index c66e9c1..bc0503c 100644 --- a/doc/src/examples/eventtransitions.qdoc +++ b/doc/src/examples/eventtransitions.qdoc @@ -29,7 +29,7 @@ \example statemachine/eventtransitions \title Event Transitions Example - The Event Transitions example shows how to use event transitions, a + \brief The Event Transitions example shows how to use event transitions, a feature of \l{The State Machine Framework}. \snippet examples/statemachine/eventtransitions/main.cpp 0 diff --git a/doc/src/examples/extension.qdoc b/doc/src/examples/extension.qdoc index 41fddbb..69604ba 100644 --- a/doc/src/examples/extension.qdoc +++ b/doc/src/examples/extension.qdoc @@ -29,7 +29,7 @@ \example dialogs/extension \title Extension Example - The Extension example shows how to add an extension to a QDialog + \brief The Extension example shows how to add an extension to a QDialog using the QAbstractButton::toggled() signal and the QWidget::setVisible() slot. diff --git a/doc/src/examples/factorial.qdoc b/doc/src/examples/factorial.qdoc index a317189..483cd46 100644 --- a/doc/src/examples/factorial.qdoc +++ b/doc/src/examples/factorial.qdoc @@ -29,7 +29,7 @@ \example statemachine/factorial \title Factorial States Example - The Factorial States example shows how to use \l{The State Machine + \brief The Factorial States example shows how to use \l{The State Machine Framework} to calculate the factorial of an integer. The statechart for calculating the factorial looks as follows: diff --git a/doc/src/examples/fademessage.qdoc b/doc/src/examples/fademessage.qdoc index 7e07324..5abc19a 100644 --- a/doc/src/examples/fademessage.qdoc +++ b/doc/src/examples/fademessage.qdoc @@ -29,9 +29,8 @@ \example effects/fademessage \title Fade Message Effect Example - \div { style="text-align: center"} - \inlineimage fademessageeffect-example.png - \inlineimage fademessageeffect-example-faded.png - \enddiv - + \brief The Fade Message Example shows the QGraphicsColorizeEffect in action. + + \image fademessageeffect-example.png + \image fademessageeffect-example-faded.png */ diff --git a/doc/src/examples/fancybrowser.qdoc b/doc/src/examples/fancybrowser.qdoc index 327dfbd..8cae77e 100644 --- a/doc/src/examples/fancybrowser.qdoc +++ b/doc/src/examples/fancybrowser.qdoc @@ -29,7 +29,7 @@ \example webkit/fancybrowser \title Fancy Browser Example - The Fancy Browser example shows how to use jQuery with QtWebKit to + \brief The Fancy Browser example shows how to use jQuery with QtWebKit to create a web browser with special effects and content manipulation. diff --git a/doc/src/examples/fetchmore.qdoc b/doc/src/examples/fetchmore.qdoc index 9e64b0a..8774543 100644 --- a/doc/src/examples/fetchmore.qdoc +++ b/doc/src/examples/fetchmore.qdoc @@ -29,7 +29,7 @@ \example itemviews/fetchmore \title Fetch More Example - The Fetch More example shows how two add items to an item view + \brief The Fetch More example shows how two add items to an item view model on demand. \image fetchmore-example.png diff --git a/doc/src/examples/filetree.qdoc b/doc/src/examples/filetree.qdoc index ae691d8..5b1019a 100644 --- a/doc/src/examples/filetree.qdoc +++ b/doc/src/examples/filetree.qdoc @@ -29,7 +29,7 @@ \example xmlpatterns/filetree \title File System Example - This example shows how to use QtXmlPatterns for querying non-XML + \brief The File Tree example shows how to use QtXmlPatterns for querying non-XML data that is modeled to look like XML. \tableofcontents diff --git a/doc/src/examples/findfiles.qdoc b/doc/src/examples/findfiles.qdoc index 026d61f..df591b6 100644 --- a/doc/src/examples/findfiles.qdoc +++ b/doc/src/examples/findfiles.qdoc @@ -29,8 +29,10 @@ \example dialogs/findfiles \title Find Files Example - The Find Files example shows how to use QProgressDialog to provide - feedback on the progress of a slow operation. The example also + \brief The Find Files example shows how to use QProgressDialog to provide + feedback on the progress of a slow operation. + + The example also shows how to use QFileDialog to facilitate browsing, how to use QTextStream's streaming operators to read a file, and how to use QTableWidget to provide standard table display facilities for diff --git a/doc/src/examples/fingerpaint.qdoc b/doc/src/examples/fingerpaint.qdoc index 49078b6..659784c 100644 --- a/doc/src/examples/fingerpaint.qdoc +++ b/doc/src/examples/fingerpaint.qdoc @@ -29,7 +29,7 @@ \example touch/fingerpaint \title Finger Paint Example - The Finger Paint example shows the use of a touchscreen with a custom widget + \brief The Finger Paint example shows the use of a touchscreen with a custom widget to create a simple painting application. \image touch-fingerpaint-example.png diff --git a/doc/src/examples/flowlayout.qdoc b/doc/src/examples/flowlayout.qdoc index 194a733..7b35b67 100644 --- a/doc/src/examples/flowlayout.qdoc +++ b/doc/src/examples/flowlayout.qdoc @@ -29,7 +29,7 @@ \example layouts/flowlayout \title Flow Layout Example - The Flow Layout example demonstrates a custom layout that arranges child + \brief The Flow Layout example demonstrates a custom layout that arranges child widgets from left to right and top to bottom in a top-level widget. \image flowlayout-example.png Screenshot of the Flow Layout example diff --git a/doc/src/examples/fontsampler.qdoc b/doc/src/examples/fontsampler.qdoc index b3caa9f..6ebeab9 100644 --- a/doc/src/examples/fontsampler.qdoc +++ b/doc/src/examples/fontsampler.qdoc @@ -29,7 +29,7 @@ \example painting/fontsampler \title Font Sampler Example - The Font Sampler example shows how to preview and print multi-page documents. + \brief The Font Sampler example shows how to preview and print multi-page documents. \image fontsampler-example.png */ diff --git a/doc/src/examples/formextractor.qdoc b/doc/src/examples/formextractor.qdoc index 79f6d19..de050c5 100644 --- a/doc/src/examples/formextractor.qdoc +++ b/doc/src/examples/formextractor.qdoc @@ -29,7 +29,7 @@ \example webkit/formextractor \title Form Extractor Example - The Form Extractor example shows how to use QWebFrame with JavaScript to + \brief The Form Extractor example shows how to use QWebFrame with JavaScript to extract form data. \image formextractor-example.png diff --git a/doc/src/examples/fortuneclient.qdoc b/doc/src/examples/fortuneclient.qdoc index 0c74143..7837ee2 100644 --- a/doc/src/examples/fortuneclient.qdoc +++ b/doc/src/examples/fortuneclient.qdoc @@ -29,8 +29,10 @@ \example network/fortuneclient \title Fortune Client Example - The Fortune Client example shows how to create a client for a simple - network service using QTcpSocket. It is intended to be run alongside the + \brief The Fortune Client example shows how to create a client for a simple + network service using QTcpSocket. + + The example is intended to be run alongside the \l{network/fortuneserver}{Fortune Server} example or the \l{network/threadedfortuneserver}{Threaded Fortune Server} example. diff --git a/doc/src/examples/fortuneserver.qdoc b/doc/src/examples/fortuneserver.qdoc index 2fb7f25..5042479 100644 --- a/doc/src/examples/fortuneserver.qdoc +++ b/doc/src/examples/fortuneserver.qdoc @@ -29,8 +29,10 @@ \example network/fortuneserver \title Fortune Server Example - The Fortune Server example shows how to create a server for a simple - network service. It is intended to be run alongside the + \brief The Fortune Server example shows how to create a server for a simple + network service. + + The example is intended to be run alongside the \l{network/fortuneclient}{Fortune Client} example or the \l{network/blockingfortuneclient}{Blocking Fortune Client} example. diff --git a/doc/src/examples/framebufferobject.qdoc b/doc/src/examples/framebufferobject.qdoc index 12b1d5f..539b751 100644 --- a/doc/src/examples/framebufferobject.qdoc +++ b/doc/src/examples/framebufferobject.qdoc @@ -29,7 +29,7 @@ \example opengl/framebufferobject \title Framebuffer Object Example - The Framebuffer Object example demonstrates how to use the + \brief The Framebuffer Object example demonstrates how to use the QGLFramebufferObject class to render into an off-screen buffer and use the contents as a texture in a QGLWidget. diff --git a/doc/src/examples/framebufferobject2.qdoc b/doc/src/examples/framebufferobject2.qdoc index cbe8f3f..b77b495 100644 --- a/doc/src/examples/framebufferobject2.qdoc +++ b/doc/src/examples/framebufferobject2.qdoc @@ -29,7 +29,7 @@ \example opengl/framebufferobject2 \title Framebuffer Object 2 Example - The Framebuffer Object 2 example demonstrates how to use the + \brief The Framebuffer Object 2 example demonstrates how to use the QGLFramebufferObject class to render into an off-screen buffer and use the contents as a texture in a QGLWidget. diff --git a/doc/src/examples/fridgemagnets.qdoc b/doc/src/examples/fridgemagnets.qdoc index 8490801..689ed1f 100644 --- a/doc/src/examples/fridgemagnets.qdoc +++ b/doc/src/examples/fridgemagnets.qdoc @@ -29,7 +29,7 @@ \example draganddrop/fridgemagnets \title Fridge Magnets Example - The Fridge Magnets example shows how to supply more than one type + \brief The Fridge Magnets example shows how to supply more than one type of MIME-encoded data with a drag and drop operation. \image fridgemagnets-example.png diff --git a/doc/src/examples/frozencolumn.qdoc b/doc/src/examples/frozencolumn.qdoc index a21926b..9d0d938 100644 --- a/doc/src/examples/frozencolumn.qdoc +++ b/doc/src/examples/frozencolumn.qdoc @@ -29,7 +29,7 @@ \example itemviews/frozencolumn \title Frozen Column Example - This example demonstrates how to freeze a column within a QTableView. + \brief The Frozen Column example demonstrates how to freeze a column within a QTableView. \image frozencolumn-example.png "Screenshot of the example" diff --git a/doc/src/examples/ftp.qdoc b/doc/src/examples/ftp.qdoc index f0d64ef..57796f8 100644 --- a/doc/src/examples/ftp.qdoc +++ b/doc/src/examples/ftp.qdoc @@ -29,7 +29,7 @@ \example network/qftp \title FTP Example - The FTP example demonstrates a simple FTP client that can be used + \brief The FTP example demonstrates a simple FTP client that can be used to list the available files on an FTP server and download them. \image ftp-example.png diff --git a/doc/src/examples/globalVariables.qdoc b/doc/src/examples/globalVariables.qdoc index 70147d2..b03440d 100644 --- a/doc/src/examples/globalVariables.qdoc +++ b/doc/src/examples/globalVariables.qdoc @@ -29,7 +29,7 @@ \example xmlpatterns/xquery/globalVariables \title C++ Source Code Analyzer Example - This example uses XQuery and the \c xmlpatterns command line utility to + \brief The Global Variables example uses XQuery and the \c xmlpatterns command line utility to query C++ source code. \tableofcontents diff --git a/doc/src/examples/googlechat.qdoc b/doc/src/examples/googlechat.qdoc index e9118f1..34dbbf6 100644 --- a/doc/src/examples/googlechat.qdoc +++ b/doc/src/examples/googlechat.qdoc @@ -29,7 +29,7 @@ \example webkit/googlechat \title Google Chat Example - The Google Chat example shows how to use implement a simple Google Chat + \brief The Google Chat example shows how to use implement a simple Google Chat client with QtWebKit. \image googlechat-example.png diff --git a/doc/src/examples/googlesuggest.qdoc b/doc/src/examples/googlesuggest.qdoc index 743a624..8e5c1ca 100644 --- a/doc/src/examples/googlesuggest.qdoc +++ b/doc/src/examples/googlesuggest.qdoc @@ -29,7 +29,7 @@ \example network/googlesuggest \title Google Suggest Example - The Google Suggest example demonstrates how to use the QNetworkAccessManager + \brief The Google Suggest example demonstrates how to use the QNetworkAccessManager class to obtain a list of suggestions from the Google search engine as the user types into a QLineEdit. diff --git a/doc/src/examples/grabber.qdoc b/doc/src/examples/grabber.qdoc index 4b65848..27a89b9 100644 --- a/doc/src/examples/grabber.qdoc +++ b/doc/src/examples/grabber.qdoc @@ -29,7 +29,7 @@ \example opengl/grabber \title Grabber Example - The Grabber examples shows how to retrieve the contents of an OpenGL framebuffer. + \brief The Grabber examples shows how to retrieve the contents of an OpenGL framebuffer. \image grabber-example.png */ diff --git a/doc/src/examples/graphicsview-anchorlayout.qdoc b/doc/src/examples/graphicsview-anchorlayout.qdoc index 156cdb4..68c144a 100644 --- a/doc/src/examples/graphicsview-anchorlayout.qdoc +++ b/doc/src/examples/graphicsview-anchorlayout.qdoc @@ -29,6 +29,6 @@ \example graphicsview/anchorlayout \title Anchor Layout Example - The Anchor Layout example demonstrates the use of the QGraphicsAnchorLayout + \brief The Anchor Layout example demonstrates the use of the QGraphicsAnchorLayout class. */ diff --git a/doc/src/examples/graphicsview-flowlayout.qdoc b/doc/src/examples/graphicsview-flowlayout.qdoc index b0c04b8..42ea65f 100644 --- a/doc/src/examples/graphicsview-flowlayout.qdoc +++ b/doc/src/examples/graphicsview-flowlayout.qdoc @@ -29,7 +29,7 @@ \example graphicsview/flowlayout \title Graphics View Flow Layout Example - The Graphics View Flow Layout example shows the use of a flow layout + \brief The Graphics View Flow Layout example shows the use of a flow layout in a Graphics View widget. See the \l{Flow Layout Example} for a corresponding widget-based example. diff --git a/doc/src/examples/graphicsview-simpleanchorlayout.qdoc b/doc/src/examples/graphicsview-simpleanchorlayout.qdoc index 6f6ba5b..603ea50 100644 --- a/doc/src/examples/graphicsview-simpleanchorlayout.qdoc +++ b/doc/src/examples/graphicsview-simpleanchorlayout.qdoc @@ -29,6 +29,6 @@ \example graphicsview/simpleanchorlayout \title Simple Anchor Layout Example - The Simple Anchor Layout example shows the basic use of the + \brief The Simple Anchor Layout example shows the basic use of the QGraphicsAnchorLayout class. */ diff --git a/doc/src/examples/graphicsview-weatheranchorlayout.qdoc b/doc/src/examples/graphicsview-weatheranchorlayout.qdoc index 20173af..da2ee76 100644 --- a/doc/src/examples/graphicsview-weatheranchorlayout.qdoc +++ b/doc/src/examples/graphicsview-weatheranchorlayout.qdoc @@ -29,6 +29,6 @@ \example graphicsview/weatheranchorlayout \title Weather Anchor Layout Example - The Weather Anchor Layout example shows more complex use of the + \brief The Weather Anchor Layout example shows more complex use of the QGraphicsAnchorLayout class to create a real-world window layout. */ diff --git a/doc/src/examples/groupbox.qdoc b/doc/src/examples/groupbox.qdoc index a042437..02e8a9c 100644 --- a/doc/src/examples/groupbox.qdoc +++ b/doc/src/examples/groupbox.qdoc @@ -29,7 +29,7 @@ \example widgets/groupbox \title Group Box Example - The Group Box example shows how to use the different kinds of group + \brief The Group Box example shows how to use the different kinds of group boxes in Qt. Group boxes are container widgets that organize buttons into groups, diff --git a/doc/src/examples/hellogl.qdoc b/doc/src/examples/hellogl.qdoc index dbd672e..641a777 100644 --- a/doc/src/examples/hellogl.qdoc +++ b/doc/src/examples/hellogl.qdoc @@ -29,7 +29,7 @@ \example opengl/hellogl \title Hello GL Example - The Hello GL example demonstrates the basic use of the OpenGL-related classes + \brief The Hello GL example demonstrates the basic use of the OpenGL-related classes provided with Qt. \image hellogl-example.png diff --git a/doc/src/examples/hellogl_es.qdoc b/doc/src/examples/hellogl_es.qdoc index fdc7ab5..d57bb1d 100644 --- a/doc/src/examples/hellogl_es.qdoc +++ b/doc/src/examples/hellogl_es.qdoc @@ -29,7 +29,7 @@ \example opengl/hellogl_es \title Hello GL ES Example - The Hello GL ES example is the \l{Hello GL Example} ported to OpenGL ES. + \brief The Hello GL ES example is the \l{Hello GL Example} ported to OpenGL ES. It also included some effects from the OpenGL \l{Overpainting Example}. \image hellogl-es-example.png diff --git a/doc/src/examples/helloscript.qdoc b/doc/src/examples/helloscript.qdoc index 1c6ea85..745a327 100644 --- a/doc/src/examples/helloscript.qdoc +++ b/doc/src/examples/helloscript.qdoc @@ -29,9 +29,11 @@ \example script/helloscript \title Hello Script Example - The Hello Script example shows the basic use of Qt Script: How to embed + \brief The Hello Script example shows the basic use of Qt Script: How to embed a script engine into the application, how to evaluate a script, and how - to process the result of the evaluation. The example also shows how to + to process the result of the evaluation. + + The example also shows how to apply internationalization to scripts. \snippet examples/script/helloscript/main.cpp 0 diff --git a/doc/src/examples/hellotr.qdoc b/doc/src/examples/hellotr.qdoc index 4b7c4b7..c85a2ad 100644 --- a/doc/src/examples/hellotr.qdoc +++ b/doc/src/examples/hellotr.qdoc @@ -29,8 +29,9 @@ \example linguist/hellotr \title Hello tr() Example - This example is a small Hello World program with a Latin translation. The - screenshot below shows the English version. + \brief The Hello tr() example is a small Hello World program with a Latin translation. + + The screenshot below shows the English version. \image linguist-hellotr_en.png diff --git a/doc/src/examples/htmlinfo.qdoc b/doc/src/examples/htmlinfo.qdoc index 23365f1..e21e8b0 100644 --- a/doc/src/examples/htmlinfo.qdoc +++ b/doc/src/examples/htmlinfo.qdoc @@ -29,7 +29,7 @@ \example xml/htmlinfo \title XML HTML Info Example - The XML HTML Info example provides a simple command line utility that + \brief The XML HTML Info example provides a simple command line utility that scans the current directory for HTML files and prints statistics about them to standard out. diff --git a/doc/src/examples/http.qdoc b/doc/src/examples/http.qdoc index ab03683..4704be0 100644 --- a/doc/src/examples/http.qdoc +++ b/doc/src/examples/http.qdoc @@ -29,7 +29,7 @@ \example network/http \title HTTP Example - The HTTP example demonstrates a simple HTTP client that shows how to fetch files + \brief The HTTP example demonstrates a simple HTTP client that shows how to fetch files specified by URLs from remote hosts. \image http-example.png diff --git a/doc/src/examples/i18n.qdoc b/doc/src/examples/i18n.qdoc index 2ce47e1..392d2e2 100644 --- a/doc/src/examples/i18n.qdoc +++ b/doc/src/examples/i18n.qdoc @@ -29,8 +29,10 @@ \example tools/i18n \title I18N Example - The Internationalization (I18N) example demonstrates Qt's support for translated - text. Developers can write the initial application text in one language, and + \brief The Internationalization (I18N) example demonstrates Qt's support for translated + text. + + Developers can write the initial application text in one language, and translations can be provided later without any modifications to the code. \image i18n-example.png diff --git a/doc/src/examples/icons.qdoc b/doc/src/examples/icons.qdoc index 82ff994..3fa9952 100644 --- a/doc/src/examples/icons.qdoc +++ b/doc/src/examples/icons.qdoc @@ -29,8 +29,10 @@ \example widgets/icons \title Icons Example - The Icons example shows how QIcon can generate pixmaps reflecting - an icon's state, mode and size. These pixmaps are generated from + \brief The Icons example shows how QIcon can generate pixmaps reflecting + an icon's state, mode and size. + + These pixmaps are generated from the set of pixmaps made available to the icon, and are used by Qt widgets to show an icon representing a particular action. diff --git a/doc/src/examples/imagecomposition.qdoc b/doc/src/examples/imagecomposition.qdoc index cd08de4..8b95ded 100644 --- a/doc/src/examples/imagecomposition.qdoc +++ b/doc/src/examples/imagecomposition.qdoc @@ -29,7 +29,7 @@ \example painting/imagecomposition \title Image Composition Example - The Image Composition example lets the user combine images + \brief The Image Composition example lets the user combine images together using any composition mode supported by QPainter, described in detail in \l{QPainter#Composition Modes}{Composition Modes}. diff --git a/doc/src/examples/imagegestures.qdoc b/doc/src/examples/imagegestures.qdoc index 24a1276..2a8a282 100644 --- a/doc/src/examples/imagegestures.qdoc +++ b/doc/src/examples/imagegestures.qdoc @@ -29,7 +29,7 @@ \example gestures/imagegestures \title Image Gestures Example - This example shows how to enable gestures for a widget and use gesture input + \brief The Image Gestures example shows how to enable gestures for a widget and use gesture input to perform actions. We use two classes to create the user interface for the application: \c MainWidget diff --git a/doc/src/examples/imageviewer.qdoc b/doc/src/examples/imageviewer.qdoc index 49b3111..e915ef8 100644 --- a/doc/src/examples/imageviewer.qdoc +++ b/doc/src/examples/imageviewer.qdoc @@ -29,8 +29,10 @@ \example widgets/imageviewer \title Image Viewer Example - The example shows how to combine QLabel and QScrollArea to - display an image. QLabel is typically used for displaying text, + \brief The Image Viewer example shows how to combine QLabel and QScrollArea to + display an image. + + QLabel is typically used for displaying text, but it can also display an image. QScrollArea provides a scrolling view around another widget. If the child widget exceeds the size of the frame, QScrollArea automatically provides scroll diff --git a/doc/src/examples/inputpanel.qdoc b/doc/src/examples/inputpanel.qdoc index 54920f0..f001aee 100644 --- a/doc/src/examples/inputpanel.qdoc +++ b/doc/src/examples/inputpanel.qdoc @@ -29,7 +29,7 @@ \example tools/inputpanel \title Input Panel Example - The Input Panel example shows how to create an input panel that + \brief The Input Panel example shows how to create an input panel that can be used to input text into widgets using only the pointer and no keyboard. diff --git a/doc/src/examples/itemviewspuzzle.qdoc b/doc/src/examples/itemviewspuzzle.qdoc index 72e543b..22826ec 100644 --- a/doc/src/examples/itemviewspuzzle.qdoc +++ b/doc/src/examples/itemviewspuzzle.qdoc @@ -29,7 +29,7 @@ \example itemviews/puzzle \title Item Views Puzzle Example - The Puzzle example shows how to enable drag and drop with a custom model + \brief The Puzzle example shows how to enable drag and drop with a custom model to allow items to be transferred between a view and another widget. \image itemviewspuzzle-example.png diff --git a/doc/src/examples/licensewizard.qdoc b/doc/src/examples/licensewizard.qdoc index a58e029..e46ea32 100644 --- a/doc/src/examples/licensewizard.qdoc +++ b/doc/src/examples/licensewizard.qdoc @@ -29,7 +29,7 @@ \example dialogs/licensewizard \title License Wizard Example - The License Wizard example shows how to implement complex wizards in + \brief The License Wizard example shows how to implement complex wizards in Qt. \image licensewizard-example.png Screenshot of the License Wizard example diff --git a/doc/src/examples/lighting.qdoc b/doc/src/examples/lighting.qdoc index 815a42a..05c1e79 100644 --- a/doc/src/examples/lighting.qdoc +++ b/doc/src/examples/lighting.qdoc @@ -29,5 +29,7 @@ \example effects/lighting \title Lighting Effect Example + \brief The Lighting Effect Example shows the QGraphicsDropShadowEffect in action. + \image lightingeffect-example.png */ diff --git a/doc/src/examples/lineedits.qdoc b/doc/src/examples/lineedits.qdoc index 03b4f27..c187dfd 100644 --- a/doc/src/examples/lineedits.qdoc +++ b/doc/src/examples/lineedits.qdoc @@ -29,7 +29,7 @@ \example widgets/lineedits \title Line Edits Example - The Line Edits example demonstrates the many ways that QLineEdit can be used, and + \brief The Line Edits example demonstrates the many ways that QLineEdit can be used, and shows the effects of various properties and validators on the input and output supplied by the user. diff --git a/doc/src/examples/localfortuneclient.qdoc b/doc/src/examples/localfortuneclient.qdoc index 56ead19..b7ea65a 100644 --- a/doc/src/examples/localfortuneclient.qdoc +++ b/doc/src/examples/localfortuneclient.qdoc @@ -29,8 +29,10 @@ \example ipc/localfortuneclient \title Local Fortune Client Example - The Local Fortune Client example shows how to create a client for a simple - local service using QLocalSocket. It is intended to be run alongside the + \brief The Local Fortune Client example shows how to create a client for a simple + local service using QLocalSocket. + + The example is intended to be run alongside the \l{ipc/localfortuneserver}{Local Fortune Server} example. \image localfortuneclient-example.png Screenshot of the Local Fortune Client example diff --git a/doc/src/examples/localfortuneserver.qdoc b/doc/src/examples/localfortuneserver.qdoc index 7a26ff8..21c5feb 100644 --- a/doc/src/examples/localfortuneserver.qdoc +++ b/doc/src/examples/localfortuneserver.qdoc @@ -29,8 +29,10 @@ \example ipc/localfortuneserver \title Local Fortune Server Example - The Local Fortune Server example shows how to create a server for a simple - local service. It is intended to be run alongside the + \brief The Local Fortune Server example shows how to create a server for a simple + local service. + + The example is intended to be run alongside the \l{ipc/localfortuneclient}{Local Fortune Client} example \image localfortuneserver-example.png Screenshot of the Local Fortune Server example diff --git a/doc/src/examples/loopback.qdoc b/doc/src/examples/loopback.qdoc index a5d810a..9e87ace 100644 --- a/doc/src/examples/loopback.qdoc +++ b/doc/src/examples/loopback.qdoc @@ -29,7 +29,7 @@ \example network/loopback \title Loopback Example - The Loopback example shows how to communicate between simple clients and servers on a local + \brief The Loopback example shows how to communicate between simple clients and servers on a local host. \image loopback-example.png diff --git a/doc/src/examples/maemovibration.qdoc b/doc/src/examples/maemovibration.qdoc index de53ba4..58a8837 100644 --- a/doc/src/examples/maemovibration.qdoc +++ b/doc/src/examples/maemovibration.qdoc @@ -30,7 +30,7 @@ \group all-examples \title Maemo Vibration Example - The Maemo Vibration example shows how to tell the Maemo Mode Control Entity + \brief The Maemo Vibration example shows how to tell the Maemo Mode Control Entity (MCE) to vibrate a maemo device. The MCE is a system service on Maemo that, among other things, provides an diff --git a/doc/src/examples/mandelbrot.qdoc b/doc/src/examples/mandelbrot.qdoc index eb53e95..3e516e9 100644 --- a/doc/src/examples/mandelbrot.qdoc +++ b/doc/src/examples/mandelbrot.qdoc @@ -29,7 +29,7 @@ \example threads/mandelbrot \title Mandelbrot Example - The Mandelbrot example shows how to use a worker thread to + \brief The Mandelbrot example shows how to use a worker thread to perform heavy computations without blocking the main thread's event loop. diff --git a/doc/src/examples/masterdetail.qdoc b/doc/src/examples/masterdetail.qdoc index 16ddb3e..06bf228 100644 --- a/doc/src/examples/masterdetail.qdoc +++ b/doc/src/examples/masterdetail.qdoc @@ -29,8 +29,10 @@ \example sql/masterdetail \title Master Detail Example - The Master Detail Example shows how to present data from different - data sources in the same application. The album titles, and the + \brief The Master Detail Example shows how to present data from different + data sources in the same application. + + The album titles, and the corresponding artists and release dates, are kept in a database, while each album's tracks are stored in an XML file. diff --git a/doc/src/examples/mdi.qdoc b/doc/src/examples/mdi.qdoc index 4f64fa1..317a251 100644 --- a/doc/src/examples/mdi.qdoc +++ b/doc/src/examples/mdi.qdoc @@ -29,7 +29,7 @@ \example mainwindows/mdi \title MDI Example - The MDI example shows how to implement a Multiple Document Interface using Qt's + \brief The MDI example shows how to implement a Multiple Document Interface using Qt's QMdiArea class. \image mdi-example.png diff --git a/doc/src/examples/menus.qdoc b/doc/src/examples/menus.qdoc index 0a31ca8..f42aa64 100644 --- a/doc/src/examples/menus.qdoc +++ b/doc/src/examples/menus.qdoc @@ -29,7 +29,7 @@ \example mainwindows/menus \title Menus Example - The Menus example demonstrates how menus can be used in a main + \brief The Menus example demonstrates how menus can be used in a main window application. A menu widget can be either a pull-down menu in a menu bar or a diff --git a/doc/src/examples/mousecalibration.qdoc b/doc/src/examples/mousecalibration.qdoc index 590153b..b2f7939 100644 --- a/doc/src/examples/mousecalibration.qdoc +++ b/doc/src/examples/mousecalibration.qdoc @@ -29,7 +29,7 @@ \example qws/mousecalibration \title Mouse Calibration Example - The Mouse Calibration example demonstrates how to write a simple + \brief The Mouse Calibration example demonstrates how to write a simple program using the mechanisms provided by the QWSMouseHandler class to calibrate the mouse handler in \l{Qt for Embedded Linux}. diff --git a/doc/src/examples/moveblocks.qdoc b/doc/src/examples/moveblocks.qdoc index e5ce3be..5acaa47 100644 --- a/doc/src/examples/moveblocks.qdoc +++ b/doc/src/examples/moveblocks.qdoc @@ -29,7 +29,7 @@ \example animation/moveblocks \title Move Blocks Example - The Move Blocks example shows how to animate items in a + \brief The Move Blocks example shows how to animate items in a QGraphicsScene using a QStateMachine with a custom transition. \image moveblocks-example.png diff --git a/doc/src/examples/movie.qdoc b/doc/src/examples/movie.qdoc index bd5726c..4f31674 100644 --- a/doc/src/examples/movie.qdoc +++ b/doc/src/examples/movie.qdoc @@ -29,8 +29,10 @@ \example widgets/movie \title Movie Example - The Movie example demonstrates how to use QMovie and QLabel to - display animations. Now that Qt comes with the \l{Phonon multimedia + \brief The Movie example demonstrates how to use QMovie and QLabel to + display animations. + + Now that Qt comes with the \l{Phonon multimedia framework} {Phonon multimedia framework}, QMovie is mostly useful if one wants to play a simple animation without the added complexity of a multimedia framework to install and deploy. diff --git a/doc/src/examples/multicastreceiver.qdoc b/doc/src/examples/multicastreceiver.qdoc index 1a0f3b5..96a011f 100644 --- a/doc/src/examples/multicastreceiver.qdoc +++ b/doc/src/examples/multicastreceiver.qdoc @@ -29,7 +29,7 @@ \example network/multicastreceiver \title Multicast Receiver Example - The Multicast Receiever example shows how to receive information that is + \brief The Multicast Receiever example shows how to receive information that is sent to a multicast group. \image multicastreceiver-example.png diff --git a/doc/src/examples/multicastsender.qdoc b/doc/src/examples/multicastsender.qdoc index 55b3804..c5b7531 100644 --- a/doc/src/examples/multicastsender.qdoc +++ b/doc/src/examples/multicastsender.qdoc @@ -29,7 +29,7 @@ \example network/multicastsender \title Multicast Sender Example - The Multicast Sender example shows how to send information to multiple + \brief The Multicast Sender example shows how to send information to multiple clients in a multicast group. \image multicastsender-example.png diff --git a/doc/src/examples/multipleinheritance.qdoc b/doc/src/examples/multipleinheritance.qdoc index fa125f0..9c86950 100644 --- a/doc/src/examples/multipleinheritance.qdoc +++ b/doc/src/examples/multipleinheritance.qdoc @@ -29,7 +29,7 @@ \example uitools/multipleinheritance \title Multiple Inheritance Example - The Multiple Inheritance Example shows how to use a form created with \QD + \brief The Multiple Inheritance Example shows how to use a form created with \QD in an application by subclassing both QWidget and the user interface class, which is \c{Ui::CalculatorForm}. diff --git a/doc/src/examples/musicplayerexample.qdoc b/doc/src/examples/musicplayerexample.qdoc index 7cba674..13a7bba 100644 --- a/doc/src/examples/musicplayerexample.qdoc +++ b/doc/src/examples/musicplayerexample.qdoc @@ -29,8 +29,9 @@ \example phonon/qmusicplayer \title Music Player Example - The Music Player Example shows how to use Phonon - the multimedia + \brief The Music Player Example shows how to use Phonon - the multimedia framework that comes with Qt - to create a simple music player. + The player can play music files, and provides simple playback control, such as pausing, stopping, and resuming the music. diff --git a/doc/src/examples/network-chat.qdoc b/doc/src/examples/network-chat.qdoc index bd8288f..b91b9c0 100644 --- a/doc/src/examples/network-chat.qdoc +++ b/doc/src/examples/network-chat.qdoc @@ -29,7 +29,7 @@ \example network/network-chat \title Network Chat Example - The Network Chat example demonstrates a stateful peer-to-peer Chat client + \brief The Network Chat example demonstrates a stateful peer-to-peer Chat client that uses broadcasting with QUdpSocket and QNetworkInterface to discover its peers. diff --git a/doc/src/examples/network-download.qdoc b/doc/src/examples/network-download.qdoc index da86b2a..48dbe10 100644 --- a/doc/src/examples/network-download.qdoc +++ b/doc/src/examples/network-download.qdoc @@ -29,7 +29,7 @@ \example network/download \title Network Download Example - The Network Download example shows how to perform multiple downloads in + \brief The Network Download example shows how to perform multiple downloads in parallel using the QNetworkAccessManager class. This example is designed to be run from the command line. diff --git a/doc/src/examples/network-downloadmanager.qdoc b/doc/src/examples/network-downloadmanager.qdoc index 0fa8cda..501c469 100644 --- a/doc/src/examples/network-downloadmanager.qdoc +++ b/doc/src/examples/network-downloadmanager.qdoc @@ -29,7 +29,7 @@ \example network/downloadmanager \title Network Download Manager Example - The Network Download example shows how to implement a queue for multiple + \brief The Network Download example shows how to implement a queue for multiple downloads using the QNetworkAccessManager class. This example is designed to be run from the command line. diff --git a/doc/src/examples/openvg-star.qdoc b/doc/src/examples/openvg-star.qdoc index 67422ae..2b25dbc 100644 --- a/doc/src/examples/openvg-star.qdoc +++ b/doc/src/examples/openvg-star.qdoc @@ -29,5 +29,5 @@ \example openvg/star \title OpenVG Star Example - The OpenVG Star example demonstrates the use of Qt's OpenVG integration. + \brief The OpenVG Star example demonstrates the use of Qt's OpenVG integration. */ diff --git a/doc/src/examples/orderform.qdoc b/doc/src/examples/orderform.qdoc index ea93d86..8d61143 100644 --- a/doc/src/examples/orderform.qdoc +++ b/doc/src/examples/orderform.qdoc @@ -29,9 +29,10 @@ \example richtext/orderform \title Order Form Example - The Order Form example shows how to generate rich text documents by - combining a simple template with data input by the user in a dialog. Data - is extracted from a \c DetailsDialog object and displayed on a QTextEdit + \brief The Order Form example shows how to generate rich text documents by + combining a simple template with data input by the user in a dialog. + + Data is extracted from a \c DetailsDialog object and displayed on a QTextEdit with a QTextCursor, using various formats. Each form generated is added to a QTabWidget for easy access. diff --git a/doc/src/examples/orientation.qdoc b/doc/src/examples/orientation.qdoc index f55a650..fc9f1c1 100644 --- a/doc/src/examples/orientation.qdoc +++ b/doc/src/examples/orientation.qdoc @@ -29,7 +29,7 @@ \group all-examples \title Orientation Example - The example shows a simple way to use different UIs depending on the screen + \brief The Orientation example shows a simple way to use different UIs depending on the screen orientation of a mobile device. \image orientation-landscape.png The UI in landscape mode diff --git a/doc/src/examples/overpainting.qdoc b/doc/src/examples/overpainting.qdoc index 12f9756..74001fc 100644 --- a/doc/src/examples/overpainting.qdoc +++ b/doc/src/examples/overpainting.qdoc @@ -29,7 +29,7 @@ \example opengl/overpainting \title Overpainting Example - The Overpainting example shows how QPainter can be used + \brief The Overpainting example shows how QPainter can be used to overpaint a scene rendered using OpenGL in a QGLWidget. \image overpainting-example.png diff --git a/doc/src/examples/padnavigator.qdoc b/doc/src/examples/padnavigator.qdoc index 0942c82..111beda 100644 --- a/doc/src/examples/padnavigator.qdoc +++ b/doc/src/examples/padnavigator.qdoc @@ -29,7 +29,7 @@ \example graphicsview/padnavigator \title Pad Navigator Example - The Pad Navigator Example shows how you can use Graphics View together with + \brief The Pad Navigator Example shows how you can use Graphics View together with embedded widgets and Qt's \l{State Machine Framework} to create a simple but useful, dynamic, animated user interface. diff --git a/doc/src/examples/painterpaths.qdoc b/doc/src/examples/painterpaths.qdoc index 2f740b8..04012eb 100644 --- a/doc/src/examples/painterpaths.qdoc +++ b/doc/src/examples/painterpaths.qdoc @@ -29,7 +29,7 @@ \example painting/painterpaths \title Painter Paths Example - The Painter Paths example shows how painter paths can be used to + \brief The Painter Paths example shows how painter paths can be used to build complex shapes for rendering. \image painterpaths-example.png diff --git a/doc/src/examples/pbuffers.qdoc b/doc/src/examples/pbuffers.qdoc index 0c496b4..1c31994 100644 --- a/doc/src/examples/pbuffers.qdoc +++ b/doc/src/examples/pbuffers.qdoc @@ -29,7 +29,7 @@ \example opengl/pbuffers \title Pixel Buffers Example - The Pixel Buffers example demonstrates how to use the + \brief The Pixel Buffers example demonstrates how to use the QGLPixelBuffer class to render into an off-screen buffer and use the contents as a dynamic texture in a QGLWidget. diff --git a/doc/src/examples/pbuffers2.qdoc b/doc/src/examples/pbuffers2.qdoc index 280f329..4827b86 100644 --- a/doc/src/examples/pbuffers2.qdoc +++ b/doc/src/examples/pbuffers2.qdoc @@ -29,7 +29,7 @@ \example opengl/pbuffers2 \title Pixel Buffers 2 Example - The Pixel Buffers 2 example demonstrates how to use the + \brief The Pixel Buffers 2 example demonstrates how to use the QGLPixelBuffer class to render into an off-screen buffer and use the contents as a dynamic texture in a QGLWidget. diff --git a/doc/src/examples/pinchzoom.qdoc b/doc/src/examples/pinchzoom.qdoc index 04a8bb4..540d54c 100644 --- a/doc/src/examples/pinchzoom.qdoc +++ b/doc/src/examples/pinchzoom.qdoc @@ -29,7 +29,7 @@ \example touch/pinchzoom \title Pinch Zoom Example - The Pinch Zoom example shows how to use low-level touch information + \brief The Pinch Zoom example shows how to use low-level touch information to recognize a gesture. \image touch-pinchzoom-example.png diff --git a/doc/src/examples/pingpong.qdoc b/doc/src/examples/pingpong.qdoc index c4a29a4..a90db94 100644 --- a/doc/src/examples/pingpong.qdoc +++ b/doc/src/examples/pingpong.qdoc @@ -29,7 +29,7 @@ \example statemachine/pingpong \title Ping Pong States Example - The Ping Pong States example shows how to use parallel states together + \brief The Ping Pong States example shows how to use parallel states together with custom events and transitions in \l{The State Machine Framework}. This example implements a statechart where two states communicate by diff --git a/doc/src/examples/pixelator.qdoc b/doc/src/examples/pixelator.qdoc index b6d1fd6..50e79da 100644 --- a/doc/src/examples/pixelator.qdoc +++ b/doc/src/examples/pixelator.qdoc @@ -29,7 +29,7 @@ \example itemviews/pixelator \title Pixelator Example - The Pixelator example shows how delegates can be used to customize the way that + \brief The Pixelator example shows how delegates can be used to customize the way that items are rendered in standard item views. \image pixelator-example.png diff --git a/doc/src/examples/plugandpaint.qdoc b/doc/src/examples/plugandpaint.qdoc index 2a9d286..960ec8c 100644 --- a/doc/src/examples/plugandpaint.qdoc +++ b/doc/src/examples/plugandpaint.qdoc @@ -29,7 +29,7 @@ \example tools/plugandpaint \title Plug & Paint Example - The Plug & Paint example demonstrates how to write Qt + \brief The Plug & Paint example demonstrates how to write Qt applications that can be extended through plugins. \image plugandpaint.png Screenshot of the Plug & Paint example diff --git a/doc/src/examples/portedasteroids.qdoc b/doc/src/examples/portedasteroids.qdoc index 06428bf..3fa0793 100644 --- a/doc/src/examples/portedasteroids.qdoc +++ b/doc/src/examples/portedasteroids.qdoc @@ -29,7 +29,7 @@ \example graphicsview/portedasteroids \title Ported Asteroids Example - The Ported Asteroids example is a port of the + \brief The Ported Asteroids example is a port of the Asteroids game, which was based on QCanvas, to the Graphics View framework. diff --git a/doc/src/examples/portedcanvas.qdoc b/doc/src/examples/portedcanvas.qdoc index 49824de..457d6b3 100644 --- a/doc/src/examples/portedcanvas.qdoc +++ b/doc/src/examples/portedcanvas.qdoc @@ -29,7 +29,7 @@ \example graphicsview/portedcanvas \title Ported Canvas Example - The Ported Canvas example is a port of the old + \brief The Ported Canvas example is a port of the old QCanvas example from Qt 3 to the Graphics View framework. \sa {Porting to Graphics View} diff --git a/doc/src/examples/previewer.qdoc b/doc/src/examples/previewer.qdoc index 2fe8d8d..128d3be 100644 --- a/doc/src/examples/previewer.qdoc +++ b/doc/src/examples/previewer.qdoc @@ -29,7 +29,7 @@ \example webkit/previewer \title Previewer Example - The Previewer example shows how to use QtWebKit's QWebView to preview + \brief The Previewer example shows how to use QtWebKit's QWebView to preview HTML data written in a QPlainTextEdit. \image previewer-example.png @@ -164,4 +164,4 @@ \snippet examples/webkit/previewer/main.cpp 0 -*/
\ No newline at end of file +*/ diff --git a/doc/src/examples/qml-calculator.qdoc b/doc/src/examples/qml-calculator.qdoc index 0624cb4..96efe26 100644 --- a/doc/src/examples/qml-calculator.qdoc +++ b/doc/src/examples/qml-calculator.qdoc @@ -28,8 +28,9 @@ /*! \title Calculator \example demos/declarative/calculator + \depends helper/qmlapplicationviewer - This demo shows how to write a simple calculator application in QML and JavaScript. + \brief The Qt Quick Calculator demo shows how to write a simple calculator application in QML and JavaScript. \image qml-calculator-example.png */ diff --git a/doc/src/examples/qml-examples.qdoc b/doc/src/examples/qml-examples.qdoc index a910266..f8c59f3 100644 --- a/doc/src/examples/qml-examples.qdoc +++ b/doc/src/examples/qml-examples.qdoc @@ -27,16 +27,25 @@ /*! \title Animation: Basics Example - \example declarative/animation/basics - - This example shows how to create and combine \l{QML Animation and Transitions}{animations} in QML. + \example declarative/animation/basics/color-animation + \depends helper/qmlapplicationviewer + + \brief This example shows how to create and combine \l{QML Animation}{animations} in QML. \table \row \o \image qml-coloranim-example.png \row \o color-animation.qml - \endtable + \endtable +*/ + +/*! + \title Animation: Basics Property Animation Example + \example declarative/animation/basics/property-animation + \depends helper/qmlapplicationviewer + + \brief This example shows how to create and combine \l{QML Animation}{animations} in QML. \table \row @@ -47,19 +56,30 @@ */ /*! - \title Animation: Behavior Examples - \example declarative/animation/behaviors + \title Animation: Behavior Example + \example declarative/animation/behaviors/behavior-example + \depends helper/qmlapplicationviewer - This example shows how to use QML behaviors. + \brief This example shows how to use QML behaviors. \image qml-behaviors-example.png */ /*! + \title Animation: Wiggly Text Example + \example declarative/animation/behaviors/wigglytext + \depends helper/qmlapplicationviewer + + \brief This example shows how to animate text. + +*/ + +/*! \title Animation: Easing Example \example declarative/animation/easing + \depends helper/qmlapplicationviewer - This example shows the different easing modes available for \l{QML Animation and Transitions}{animations}. + \brief This example shows the different easing modes available for \l{QML Animation}{animations}. \image qml-easing-example.png */ @@ -68,11 +88,16 @@ \title Animation: States Example \example declarative/animation/states - These examples show how to use \l{State}{states} and \l{Transition}{transitions}. + \brief These examples show how to use states and transitions. + + \depends helper/qmlapplicationviewer The \c states.qml example shows how an item can change between states, and \c transitions.qml shows how these state changes can be animated. + \note Due to deployment configurations transitions.qml is opened by default when running this example. + states.qml can be opened by editing the main.cpp file. + \table \row \o \image qml-states-example.png @@ -92,7 +117,9 @@ \title Image Elements: Border Image Example \example declarative/imageelements/borderimage - These examples show how to use the BorderImage element. + \brief These examples show how to use the BorderImage element. + + \depends helper/qmlapplicationviewer \table \row @@ -100,6 +127,14 @@ \row \o borderimage.qml \endtable +*/ + +/*! + \title Image Elements: Shadows Image Example + \example declarative/imageelements/shadows + \depends helper/qmlapplicationviewer + + \brief This example shows how to use the BorderImage element. \table \row @@ -112,8 +147,10 @@ /*! \title Image Elements: Image Example \example declarative/imageelements/image + \depends helper/qmlapplicationviewer + + \brief This example shows how to use the \l Image element and its \l{Image::fillMode}{fillModes}. - This example shows how to use the \l Image element and its \l{Image::fillMode}{fillModes}. \image qml-image-example.png */ @@ -122,8 +159,8 @@ \page declarative-cppextensions-reference.html \title C++ Extensions: Reference examples - These examples show how QML can be extended from C++ in various ways. - + \brief These examples show how QML can be extended from C++ in various ways. + The code for these examples is used throughout the \l {Extending QML Functionalities using C++} reference documentation, which highlights the main principles demonstrated in each example. @@ -151,7 +188,7 @@ \title C++ Extensions: Plugins Example \example declarative/cppextensions/plugins - This example shows how to create a C++ plugin extension by subclassing QDeclarativeExtensionPlugin. + \brief This example shows how to create a C++ plugin extension by subclassing QDeclarativeExtensionPlugin. \image qml-plugins-example.png */ @@ -160,7 +197,7 @@ \title LayoutItem Example \example declarative/cppextensions/qgraphicslayouts/layoutitem - This example show how to use the LayoutItem element to integrate QML items into an existing + \brief This example show how to use the LayoutItem element to integrate QML items into an existing \l{Graphics View Framework}{Graphics View}-based application. \image qml-layoutitem-example.png @@ -169,7 +206,7 @@ \title QGraphicsGridLayout Example \example declarative/cppextensions/qgraphicslayouts/qgraphicsgridlayout - This example shows how to use QGraphicsGridLayout to lay out QML items. This is + \brief This example shows how to use QGraphicsGridLayout to lay out QML items. This is useful if you need to integrate Qt \l{Graphics View Framework}{Graphics View} layouts with QML. @@ -179,7 +216,7 @@ \title QGraphicsLinearLayout Example \example declarative/cppextensions/qgraphicslayouts/qgraphicslinearlayout - This example shows how to use QGraphicsLinearLayout to lay out QML items. This is + \brief This example shows how to use QGraphicsLinearLayout to lay out QML items. This is useful if you need to integrate Qt \l{Graphics View Framework}{Graphics View} layouts with QML. @@ -189,7 +226,7 @@ \title C++ Extensions: QGraphicsLayouts examples \page declarative-cppextensions-qgraphicslayouts.html - These examples show how to integrate \l{Graphics View Framework}{Graphics View} + \brief These examples show how to integrate \l{Graphics View Framework}{Graphics View} layout components with QML: \list @@ -206,7 +243,7 @@ \title C++ Extensions: QWidgets Example \example declarative/cppextensions/qwidgets - This example shows how to embed QWidget-based objects into QML using QGraphicsProxyWidget. + \brief This example shows how to embed QWidget-based objects into QML using QGraphicsProxyWidget. \image qml-qwidgets-example.png */ @@ -215,7 +252,7 @@ \title C++ Extensions: Image Provider Example \example declarative/cppextensions/imageprovider - This examples shows how to use QDeclarativeImageProvider to serve images + \brief This examples shows how to use QDeclarativeImageProvider to serve images to QML image elements. \image qml-imageprovider-example.png @@ -225,7 +262,7 @@ \title C++ Extensions: Network Access Manager Factory Example \example declarative/cppextensions/networkaccessmanagerfactory - This example shows how to use QDeclarativeNetworkAccessManagerFactory to create a QNetworkAccessManager + \brief This example shows how to use QDeclarativeNetworkAccessManagerFactory to create a QNetworkAccessManager with a proxy. */ @@ -233,8 +270,9 @@ \title Internationalization Example \example declarative/i18n \ingroup internationalization + \depends helper/qmlapplicationviewer - This example shows how to enable text translation in QML. + \brief This example shows how to enable text translation in QML. \image qml-i18n-example.png @@ -273,10 +311,13 @@ /*! \title Right-to-left User Interfaces: Text Alignment Example \example declarative/righttoleft/textalignment + \depends helper/qmlapplicationviewer - This example shows how the horizontal alignment of \l Text, + \brief This example shows how the horizontal alignment of \l Text, \l TextInput and \l TextEdit is affected by the reading direction - of the text and by the layout mirrroring. Click on the gray buttons + of the text and by the layout mirrroring. + + Click on the gray buttons shown at the bottom of the example to toggle between different horizontal alignment options. @@ -286,10 +327,13 @@ /*! \title Right-to-left User Interfaces: Layout Direction Example \example declarative/righttoleft/layoutdirection + \depends helper/qmlapplicationviewer - This example shows how to control the horizontal layout direction of + \ brief This example shows how to control the horizontal layout direction of \l Row, \l Grid and \l Flow positioners, and \l ListView and \l GridView - model views. Click on the gray buttons shown at the bottom of the example + model views. + + Click on the gray buttons shown at the bottom of the example to toggle the layout direction of the shown elements. \image qml-righttoleft-layoutdirection-example.png @@ -301,11 +345,13 @@ /*! \title Right-to-left User Interfaces: Layout Mirroring Example \example declarative/righttoleft/layoutmirroring + \depends helper/qmlapplicationviewer + + \brief This example shows how to mirror the application layouts + using \l LayoutMirroring attached property. - This example shows how to mirror the application layouts - using \l LayoutMirroring attached property. Click on the grey button - shown at the bottom of the example to enable or disable the - layout mirroring. + Click on the grey button shown at the bottom of the example to + enable or disable the layout mirroring. \image qml-righttoleft-layoutmirroring-example.png @@ -315,8 +361,9 @@ /*! \title Positioners Example \example declarative/positioners + \depends helper/qmlapplicationviewer - This example shows how to use the positioner elements such as \l Row, \l Column, + \brief This example shows how to use positioner elements such as \l Row, \l Column, \l Grid and \l Flow. \image qml-positioners-example.png @@ -325,8 +372,9 @@ /*! \title Key Interaction: Focus Example \example declarative/keyinteraction/focus + \depends helper/qmlapplicationviewer - This example shows how to handle keyboard input and focus in QML. + \brief This example shows how to handle keyboard input and focus in QML. \image qml-focus-example.png */ @@ -334,8 +382,9 @@ /*! \title Models and Views: AbstractItemModel Example \example declarative/modelviews/abstractitemmodel + \depends helper/qmlapplicationviewer - This example shows how to use a QAbstractItemModel subclass as a model in QML. + \brief This example shows how to use a QAbstractItemModel subclass as a model in QML. \image qml-abstractitemmodel-example.png */ @@ -343,17 +392,35 @@ /*! \title Models and Views: GridView Example \example declarative/modelviews/gridview + \depends helper/qmlapplicationviewer - This example shows how to use the GridView element. + \brief This example shows how to use the GridView element. \image qml-gridview-example.png */ /*! - \title Models and Views: ListView Example - \example declarative/modelviews/listview + \title Models and Views: ListView Examples + \page qml-listview-examples.html + + \list + \o \l {Models and Views: Dynamic List ListView Example} + \o \l {Models and Views: Expanding Delegate ListView Example} + \o \l {Models and Views: Highlight ListView Example} + \o \l {Models and Views: Highlight Ranges ListView Example} + \o \l {Models and Views: Sections ListView Example} + \endlist + +*/ + +/*! + \title Models and Views: Dynamic List ListView Example + \example declarative/modelviews/listview/dynamiclist + \depends helper/qmlapplicationviewer - These examples show how to use the ListView element. + \brief This example shows how items can be dynamically added to + and removed from a ListModel, and how these list + modifications can be animated. \table \row @@ -361,6 +428,15 @@ \row \o dynamiclist.qml \endtable +*/ + +/*! + \title Models and Views: Expanding Delegate ListView Example + \example declarative/modelviews/listview/expandingdelegates + \depends helper/qmlapplicationviewer + + \brief This example shows how to create a dynamic delegate, which + expands when selected. \table \row @@ -368,6 +444,16 @@ \row \o expandingdelegates.qml \endtable +*/ + +/*! + \title Models and Views: Highlight ListView Example + \example declarative/modelviews/listview/highlight + \depends helper/qmlapplicationviewer + + + \brief This example shows how to highlight one item + inside a ListView element. \table \row @@ -375,6 +461,16 @@ \row \o highlight.qml \endtable +*/ + +/*! + \title Models and Views: Highlight Ranges ListView Example + \example declarative/modelviews/listview/highlightranges + \depends helper/qmlapplicationviewer + + + \brief This example shows how to highlight ranges within a + ListView element. \table \row @@ -382,6 +478,15 @@ \row \o highlightranges.qml \endtable +*/ + +/*! + \title Models and Views: Sections ListView Example + \example declarative/modelviews/listview/sections + \depends helper/qmlapplicationviewer + + + \brief This example shows how to use the ListView element. \table \row @@ -394,8 +499,9 @@ /*! \title Models and Views: PathView Example \example declarative/modelviews/pathview + \depends helper/qmlapplicationviewer - This example shows how to use the PathView element. + \brief This example shows how to use the PathView element. \image qml-pathview-example.png */ @@ -403,8 +509,9 @@ /*! \title Models and Views: Object ListModel Example \example declarative/modelviews/objectlistmodel + \depends helper/qmlapplicationviewer - This example shows how to use a QList<QObject*> as a model in QML. + \brief This example shows how to use a QList<QObject*> as a model in QML. \image qml-objectlistmodel-example.png */ @@ -412,8 +519,9 @@ /*! \title Models and Views: Package Example \example declarative/modelviews/package + \depends helper/qmlapplicationviewer - This example shows how to use the \l Package element. + \brief This example shows how to use the \l Package element. \image qml-package-example.png */ @@ -421,8 +529,9 @@ /*! \title Models and Views: Parallax Example \example declarative/modelviews/parallax + \depends helper/qmlapplicationviewer - This example shows how to combine and switch between views. + \brief This example shows how to combine and switch between views. \image qml-parallax-example.png */ @@ -430,8 +539,9 @@ /*! \title Models and Views: String ListModel Example \example declarative/modelviews/stringlistmodel + \depends helper/qmlapplicationviewer - This example shows how to use a QStringList as a model in QML. + \brief This example shows how to use a QStringList as a model in QML. \image qml-stringlistmodel-example.png */ @@ -439,17 +549,35 @@ /*! \title Models and Views: VisualItemModel Example \example declarative/modelviews/visualitemmodel + \depends helper/qmlapplicationviewer - This example shows how to use the VisualItemModel element. + \brief This example shows how to use the VisualItemModel element. \image qml-visualitemmodel-example.png */ /*! - \title Models and Views: WebView Example - \example declarative/modelviews/webview + \title Models and Views: WebView Examples + \page qml-webview-examples.html + + \brief These examples show how to use the WebView element. + + \list + \o \l {Models and Views: Alert WebView Example} + \o \l {Models and Views: Autosize WebView Example} + \o \l {Models and Views: GoogleMaps WebView Example} + \o \l {Models and Views: Inline HTML WebView Example} + \o \l {Models and Views: New Windows WebView Example} + \endlist - These examples show how to use the WebView element. + +*/ +/*! + \title Models and Views: Alert WebView Example + \example declarative/modelviews/webview/alerts + \depends helper/qmlapplicationviewer + + \brief This example shows how to create an alert in the WebView element. \table \row @@ -457,6 +585,14 @@ \row \o alert.qml \endtable +*/ + +/*! + \title Models and Views: Autosize WebView Example + \example declarative/modelviews/webview/autosize + \depends helper/qmlapplicationviewer + + \brief This example show how to use autosizing in the WebView element. \table \row @@ -464,6 +600,14 @@ \row \o autosize.qml \endtable +*/ + +/*! + \title Models and Views: GoogleMaps WebView Example + \example declarative/modelviews/webview/googlemaps + \depends helper/qmlapplicationviewer + + \brief This example shows how to use a web service API and the WebView element. \table \row @@ -471,6 +615,14 @@ \row \o googlemaps.qml \endtable +*/ + +/*! + \title Models and Views: Inline HTML WebView Example + \example declarative/modelviews/webview/inlinehtml + \depends helper/qmlapplicationviewer + + \brief This example shows how to use inline HTML with the WebView element. \table \row @@ -478,6 +630,14 @@ \row \o inlinehtml.qml \endtable +*/ + +/*! + \title Models and Views: New Windows WebView Example + \example declarative/modelviews/webview/newwindows + \depends helper/qmlapplicationviewer + + \brief These examples show how to create new windows in the WebView element. \table \row @@ -487,27 +647,28 @@ \endtable */ - /*! \title Screen Orientation \example declarative/screenorientation + \depends helper/qmlapplicationviewer - This example shows how to implement screen orientation support for your application. + \brief This example shows how to implement screen orientation support for your application. */ /*! \title SQL Local Storage Example \example declarative/sqllocalstorage + \depends helper/qmlapplicationviewer - This example shows how to use the SQL Local Storage API in QML. + \brief This example shows how to use the SQL Local Storage API in QML. */ /*! \title Text: Fonts Example \example declarative/text/fonts + \depends helper/qmlapplicationviewer - These examples show how to discover available fonts from QML and manipulate - text in various ways. + \brief These examples show how to discover available fonts from QML. \table \row @@ -515,6 +676,14 @@ \row \o availableFonts.qml \endtable +*/ + +/*! + \title Text: Banner Fonts Example + \example declarative/text/fonts/banner + \depends helper/qmlapplicationviewer + + \brief These example shows how to manipulate text in various ways. \table \row @@ -522,6 +691,14 @@ \row \o banner.qml \endtable +*/ + +/*! + \title Text: Fonts Example + \example declarative/text/fonts/fonts + \depends helper/qmlapplicationviewer + + \brief These examples shows how to display a text with multiple fonts. \table \row @@ -529,6 +706,14 @@ \row \o fonts.qml \endtable +*/ + +/*! + \title Text: Hello Fonts Example + \example declarative/text/fonts/hello + \depends helper/qmlapplicationviewer + + \brief This example shows how to manipulate text in various ways. \table \row @@ -541,8 +726,9 @@ /*! \title Text: Text Selection Example \example declarative/text/textselection + \depends helper/qmlapplicationviewer - This example shows how text selection, copy and paste operations + \brief This example shows how text selection, copy and paste operations can be implemented on top of the TextEdit element. \image qml-textselection-example.png @@ -551,24 +737,28 @@ /*! \title Threading: Threaded ListModel Example \example declarative/threading/threadedlistmodel + \depends helper/qmlapplicationviewer - This example shows how to use a ListModel from multiple threads using + \brief This example shows how to use a ListModel from multiple threads using WorkerScript. */ /*! \title Threading: WorkerScript Example \example declarative/threading/workerscript + \depends helper/qmlapplicationviewer - This example shows how to use the WorkerScript element for threading in QML. + \brief This example shows how to use the WorkerScript element for threading in QML. */ /*! \title Toys: Clocks Example \example declarative/toys/clocks + \depends helper/qmlapplicationviewer - This example displays a set of clocks with different times for different cities. - Each clock is created by combining \l Image elements with \l Rotation transforms + \brief This example displays a set of clocks with different times for different cities. + + Each clock is created by combining \l Image elements with \l Rotation transforms and \l SpringAnimation behaviors. \image qml-clocks-example.png @@ -577,8 +767,9 @@ /*! \title Toys: Corkboards Example \example declarative/toys/corkboards + \depends helper/qmlapplicationviewer - This example presents a flickable set of interactive corkboards. It is created + \brief This example presents a flickable set of interactive corkboards. It is created through a combination of elements like \l ListModel, \l Repeater and \l TextEdit together with rotation and scaling transforms, animation and mouse interaction. @@ -588,8 +779,9 @@ /*! \title Toys: Dynamic Scene Example \example declarative/toys/dynamicscene + \depends helper/qmlapplicationviewer - This example presents an interactive drag-and-drop scene. It demonstrates + \brief This example presents an interactive drag-and-drop scene. It demonstrates how to use QML's \l{Dynamic Object Creation} support to dynamically create and destroy objects. @@ -599,8 +791,9 @@ /*! \title Toys: Tic-Tac-Toe Example \example declarative/toys/tic-tac-toe + \depends helper/qmlapplicationviewer - This example presents a simple implementation of Tic Tac Toe. + \brief This example presents a simple implementation of Tic Tac Toe. \image qml-tic-tac-toe-example.png */ @@ -608,18 +801,28 @@ /*! \title Toys: TV Tennis Example \example declarative/toys/tvtennis + \depends helper/qmlapplicationviewer - This example shows how to use animation components such as \l SpringAnimation, + \brief This example shows how to use animation components such as \l SpringAnimation, \l SequentialAnimation and \l PropertyAction to create a game of TV tennis. \image qml-tvtennis-example.png */ /*! + \title Touch Interaction: Gestures Example + \example declarative/touchinteraction/gestures + \depends helper/qmlapplicationviewer + + \brief This example shows how to use the GestureArea element. +*/ + +/*! \title Touch Interaction: MouseArea Example \example declarative/touchinteraction/mousearea + \depends helper/qmlapplicationviewer - This example shows how to use the MouseArea element to access information + \brief This example shows how to use the MouseArea element to access information about mouse input. \image qml-mousearea-example.png @@ -628,8 +831,9 @@ /*! \title UI Components: Dial Control Example \example declarative/ui-components/dialcontrol + \depends helper/qmlapplicationviewer - This example shows how to create a dial-type control. It combines + \brief This example shows how to create a dial-type control. It combines \l Image elements with \l Rotation transforms and \l SpringAnimation behaviors to produce an interactive speedometer-type dial. @@ -640,8 +844,9 @@ /*! \title UI Components: Flipable Example \example declarative/ui-components/flipable + \depends helper/qmlapplicationviewer - This example shows how to use the \l Flipable element. + \brief This example shows how to use the \l Flipable element. \image qml-flipable-example.png */ @@ -649,8 +854,9 @@ /*! \title UI Components: Progress Bars Example \example declarative/ui-components/progressbar + \depends helper/qmlapplicationviewer - This example shows how to create a progress bar. + \brief This example shows how to create a progress bar. \image qml-progressbar-example.png */ @@ -658,8 +864,9 @@ /*! \title UI Components: Scroll Bar Example \example declarative/ui-components/scrollbar + \depends helper/qmlapplicationviewer - This example shows how to create scroll bars for a \l Flickable element + \brief This example shows how to create scroll bars for a \l Flickable element using the \l {Flickable::visibleArea.xPosition}{Flickable::visibleArea} properties. @@ -669,8 +876,9 @@ /*! \title UI Components: Search Box Example \example declarative/ui-components/searchbox + \depends helper/qmlapplicationviewer - This example shows how to combine TextInput, FocusScope and BorderImage + \brief This example shows how to combine TextInput, FocusScope and BorderImage elements to display multiple text input fields. \image qml-searchbox-example.png @@ -679,8 +887,9 @@ /*! \title UI Components: Slide Switch Example \example declarative/ui-components/slideswitch + \depends helper/qmlapplicationviewer - This example shows how to create a slide switch control. + \brief This example shows how to create a slide switch control. \image qml-slideswitch-example.png */ @@ -688,8 +897,9 @@ /*! \title UI Components: Spinner Example \example declarative/ui-components/spinner + \depends helper/qmlapplicationviewer - This example shows how to create a spinner-type component using the PathView element. + \brief This example shows how to create a spinner-type component using the PathView element. \image qml-spinner-example.png */ @@ -697,8 +907,9 @@ /*! \title UI Components: Tab Widget Example \example declarative/ui-components/tabwidget + \depends helper/qmlapplicationviewer - This example shows how to create a tab widget. It also demonstrates how + \brief This example shows how to create a tab widget. It also demonstrates how \l {Property aliases}{property aliases} and \l {Introduction to the QML Language#Default Properties}{default properties} can be used to collect and assemble the child items declared within an \l Item. @@ -709,8 +920,9 @@ /*! \title XML: XMLHttpRequest Example \example declarative/xml/xmlhttprequest + \depends helper/qmlapplicationviewer - This example shows how to use the \l XmlHttpRequest API in QML. + \brief This example shows how to use the \l XmlHttpRequest API in QML. \image qml-xmlhttprequest-example.png */ @@ -718,8 +930,9 @@ /*! \title Labs: Shader Effects \example declarative/shadereffects + \depends helper/qmlapplicationviewer - This example shows how to create visual effects by using OpenGL shading language together with QML using \l ShaderEffectItem and \l ShaderEffectSource APIs. + \brief This example shows how to create visual effects by using OpenGL shading language together with QML using \l ShaderEffectItem and \l ShaderEffectSource APIs. \image qml-shadereffects-example.png */ diff --git a/doc/src/examples/qml-extending.qdoc b/doc/src/examples/qml-extending.qdoc index 8dbbe7f..da7ab47 100644 --- a/doc/src/examples/qml-extending.qdoc +++ b/doc/src/examples/qml-extending.qdoc @@ -29,7 +29,8 @@ \example declarative/cppextensions/referenceexamples/adding \title Extending QML - Adding Types Example -The Adding Types Example shows how to add a new element type, \c Person, to QML. +\brief The Adding Types Example shows how to add a new element type, \c Person, to QML. + The \c Person type can be used from QML like this: \snippet examples/declarative/cppextensions/referenceexamples/adding/example.qml 0 diff --git a/doc/src/examples/qml-flickr.qdoc b/doc/src/examples/qml-flickr.qdoc index c23c0ba..6f59451 100644 --- a/doc/src/examples/qml-flickr.qdoc +++ b/doc/src/examples/qml-flickr.qdoc @@ -29,7 +29,9 @@ \title Flickr Mobile \example demos/declarative/flickr - This demo shows how to write a mobile Flickr browser application in QML. + \brief The Qt Quick Flickr Mobile demo shows how to write a mobile Flickr browser application in QML. + + \depends helper/qmlapplicationviewer \image qml-flickr-demo.png */ diff --git a/doc/src/examples/qml-folderlistmodel.qdoc b/doc/src/examples/qml-folderlistmodel.qdoc index ed92c9d..a1adc8a 100644 --- a/doc/src/examples/qml-folderlistmodel.qdoc +++ b/doc/src/examples/qml-folderlistmodel.qdoc @@ -29,8 +29,11 @@ \title FolderListModel - a C++ model plugin \example src/imports/folderlistmodel +\depends helper/qmlapplicationviewer -This plugin shows how to make a C++ model available to QML. It presents +\brief The FolderListModel plugin example shows how to make a C++ model available to QML. + +It presents a simple file list for a single folder (directory) and allows the presented folder to be changed. diff --git a/doc/src/examples/qml-minehunt.qdoc b/doc/src/examples/qml-minehunt.qdoc index ac13456..3f24c83 100644 --- a/doc/src/examples/qml-minehunt.qdoc +++ b/doc/src/examples/qml-minehunt.qdoc @@ -28,8 +28,9 @@ /*! \title Minehunt \example demos/declarative/minehunt + \depends helper/qmlapplicationviewer - This demo shows how to create a simple Minehunt game, using QML for the + \brief The Qt Quick Minehunt demo shows how to create a simple Minehunt game, using QML for the UI and C++ for the game logic. \image qml-minehunt-demo.png diff --git a/doc/src/examples/qml-photoviewer.qdoc b/doc/src/examples/qml-photoviewer.qdoc index 5ecbf84..5fc02c4 100644 --- a/doc/src/examples/qml-photoviewer.qdoc +++ b/doc/src/examples/qml-photoviewer.qdoc @@ -28,8 +28,9 @@ /*! \title Photo Viewer \example demos/declarative/photoviewer + \depends helper/qmlapplicationviewer - This demo shows how to write a Flickr photo viewer application in QML. + \brief The Qt Quick Photo Viewer demo shows how to write a Flickr photo viewer application in QML. \image qml-photoviewer-demo.png */ diff --git a/doc/src/examples/qml-rssnews.qdoc b/doc/src/examples/qml-rssnews.qdoc index beea4d3..46cc9fc 100644 --- a/doc/src/examples/qml-rssnews.qdoc +++ b/doc/src/examples/qml-rssnews.qdoc @@ -28,8 +28,9 @@ /*! \title RSS News \example demos/declarative/rssnews + \depends helper/qmlapplicationviewer - This demo shows how to write a RSS news reader in QML. + \brief The Qt Quick RSS News demo shows how to write a RSS news reader in QML. \image qml-rssnews-demo.png */ diff --git a/doc/src/examples/qml-samegame.qdoc b/doc/src/examples/qml-samegame.qdoc index 81a26a3..3ffed3b 100644 --- a/doc/src/examples/qml-samegame.qdoc +++ b/doc/src/examples/qml-samegame.qdoc @@ -28,8 +28,9 @@ /*! \title Same Game \example demos/declarative/samegame + \depends helper/qmlapplicationviewer - This demo shows how to write a 'Same Game' game in QML, using Javascript + \brief The Qt Quick Same Game demo shows how to write a 'Same Game' game in QML, using Javascript for all the game logic. \image qml-samegame-demo.png diff --git a/doc/src/examples/qml-snake.qdoc b/doc/src/examples/qml-snake.qdoc index bce0e71..0fa5bfb 100644 --- a/doc/src/examples/qml-snake.qdoc +++ b/doc/src/examples/qml-snake.qdoc @@ -28,8 +28,9 @@ /*! \title Snake \example demos/declarative/snake + \depends helper/qmlapplicationviewer - This demo shows how to write a Snake game in QML, controlled by the + \brief The Qt Quick Snake demo shows how to write a Snake game in QML, controlled by the keyboard as well as the mouse. \image qml-snake-demo.png diff --git a/doc/src/examples/qml-twitter.qdoc b/doc/src/examples/qml-twitter.qdoc index 3ebabb4..073dd64 100644 --- a/doc/src/examples/qml-twitter.qdoc +++ b/doc/src/examples/qml-twitter.qdoc @@ -28,9 +28,10 @@ /*! \title Twitter Mobile \example demos/declarative/twitter + \depends helper/qmlapplicationviewer - This demo shows how to write a mobile Twitter search client in QML. Use it to - see what people think about Qt Quick! + \brief The Qt Quick Twitter Mobile demo shows how to write a mobile Twitter search client in QML. + Use it to see what people think about Qt Quick! \image qml-twitter-demo.png */ diff --git a/doc/src/examples/qml-webbrowser.qdoc b/doc/src/examples/qml-webbrowser.qdoc index 08416af..fc9d47f 100644 --- a/doc/src/examples/qml-webbrowser.qdoc +++ b/doc/src/examples/qml-webbrowser.qdoc @@ -26,10 +26,11 @@ ****************************************************************************/ /*! - \title QML Web Browser + \title Qt Quick Web Browser \example demos/declarative/webbrowser + \depends helper/qmlapplicationviewer - This demo shows how to write a simple web browser in QML by combining the + \brief The Qt Quick Web Browser demo shows how to write a simple web browser in QML by combining the WebView element with other components including scroll bars, \l Flickable views and TextInput fields. diff --git a/doc/src/examples/qobjectxmlmodel.qdoc b/doc/src/examples/qobjectxmlmodel.qdoc index a950f72..6f66e70 100644 --- a/doc/src/examples/qobjectxmlmodel.qdoc +++ b/doc/src/examples/qobjectxmlmodel.qdoc @@ -29,7 +29,7 @@ \example xmlpatterns/qobjectxmlmodel \title QObject XML Model Example - This example shows how to use QtXmlPatterns to query QObject trees + \brief The XML Model example shows how to use QtXmlPatterns to query QObject trees by modeling the non-XML data structure of a QObject tree to look like XML. diff --git a/doc/src/examples/qtconcurrent-imagescaling.qdoc b/doc/src/examples/qtconcurrent-imagescaling.qdoc index 1b3c6d6..15f2dab 100644 --- a/doc/src/examples/qtconcurrent-imagescaling.qdoc +++ b/doc/src/examples/qtconcurrent-imagescaling.qdoc @@ -29,6 +29,6 @@ \example qtconcurrent/imagescaling \title QtConcurrent Image Scaling Example - The QtConcurrent Map example shows how to use the asynchronous + \brief The QtConcurrent Image Scaling example shows how to use the asynchronous QtConcurrent API to load and scale a collection of images. */ diff --git a/doc/src/examples/qtconcurrent-map.qdoc b/doc/src/examples/qtconcurrent-map.qdoc index 76a6f13..6b22966 100644 --- a/doc/src/examples/qtconcurrent-map.qdoc +++ b/doc/src/examples/qtconcurrent-map.qdoc @@ -29,6 +29,6 @@ \example qtconcurrent/map \title QtConcurrent Map Example - The QtConcurrent Map example shows how to use the synchronous (blocking) + \brief The QtConcurrent Map example shows how to use the synchronous (blocking) QtConcurrent API to scale a collection of images. */ diff --git a/doc/src/examples/qtconcurrent-progressdialog.qdoc b/doc/src/examples/qtconcurrent-progressdialog.qdoc index 43e5fef..7f18b0f 100644 --- a/doc/src/examples/qtconcurrent-progressdialog.qdoc +++ b/doc/src/examples/qtconcurrent-progressdialog.qdoc @@ -29,7 +29,7 @@ \example qtconcurrent/progressdialog \title QtConcurrent Progress Dialog Example - The QtConcurrent Progress Dialog example shows how to use the + \brief The QtConcurrent Progress Dialog example shows how to use the QFutureWatcher class to monitor the progress of a long-running operation. \image qtconcurrent-progressdialog.png diff --git a/doc/src/examples/qtconcurrent-runfunction.qdoc b/doc/src/examples/qtconcurrent-runfunction.qdoc index c66ac11..7e73508 100644 --- a/doc/src/examples/qtconcurrent-runfunction.qdoc +++ b/doc/src/examples/qtconcurrent-runfunction.qdoc @@ -29,7 +29,7 @@ \example qtconcurrent/runfunction \title QtConcurrent Run Function Example - The QtConcurrent Run Function example shows how to apply concurrency to + \brief The QtConcurrent Run Function example shows how to apply concurrency to a standard function, using QFuture instances to retrieve return values at a later time. */ diff --git a/doc/src/examples/qtconcurrent-wordcount.qdoc b/doc/src/examples/qtconcurrent-wordcount.qdoc index 26e65be..5f87884 100644 --- a/doc/src/examples/qtconcurrent-wordcount.qdoc +++ b/doc/src/examples/qtconcurrent-wordcount.qdoc @@ -29,7 +29,7 @@ \example qtconcurrent/wordcount \title QtConcurrent Word Count Example - The QtConcurrent Word Count example demonstrates the use of the map-reduce + \brief The QtConcurrent Word Count example demonstrates the use of the map-reduce algorithm when applied to the problem of counting words in a collection of files. */ diff --git a/doc/src/examples/qtscriptcalculator.qdoc b/doc/src/examples/qtscriptcalculator.qdoc index ce925f3..109394d 100644 --- a/doc/src/examples/qtscriptcalculator.qdoc +++ b/doc/src/examples/qtscriptcalculator.qdoc @@ -29,7 +29,7 @@ \example script/calculator \title QtScript Calculator Example - In this simple QtScript example, we show how to implement the + \brief In the QtScript Calculator example, we show how to implement the functionality of a calculator widget. \image qtscript-calculator-example.png diff --git a/doc/src/examples/qtscriptcustomclass.qdoc b/doc/src/examples/qtscriptcustomclass.qdoc index b3d4535..21624a0 100644 --- a/doc/src/examples/qtscriptcustomclass.qdoc +++ b/doc/src/examples/qtscriptcustomclass.qdoc @@ -29,7 +29,7 @@ \example script/customclass \title Custom Script Class Example - The Custom Script Class example shows how to use QScriptClass and QScriptClassPropertyIterator + \brief The Custom Script Class example shows how to use QScriptClass and QScriptClassPropertyIterator to implement a custom script class. The script class we are going to implement is called \c{ByteArray}. It provides a wrapper around diff --git a/doc/src/examples/qtscripttetrix.qdoc b/doc/src/examples/qtscripttetrix.qdoc index 92a50bf..fe9632e 100644 --- a/doc/src/examples/qtscripttetrix.qdoc +++ b/doc/src/examples/qtscripttetrix.qdoc @@ -29,7 +29,7 @@ \example script/qstetrix \title Qt Script Tetrix Example - The QSTetrix example is a Qt Script version of the classic Tetrix game. + \brief The QSTetrix example is a Qt Script version of the classic Tetrix game. \image tetrix-example.png diff --git a/doc/src/examples/querymodel.qdoc b/doc/src/examples/querymodel.qdoc index 554ae21..9c523e7 100644 --- a/doc/src/examples/querymodel.qdoc +++ b/doc/src/examples/querymodel.qdoc @@ -29,7 +29,7 @@ \example sql/querymodel \title Query Model Example - The Query Model example shows how to make customized versions of + \brief The Query Model example shows how to make customized versions of data obtained from a SQL query, using a model that encapsulates the query and table views to display the results. diff --git a/doc/src/examples/queuedcustomtype.qdoc b/doc/src/examples/queuedcustomtype.qdoc index 85f6b07..4b1db01 100644 --- a/doc/src/examples/queuedcustomtype.qdoc +++ b/doc/src/examples/queuedcustomtype.qdoc @@ -29,7 +29,7 @@ \example threads/queuedcustomtype \title Queued Custom Type Example - The Queued Custom Type example shows how to send custom types between + \brief The Queued Custom Type example shows how to send custom types between threads with queued signals and slots. \image queuedcustomtype-example.png diff --git a/doc/src/examples/qxmlstreambookmarks.qdoc b/doc/src/examples/qxmlstreambookmarks.qdoc index ecb8fce..6d2a6f1 100644 --- a/doc/src/examples/qxmlstreambookmarks.qdoc +++ b/doc/src/examples/qxmlstreambookmarks.qdoc @@ -29,7 +29,7 @@ \example xml/streambookmarks \title QXmlStream Bookmarks Example - The QXmlStream Bookmarks example provides a reader for XML Bookmark + \brief The QXmlStream Bookmarks example provides a reader for XML Bookmark Exchange Language (XBEL) files using Qt's QXmlStreamReader class for reading, and QXmlStreamWriter class for writing the files. diff --git a/doc/src/examples/recentfiles.qdoc b/doc/src/examples/recentfiles.qdoc index 048df01..03c79c6 100644 --- a/doc/src/examples/recentfiles.qdoc +++ b/doc/src/examples/recentfiles.qdoc @@ -29,7 +29,7 @@ \example mainwindows/recentfiles \title Recent Files Example - The Recent Files example shows how a standard File menu can be extended to show + \brief The Recent Files example shows how a standard File menu can be extended to show the most recent files loaded by a main window application. \image recentfiles-example.png diff --git a/doc/src/examples/recipes.qdoc b/doc/src/examples/recipes.qdoc index d4128aa..c93e4dbe 100644 --- a/doc/src/examples/recipes.qdoc +++ b/doc/src/examples/recipes.qdoc @@ -29,7 +29,7 @@ \example xmlpatterns/recipes \title Recipes Example - The Recipes example shows how to use QtXmlPatterns to query XML data + \brief The Recipes example shows how to use QtXmlPatterns to query XML data loaded from a file. \tableofcontents diff --git a/doc/src/examples/regexp.qdoc b/doc/src/examples/regexp.qdoc index 7b97156..4fc07d6 100644 --- a/doc/src/examples/regexp.qdoc +++ b/doc/src/examples/regexp.qdoc @@ -29,7 +29,7 @@ \example tools/regexp \title Regular Expressions Example - The Regular Expressions (RegExp) example shows how regular expressions in Qt are + \brief The Regular Expressions (RegExp) example shows how regular expressions in Qt are applied to text by providing an environment in which new regular expressions can be created and tested on custom text strings. diff --git a/doc/src/examples/relationaltablemodel.qdoc b/doc/src/examples/relationaltablemodel.qdoc index f23c69c..1c2c473 100644 --- a/doc/src/examples/relationaltablemodel.qdoc +++ b/doc/src/examples/relationaltablemodel.qdoc @@ -29,7 +29,7 @@ \example sql/relationaltablemodel \title Relational Table Model Example - The Relational Table Model example shows how to use table views with a relational + \brief The Relational Table Model example shows how to use table views with a relational model to visualize the relations between items in a database. \image relationaltablemodel-example.png diff --git a/doc/src/examples/remotecontrol.qdoc b/doc/src/examples/remotecontrol.qdoc index c92c5e4..e1e60b0 100644 --- a/doc/src/examples/remotecontrol.qdoc +++ b/doc/src/examples/remotecontrol.qdoc @@ -29,6 +29,6 @@ \example help/remotecontrol \title Remote Control Example - This example shows how to use and control Qt Assistant + \brief The Remote Control example shows how to use and control Qt Assistant as a help viewer. -*/
\ No newline at end of file +*/ diff --git a/doc/src/examples/rogue.qdoc b/doc/src/examples/rogue.qdoc index e93886b..b872008 100644 --- a/doc/src/examples/rogue.qdoc +++ b/doc/src/examples/rogue.qdoc @@ -29,7 +29,7 @@ \example statemachine/rogue \title Rogue Example - The Rogue example shows how to use the Qt state machine for event + \brief The Rogue example shows how to use the Qt state machine for event handling. \image rogue-example.png diff --git a/doc/src/examples/rsslisting.qdoc b/doc/src/examples/rsslisting.qdoc index 9554842..7ad464f 100644 --- a/doc/src/examples/rsslisting.qdoc +++ b/doc/src/examples/rsslisting.qdoc @@ -29,7 +29,7 @@ \example xml/rsslisting \title RSS-Listing Example - The RSS-Listing example shows how to create a widget that displays news items + \brief The RSS-Listing example shows how to create a widget that displays news items from RDF news sources. \image rsslistingexample.png diff --git a/doc/src/examples/samplebuffers.qdoc b/doc/src/examples/samplebuffers.qdoc index c9d6438..422f96b 100644 --- a/doc/src/examples/samplebuffers.qdoc +++ b/doc/src/examples/samplebuffers.qdoc @@ -29,7 +29,7 @@ \example opengl/samplebuffers \title Sample Buffers Example - The Sample Buffers example demonstrates how to use and enable + \brief The Sample Buffers example demonstrates how to use and enable sample buffers in a QGLWidget. \image samplebuffers-example.png diff --git a/doc/src/examples/saxbookmarks.qdoc b/doc/src/examples/saxbookmarks.qdoc index e912372..089f2de 100644 --- a/doc/src/examples/saxbookmarks.qdoc +++ b/doc/src/examples/saxbookmarks.qdoc @@ -29,8 +29,10 @@ \example xml/saxbookmarks \title SAX Bookmarks Example - The SAX Bookmarks example provides a reader for XML Bookmark Exchange Language (XBEL) - files that uses Qt's SAX-based API to read and parse the files. The DOM Bookmarks + \brief The SAX Bookmarks example provides a reader for XML Bookmark Exchange Language (XBEL) + files that uses Qt's SAX-based API to read and parse the files. + + The DOM Bookmarks example provides an alternative way to read this type of file. \image saxbookmarks-example.png diff --git a/doc/src/examples/schema.qdoc b/doc/src/examples/schema.qdoc index 77ccaf5..0ba794b 100644 --- a/doc/src/examples/schema.qdoc +++ b/doc/src/examples/schema.qdoc @@ -29,7 +29,7 @@ \example xmlpatterns/schema \title XML Schema Validation Example - The XML Schema Validation example shows how to use QtXmlPatterns to + \brief The XML Schema Validation example shows how to use QtXmlPatterns to validate XML with a W3C XML Schema. \tableofcontents diff --git a/doc/src/examples/screenshot.qdoc b/doc/src/examples/screenshot.qdoc index bc87fdb..1d8505f 100644 --- a/doc/src/examples/screenshot.qdoc +++ b/doc/src/examples/screenshot.qdoc @@ -29,7 +29,7 @@ \example desktop/screenshot \title Screenshot Example - The Screenshot example shows how to take a screenshot of the + \brief The Screenshot example shows how to take a screenshot of the desktop using QApplication and QDesktopWidget. It also shows how to use QTimer to provide a single-shot timer, and how to reimplement the QWidget::resizeEvent() event handler to make sure diff --git a/doc/src/examples/scribble.qdoc b/doc/src/examples/scribble.qdoc index da9b0b6..56b678c 100644 --- a/doc/src/examples/scribble.qdoc +++ b/doc/src/examples/scribble.qdoc @@ -29,7 +29,7 @@ \example widgets/scribble \title Scribble Example - The Scribble example shows how to reimplement some of QWidget's + \brief The Scribble example shows how to reimplement some of QWidget's event handlers to receive the events generated for the application's widgets. diff --git a/doc/src/examples/script-marshal.qdoc b/doc/src/examples/script-marshal.qdoc index 90ff69b..852f9be 100644 --- a/doc/src/examples/script-marshal.qdoc +++ b/doc/src/examples/script-marshal.qdoc @@ -29,6 +29,6 @@ \example script/marshal \title Qt Script Marshalling Example - The Qt Script Marshalling example demonstrates the marshalling of value + \brief The Qt Script Marshalling example demonstrates the marshalling of value types between C++ and Qt Script. */ diff --git a/doc/src/examples/script-qscript.qdoc b/doc/src/examples/script-qscript.qdoc index 6c50c3f..d0c2841 100644 --- a/doc/src/examples/script-qscript.qdoc +++ b/doc/src/examples/script-qscript.qdoc @@ -29,6 +29,6 @@ \example script/qscript \title Qt Script Interpreter Example - The Qt Script Interpreter example shows how to create an interactive + \brief The Qt Script Interpreter example shows how to create an interactive interpreter for Qt Script. */ diff --git a/doc/src/examples/script-qsdbg.qdoc b/doc/src/examples/script-qsdbg.qdoc index 59ab10e..7e4f05c 100644 --- a/doc/src/examples/script-qsdbg.qdoc +++ b/doc/src/examples/script-qsdbg.qdoc @@ -29,6 +29,6 @@ \example script/qsdbg \title Qt Script Debugger Example - The Qt Script Debugger example shows how to enable the Qt Script debugger + \brief The Qt Script Debugger example shows how to enable the Qt Script debugger for command line debugging. */ diff --git a/doc/src/examples/sdi.qdoc b/doc/src/examples/sdi.qdoc index 5e3eb79..e975879 100644 --- a/doc/src/examples/sdi.qdoc +++ b/doc/src/examples/sdi.qdoc @@ -29,7 +29,7 @@ \example mainwindows/sdi \title SDI Example - The SDI example shows how to create a Single Document Interface. It uses a number of + \brief The SDI example shows how to create a Single Document Interface. It uses a number of top-level windows to display the contents of different text files. \image sdi-example.png diff --git a/doc/src/examples/securesocketclient.qdoc b/doc/src/examples/securesocketclient.qdoc index 30ba16a..655465c 100644 --- a/doc/src/examples/securesocketclient.qdoc +++ b/doc/src/examples/securesocketclient.qdoc @@ -29,7 +29,7 @@ \example network/securesocketclient \title Secure Socket Client Example - The Secure Socket Client example shows how to use QSslSocket to + \brief The Secure Socket Client example shows how to use QSslSocket to communicate over an encrypted (SSL) connection. It also demonstrates how to deal with authenticity problems, and how to display security and certificate information. diff --git a/doc/src/examples/semaphores.qdoc b/doc/src/examples/semaphores.qdoc index aeced47..3bbf028 100644 --- a/doc/src/examples/semaphores.qdoc +++ b/doc/src/examples/semaphores.qdoc @@ -29,7 +29,7 @@ \example threads/semaphores \title Semaphores Example - The Semaphores example shows how to use QSemaphore to control + \brief The Semaphores example shows how to use QSemaphore to control access to a circular buffer shared by a producer thread and a consumer thread. diff --git a/doc/src/examples/settingseditor.qdoc b/doc/src/examples/settingseditor.qdoc index a0fcc17..fc581fd 100644 --- a/doc/src/examples/settingseditor.qdoc +++ b/doc/src/examples/settingseditor.qdoc @@ -29,7 +29,7 @@ \example tools/settingseditor \title Settings Editor Example - The Settings Editor example shows how Qt's standard settings support is used in an + \brief The Settings Editor example shows how Qt's standard settings support is used in an application by providing an editor that enables the user to view the settings for installed applications, and modify those that can be edited. diff --git a/doc/src/examples/shapedclock.qdoc b/doc/src/examples/shapedclock.qdoc index e66b3ef..c46c5a7 100644 --- a/doc/src/examples/shapedclock.qdoc +++ b/doc/src/examples/shapedclock.qdoc @@ -29,7 +29,7 @@ \example widgets/shapedclock \title Shaped Clock Example - The Shaped Clock example shows how to apply a widget mask to a top-level + \brief The Shaped Clock example shows how to apply a widget mask to a top-level widget to produce a shaped window. \image shapedclock-example.png diff --git a/doc/src/examples/sharedmemory.qdoc b/doc/src/examples/sharedmemory.qdoc index 2f4088b..c67d3f5 100644 --- a/doc/src/examples/sharedmemory.qdoc +++ b/doc/src/examples/sharedmemory.qdoc @@ -29,9 +29,10 @@ \example ipc/sharedmemory \title Shared Memory Example - The Shared Memory example shows how to use the QSharedMemory class - to implement inter-process communication using shared memory. To - build the example, run make. To run the example, start two instances + \brief The Shared Memory example shows how to use the QSharedMemory class + to implement inter-process communication using shared memory. + + To build the example, run make. To run the example, start two instances of the executable. The main() function creates an \l {QApplication} {application} and an instance of our example's Dialog class. The dialog is displayed and then control is passed to the application in diff --git a/doc/src/examples/simpledecoration.qdoc b/doc/src/examples/simpledecoration.qdoc index 3c02009..7b033a6 100644 --- a/doc/src/examples/simpledecoration.qdoc +++ b/doc/src/examples/simpledecoration.qdoc @@ -30,7 +30,7 @@ \title Simple Decoration Example \ingroup qt-embedded - The Simple Decoration example shows how to create a custom window decoration + \brief The Simple Decoration example shows how to create a custom window decoration for embedded applications. \image embedded-simpledecoration-example.png diff --git a/doc/src/examples/simpledommodel.qdoc b/doc/src/examples/simpledommodel.qdoc index b7fae91..2f7dd41 100644 --- a/doc/src/examples/simpledommodel.qdoc +++ b/doc/src/examples/simpledommodel.qdoc @@ -29,7 +29,7 @@ \example itemviews/simpledommodel \title Simple DOM Model Example - The Simple DOM Model example shows how an existing class can be adapted for use with + \brief The Simple DOM Model example shows how an existing class can be adapted for use with the model/view framework. \image simpledommodel-example.png diff --git a/doc/src/examples/simpleselector.qdoc b/doc/src/examples/simpleselector.qdoc index 4455c2b..28f9707 100644 --- a/doc/src/examples/simpleselector.qdoc +++ b/doc/src/examples/simpleselector.qdoc @@ -29,7 +29,7 @@ \example webkit/simpleselector \title Simple Selector Example - The Simple Selector example shows how to use QWebElement to access the + \brief The Simple Selector example shows how to use QWebElement to access the Document Object Model (DOM) in a Web page. \image webkit-simpleselector.png diff --git a/doc/src/examples/simpletextviewer.qdoc b/doc/src/examples/simpletextviewer.qdoc index bf44938..6bb1420 100644 --- a/doc/src/examples/simpletextviewer.qdoc +++ b/doc/src/examples/simpletextviewer.qdoc @@ -29,7 +29,7 @@ \example help/simpletextviewer \title Simple Text Viewer Example - The Simple Text Viewer example shows how to use \QA as a customized + \brief The Simple Text Viewer example shows how to use \QA as a customized help viewer for your application. This is done in two stages. Firstly, documentation is created and \QA diff --git a/doc/src/examples/simpletreemodel.qdoc b/doc/src/examples/simpletreemodel.qdoc index 00464b2..7989893 100644 --- a/doc/src/examples/simpletreemodel.qdoc +++ b/doc/src/examples/simpletreemodel.qdoc @@ -29,9 +29,10 @@ \example itemviews/simpletreemodel \title Simple Tree Model Example - The Simple Tree Model example shows how to create a basic, read-only - hierarchical model to use with Qt's standard view classes. For a - description of simple non-hierarchical list and table models, see the + \brief The Simple Tree Model example shows how to create a basic, read-only + hierarchical model to use with Qt's standard view classes. + + For a description of simple non-hierarchical list and table models, see the \l{Model/View Programming} overview. \image simpletreemodel-example.png diff --git a/doc/src/examples/simplewebplugin.qdoc b/doc/src/examples/simplewebplugin.qdoc index 4c95b58..185cc85 100644 --- a/doc/src/examples/simplewebplugin.qdoc +++ b/doc/src/examples/simplewebplugin.qdoc @@ -29,7 +29,7 @@ \example webkit/simplewebplugin \title Simple Web Plugin Example - The Simple Web Plugin example shows how to embed a regular Qt widget into a + \brief The Simple Web Plugin example shows how to embed a regular Qt widget into a Web page displayed using QWebView. \image webkit-simplewebplugin.png A table widget embedded in a Web page. diff --git a/doc/src/examples/simplewidgetmapper.qdoc b/doc/src/examples/simplewidgetmapper.qdoc index 60837fc..705da4b 100644 --- a/doc/src/examples/simplewidgetmapper.qdoc +++ b/doc/src/examples/simplewidgetmapper.qdoc @@ -29,7 +29,7 @@ \example itemviews/simplewidgetmapper \title Simple Widget Mapper Example - The Simple Widget Mapper example shows how to use a widget mapper to display + \brief The Simple Widget Mapper example shows how to use a widget mapper to display data from a model in a collection of widgets. \image simplewidgetmapper-example.png diff --git a/doc/src/examples/sipdialog.qdoc b/doc/src/examples/sipdialog.qdoc index 349ab18..ce78a9e 100644 --- a/doc/src/examples/sipdialog.qdoc +++ b/doc/src/examples/sipdialog.qdoc @@ -30,7 +30,7 @@ \title SIP Dialog Example \ingroup qtce - The SIP Dialog example shows how to create a dialog that is aware of + \brief The SIP Dialog example shows how to create a dialog that is aware of the Windows Mobile SIP (Software Input Panel) and reacts to it. \table diff --git a/doc/src/examples/sliders.qdoc b/doc/src/examples/sliders.qdoc index 7e47dcc..fc8af36 100644 --- a/doc/src/examples/sliders.qdoc +++ b/doc/src/examples/sliders.qdoc @@ -29,7 +29,7 @@ \example widgets/sliders \title Sliders Example - Qt provides three types of slider-like widgets: QSlider, + \brief Qt provides three types of slider-like widgets: QSlider, QScrollBar and QDial. They all inherit most of their functionality from QAbstractSlider, and can in theory replace each other in an application since the differences only concern diff --git a/doc/src/examples/spinboxdelegate.qdoc b/doc/src/examples/spinboxdelegate.qdoc index 50d5b9c..62f3ced 100644 --- a/doc/src/examples/spinboxdelegate.qdoc +++ b/doc/src/examples/spinboxdelegate.qdoc @@ -29,7 +29,7 @@ \example itemviews/spinboxdelegate \title Spin Box Delegate Example - The Spin Box Delegate example shows how to create an editor for a custom delegate in + \brief The Spin Box Delegate example shows how to create an editor for a custom delegate in the model/view framework by reusing a standard Qt editor widget. The model/view framework provides a standard delegate that is used by default diff --git a/doc/src/examples/spinboxes.qdoc b/doc/src/examples/spinboxes.qdoc index e87faf1..575d99d 100644 --- a/doc/src/examples/spinboxes.qdoc +++ b/doc/src/examples/spinboxes.qdoc @@ -29,7 +29,7 @@ \example widgets/spinboxes \title Spin Boxes Example - The Spin Boxes example shows how to use the many different types of spin boxes + \brief The Spin Boxes example shows how to use the many different types of spin boxes available in Qt, from a simple QSpinBox widget to more complex editors like the QDateTimeEdit widget. diff --git a/doc/src/examples/sqlwidgetmapper.qdoc b/doc/src/examples/sqlwidgetmapper.qdoc index cf1a158..453c811 100644 --- a/doc/src/examples/sqlwidgetmapper.qdoc +++ b/doc/src/examples/sqlwidgetmapper.qdoc @@ -29,7 +29,7 @@ \example sql/sqlwidgetmapper \title SQL Widget Mapper Example - The SQL Widget Mapper example shows how to use a map information from a + \brief The SQL Widget Mapper example shows how to use a map information from a database to widgets on a form. \image sql-widget-mapper.png diff --git a/doc/src/examples/standarddialogs.qdoc b/doc/src/examples/standarddialogs.qdoc index 92005b4..d187715 100644 --- a/doc/src/examples/standarddialogs.qdoc +++ b/doc/src/examples/standarddialogs.qdoc @@ -29,7 +29,7 @@ \example dialogs/standarddialogs \title Standard Dialogs Example - The Standard Dialogs example shows the standard dialogs that are provided by Qt. + \brief The Standard Dialogs example shows the standard dialogs that are provided by Qt. \image standarddialogs-example.png */ diff --git a/doc/src/examples/stardelegate.qdoc b/doc/src/examples/stardelegate.qdoc index ed3ae7e..b94935e 100644 --- a/doc/src/examples/stardelegate.qdoc +++ b/doc/src/examples/stardelegate.qdoc @@ -29,7 +29,7 @@ \example itemviews/stardelegate \title Star Delegate Example - The Star Delegate example shows how to create a delegate that + \brief The Star Delegate example shows how to create a delegate that can paint itself and that supports editing. \image stardelegate.png The Star Delegate Example diff --git a/doc/src/examples/states.qdoc b/doc/src/examples/states.qdoc index 815c969..284b4ec 100644 --- a/doc/src/examples/states.qdoc +++ b/doc/src/examples/states.qdoc @@ -29,7 +29,7 @@ \example animation/states \title States Example - The States example shows how to use the Qt state machine to play + \brief The States example shows how to use the Qt state machine to play animations. \image states-example.png diff --git a/doc/src/examples/stickman.qdoc b/doc/src/examples/stickman.qdoc index 8c35fe1..d980586 100644 --- a/doc/src/examples/stickman.qdoc +++ b/doc/src/examples/stickman.qdoc @@ -29,7 +29,7 @@ \example animation/stickman \title Stickman Example - The Stickman example shows how to animate transitions in a state machine to implement key frame + \brief The Stickman example shows how to animate transitions in a state machine to implement key frame animations. \image stickman-example.png diff --git a/doc/src/examples/styleplugin.qdoc b/doc/src/examples/styleplugin.qdoc index 59729c7..a38b8d7 100644 --- a/doc/src/examples/styleplugin.qdoc +++ b/doc/src/examples/styleplugin.qdoc @@ -29,7 +29,7 @@ \example tools/styleplugin \title Style Plugin Example - This example shows how to create a plugin that extends Qt with a new + \brief The Style Plugin example shows how to create a plugin that extends Qt with a new GUI look and feel. \image stylepluginexample.png diff --git a/doc/src/examples/styles.qdoc b/doc/src/examples/styles.qdoc index 5258c19..f9ac48c 100644 --- a/doc/src/examples/styles.qdoc +++ b/doc/src/examples/styles.qdoc @@ -29,7 +29,7 @@ \example widgets/styles \title Styles Example - The Styles example illustrates how to create custom widget + \brief The Styles example illustrates how to create custom widget drawing styles using Qt, and demonstrates Qt's predefined styles. \image styles-enabledwood.png Screenshot of the Styles example diff --git a/doc/src/examples/stylesheet.qdoc b/doc/src/examples/stylesheet.qdoc index a82d0d1..edb684b 100644 --- a/doc/src/examples/stylesheet.qdoc +++ b/doc/src/examples/stylesheet.qdoc @@ -29,7 +29,7 @@ \example widgets/stylesheet \title Style Sheet Example - The Style Sheet Example shows how to use style sheets. + \brief The Style Sheet Example shows how to use style sheets with Qt. \image stylesheet-pagefold.png Screen Shot of the Pagefold style sheet */ diff --git a/doc/src/examples/svgalib.qdoc b/doc/src/examples/svgalib.qdoc index dbdad0f..a0320e7 100644 --- a/doc/src/examples/svgalib.qdoc +++ b/doc/src/examples/svgalib.qdoc @@ -29,9 +29,11 @@ \example qws/svgalib \title Accelerated Graphics Driver Example - The Accelerated Graphics Driver example shows how you can write + \brief The Accelerated Graphics Driver example shows how you can write your own accelerated graphics driver and \l {add your graphics - driver to Qt for Embedded Linux}. In \l{Qt for Embedded Linux}, + driver to Qt for Embedded Linux}. + + In \l{Qt for Embedded Linux}, painting is a pure software implementation and is normally performed in two steps: The clients render each window onto a corresponding surface diff --git a/doc/src/examples/svggenerator.qdoc b/doc/src/examples/svggenerator.qdoc index 1fce379..ed5ea77 100644 --- a/doc/src/examples/svggenerator.qdoc +++ b/doc/src/examples/svggenerator.qdoc @@ -29,7 +29,7 @@ \example painting/svggenerator \title SVG Generator Example - The SVG Generator example shows how to add SVG file export to applications. + \brief The SVG Generator example shows how to add SVG file export to applications. \image svggenerator-example.png diff --git a/doc/src/examples/svgviewer.qdoc b/doc/src/examples/svgviewer.qdoc index f393b08..93671b6 100644 --- a/doc/src/examples/svgviewer.qdoc +++ b/doc/src/examples/svgviewer.qdoc @@ -29,7 +29,7 @@ \example painting/svgviewer \title SVG Viewer Example - The SVG Viewer example shows how to add SVG viewing support to applications. + \brief The SVG Viewer example shows how to add SVG viewing support to applications. \image svgviewer-example.png diff --git a/doc/src/examples/symbianvibration.qdoc b/doc/src/examples/symbianvibration.qdoc index 76f79e5..a6a3d52 100644 --- a/doc/src/examples/symbianvibration.qdoc +++ b/doc/src/examples/symbianvibration.qdoc @@ -29,7 +29,7 @@ \group all-examples \title Symbian Vibration Example - The Symbian Vibrator example shows how to get fine-grained vibration + \brief The Symbian Vibrator example shows how to get fine-grained vibration control on Symbian devices. Native Symbian APIs have to be used to enable vibration, since QtMobility diff --git a/doc/src/examples/syntaxhighlighter.qdoc b/doc/src/examples/syntaxhighlighter.qdoc index 919d61c..13409dc 100644 --- a/doc/src/examples/syntaxhighlighter.qdoc +++ b/doc/src/examples/syntaxhighlighter.qdoc @@ -29,7 +29,7 @@ \example richtext/syntaxhighlighter \title Syntax Highlighter Example - The Syntax Highlighter example shows how to perform simple syntax + \brief The Syntax Highlighter example shows how to perform simple syntax highlighting by subclassing the QSyntaxHighlighter class. \image syntaxhighlighter-example.png diff --git a/doc/src/examples/systray.qdoc b/doc/src/examples/systray.qdoc index e072c9d..22f3779 100644 --- a/doc/src/examples/systray.qdoc +++ b/doc/src/examples/systray.qdoc @@ -29,8 +29,7 @@ \example desktop/systray \title System Tray Icon Example - - The System Tray Icon example shows how to add an icon with a menu + \brief The System Tray Icon example shows how to add an icon with a menu and popup messages to a desktop environment's system tray. \image systemtray-example.png Screenshot of the System Tray Icon. diff --git a/doc/src/examples/tabdialog.qdoc b/doc/src/examples/tabdialog.qdoc index b192645..d450783 100644 --- a/doc/src/examples/tabdialog.qdoc +++ b/doc/src/examples/tabdialog.qdoc @@ -29,7 +29,7 @@ \example dialogs/tabdialog \title Tab Dialog Example - The Tab Dialog example shows how to construct a tab dialog using the + \brief The Tab Dialog example shows how to construct a tab dialog using the QTabWidget class. Dialogs provide an efficient way for the application to communicate diff --git a/doc/src/examples/tablemodel.qdoc b/doc/src/examples/tablemodel.qdoc index bd81763..ad2d557 100644 --- a/doc/src/examples/tablemodel.qdoc +++ b/doc/src/examples/tablemodel.qdoc @@ -29,7 +29,7 @@ \example sql/tablemodel \title Table Model Example - The Table Model example shows how to use a specialized SQL table model with table + \brief The Table Model example shows how to use a specialized SQL table model with table views to edit information in a database. \image tablemodel-example.png diff --git a/doc/src/examples/tablet.qdoc b/doc/src/examples/tablet.qdoc index 8639ab6..8c29642 100644 --- a/doc/src/examples/tablet.qdoc +++ b/doc/src/examples/tablet.qdoc @@ -29,7 +29,7 @@ \example widgets/tablet \title Tablet Example - This example shows how to use a Wacom tablet in Qt applications. + \brief The Tablet example shows how to use a Wacom tablet in Qt applications. \image tabletexample.png diff --git a/doc/src/examples/taskmenuextension.qdoc b/doc/src/examples/taskmenuextension.qdoc index a5562eb..2414ae4 100644 --- a/doc/src/examples/taskmenuextension.qdoc +++ b/doc/src/examples/taskmenuextension.qdoc @@ -29,7 +29,7 @@ \example designer/taskmenuextension \title Task Menu Extension Example - The Task Menu Extension example shows how to create a custom + \brief The Task Menu Extension example shows how to create a custom widget plugin for \l {Qt Designer Manual}{\QD}, and how to to use the QDesignerTaskMenuExtension class to provide custom task menu entries associated with the plugin. diff --git a/doc/src/examples/tetrix.qdoc b/doc/src/examples/tetrix.qdoc index e37d2b6..92e9e28 100644 --- a/doc/src/examples/tetrix.qdoc +++ b/doc/src/examples/tetrix.qdoc @@ -29,7 +29,7 @@ \example widgets/tetrix \title Tetrix Example - The Tetrix example is a Qt version of the classic Tetrix game. + \brief The Tetrix example is a Qt version of the classic Tetrix game. \image tetrix-example.png diff --git a/doc/src/examples/textfinder.qdoc b/doc/src/examples/textfinder.qdoc index fc6d2ba..87947ac 100644 --- a/doc/src/examples/textfinder.qdoc +++ b/doc/src/examples/textfinder.qdoc @@ -29,8 +29,10 @@ \example uitools/textfinder \title Text Finder Example - The Text Finder example demonstrates how to dynamically process forms - using the QtUiTools module. Dynamic form processing enables a form to + \brief The Text Finder example demonstrates how to dynamically process forms + using the QtUiTools module. + + Dynamic form processing enables a form to be processed at run-time only by changing the UI file for the project. The program allows the user to look up a particular word within the contents of a text file. This text file is included in the project's diff --git a/doc/src/examples/textobject.qdoc b/doc/src/examples/textobject.qdoc index 30bf417..a108038 100644 --- a/doc/src/examples/textobject.qdoc +++ b/doc/src/examples/textobject.qdoc @@ -29,7 +29,7 @@ \example richtext/textobject \title Text Object Example - The Text Object example shows how to insert an SVG file into a + \brief The Text Object example shows how to insert an SVG file into a QTextDocument. \image textobject-example.png diff --git a/doc/src/examples/textures.qdoc b/doc/src/examples/textures.qdoc index 52bde78..09f6d9a 100644 --- a/doc/src/examples/textures.qdoc +++ b/doc/src/examples/textures.qdoc @@ -29,7 +29,7 @@ \example opengl/textures \title Textures Example - The Textures example demonstrates the use of Qt's image classes as textures in + \brief The Textures example demonstrates the use of Qt's image classes as textures in applications that use both OpenGL and Qt to display graphics. \image textures-example.png diff --git a/doc/src/examples/threadedfortuneserver.qdoc b/doc/src/examples/threadedfortuneserver.qdoc index 87da054..855d735 100644 --- a/doc/src/examples/threadedfortuneserver.qdoc +++ b/doc/src/examples/threadedfortuneserver.qdoc @@ -29,9 +29,11 @@ \example network/threadedfortuneserver \title Threaded Fortune Server Example - The Threaded Fortune Server example shows how to create a server for a + \brief The Threaded Fortune Server example shows how to create a server for a simple network service that uses threads to handle requests from different - clients. It is intended to be run alongside the Fortune Client example. + clients. + + The example is intended to be run alongside the Fortune Client example. \image threadedfortuneserver-example.png diff --git a/doc/src/examples/tooltips.qdoc b/doc/src/examples/tooltips.qdoc index 9786c40..4abdf99 100644 --- a/doc/src/examples/tooltips.qdoc +++ b/doc/src/examples/tooltips.qdoc @@ -29,7 +29,7 @@ \example widgets/tooltips \title Tool Tips Example - The Tool Tips example shows how to provide static and dynamic tool + \brief The Tool Tips example shows how to provide static and dynamic tool tips for an application's widgets. The simplest and most common way to set a widget's tool tip is by diff --git a/doc/src/examples/torrent.qdoc b/doc/src/examples/torrent.qdoc index 86c0b0c..9082441 100644 --- a/doc/src/examples/torrent.qdoc +++ b/doc/src/examples/torrent.qdoc @@ -29,7 +29,7 @@ \example network/torrent \title Torrent Example - The Torrent example is a functional BitTorrent client that + \brief The Torrent example is a functional BitTorrent client that illustrates how to write a complex TCP/IP application using Qt. \image torrent-example.png diff --git a/doc/src/examples/touch-dials.qdoc b/doc/src/examples/touch-dials.qdoc index f80e72e..008a7f2 100644 --- a/doc/src/examples/touch-dials.qdoc +++ b/doc/src/examples/touch-dials.qdoc @@ -29,7 +29,7 @@ \example touch/dials \title Touch Dials Example - The Touch Dials example shows how to apply touch to a set of + \brief The Touch Dials example shows how to apply touch to a set of standard Qt widgets. \image touch-dials-example.png diff --git a/doc/src/examples/touch-knobs.qdoc b/doc/src/examples/touch-knobs.qdoc index 44ff8a8..4abc64c 100644 --- a/doc/src/examples/touch-knobs.qdoc +++ b/doc/src/examples/touch-knobs.qdoc @@ -29,7 +29,7 @@ \example touch/knobs \title Touch Knobs Example - The Touch Knobs example shows how to create custom controls that + \brief The Touch Knobs example shows how to create custom controls that accept touch input. \image touch-knobs-example.png diff --git a/doc/src/examples/trafficinfo.qdoc b/doc/src/examples/trafficinfo.qdoc index dc12f37..b73f5ce 100644 --- a/doc/src/examples/trafficinfo.qdoc +++ b/doc/src/examples/trafficinfo.qdoc @@ -29,7 +29,7 @@ \example xmlpatterns/trafficinfo \title TrafficInfo Example - Shows how XQuery can be used extract information from WML documents provided by a WAP service. + \brief The Traffic Info example shows how XQuery can be used extract information from WML documents provided by a WAP service. \section1 Overview diff --git a/doc/src/examples/trafficlight.qdoc b/doc/src/examples/trafficlight.qdoc index 828195e..cf6bb19 100644 --- a/doc/src/examples/trafficlight.qdoc +++ b/doc/src/examples/trafficlight.qdoc @@ -29,7 +29,7 @@ \example statemachine/trafficlight \title Traffic Light Example - The Traffic Light example shows how to use \l{The State Machine Framework} + \brief The Traffic Light example shows how to use \l{The State Machine Framework} to implement the control flow of a traffic light. \image trafficlight-example.png diff --git a/doc/src/examples/transformations.qdoc b/doc/src/examples/transformations.qdoc index 26b558c..c4888f9 100644 --- a/doc/src/examples/transformations.qdoc +++ b/doc/src/examples/transformations.qdoc @@ -29,7 +29,7 @@ \example painting/transformations \title Transformations Example - The Transformations example shows how transformations influence + \brief The Transformations example shows how transformations influence the way that QPainter renders graphics primitives. In particular it shows how the order of transformations affect the result. diff --git a/doc/src/examples/treemodelcompleter.qdoc b/doc/src/examples/treemodelcompleter.qdoc index 4caba0d..94c363e 100644 --- a/doc/src/examples/treemodelcompleter.qdoc +++ b/doc/src/examples/treemodelcompleter.qdoc @@ -29,7 +29,7 @@ \example tools/treemodelcompleter \title Tree Model Completer Example - The Tree Model Completer example shows how to provide completion + \brief The Tree Model Completer example shows how to provide completion facilities for a hierarchical model, using a period as the separator to access Child, GrandChild and GrandGrandChild level objects. diff --git a/doc/src/examples/trivialwizard.qdoc b/doc/src/examples/trivialwizard.qdoc index e654a78..df8378f 100644 --- a/doc/src/examples/trivialwizard.qdoc +++ b/doc/src/examples/trivialwizard.qdoc @@ -29,7 +29,7 @@ \example dialogs/trivialwizard \title Trivial Wizard Example - The Trivial Wizard example illustrates how to create a linear three-page + \brief The Trivial Wizard example illustrates how to create a linear three-page registration wizard using three instances of QWizardPage and one instance of QWizard. diff --git a/doc/src/examples/trollprint.qdoc b/doc/src/examples/trollprint.qdoc index de6cc60..faa6405 100644 --- a/doc/src/examples/trollprint.qdoc +++ b/doc/src/examples/trollprint.qdoc @@ -29,7 +29,7 @@ \example linguist/trollprint \title Troll Print Example - Troll Print is an example application that lets the user choose + \brief Troll Print is an example application that lets the user choose printer settings. It comes in two versions: English and Portuguese. diff --git a/doc/src/examples/twowaybutton.qdoc b/doc/src/examples/twowaybutton.qdoc index b42615e..8e3f5a6 100644 --- a/doc/src/examples/twowaybutton.qdoc +++ b/doc/src/examples/twowaybutton.qdoc @@ -29,7 +29,7 @@ \example statemachine/twowaybutton \title Two-way Button Example - The Two-way button example shows how to use \l{The State Machine + \brief The Two-way button example shows how to use \l{The State Machine Framework} to implement a simple state machine that toggles the current state when a button is clicked. diff --git a/doc/src/examples/undoframework.qdoc b/doc/src/examples/undoframework.qdoc index 15372ec..2fdb4cf 100644 --- a/doc/src/examples/undoframework.qdoc +++ b/doc/src/examples/undoframework.qdoc @@ -29,7 +29,7 @@ \example tools/undoframework \title Undo Framework Example - This example shows how to implement undo/redo functionality + \brief The Undo Framework example shows how to implement undo/redo functionality with the Qt undo framework. \image undoframeworkexample.png The Undo Diagram Example diff --git a/doc/src/examples/videographicsitem.qdoc b/doc/src/examples/videographicsitem.qdoc index f52e043..76f54cb 100644 --- a/doc/src/examples/videographicsitem.qdoc +++ b/doc/src/examples/videographicsitem.qdoc @@ -29,7 +29,7 @@ \example multimedia/videographicsitem \title Video Graphics Item Example - The Video Graphics Item example shows how to implement a QGraphicsItem that displays video on a + \brief The Video Graphics Item example shows how to implement a QGraphicsItem that displays video on a graphics scene using QtMultimedia's QAbstractVideoSurface. \image video-videographicsitem.png diff --git a/doc/src/examples/videowidget.qdoc b/doc/src/examples/videowidget.qdoc index c9a87ce..d2dab10 100644 --- a/doc/src/examples/videowidget.qdoc +++ b/doc/src/examples/videowidget.qdoc @@ -29,7 +29,7 @@ \example multimedia/videowidget \title Video Widget Example - The Video Widget example shows how to implement a video widget using + \brief The Video Widget example shows how to implement a video widget using QtMultimedia's QAbstractVideoSurface \image video-videowidget.png diff --git a/doc/src/examples/waitconditions.qdoc b/doc/src/examples/waitconditions.qdoc index 0d0cd1b..f2f07c5 100644 --- a/doc/src/examples/waitconditions.qdoc +++ b/doc/src/examples/waitconditions.qdoc @@ -29,7 +29,7 @@ \example threads/waitconditions \title Wait Conditions Example - The Wait Conditions example shows how to use QWaitCondition and + \brief The Wait Conditions example shows how to use QWaitCondition and QMutex to control access to a circular buffer shared by a producer thread and a consumer thread. diff --git a/doc/src/examples/webftpclient.qdoc b/doc/src/examples/webftpclient.qdoc index c3d456d..47006f9 100644 --- a/doc/src/examples/webftpclient.qdoc +++ b/doc/src/examples/webftpclient.qdoc @@ -29,7 +29,7 @@ \example webkit/webftpclient \title Web FTP Client Example - The Web FTP Client example shows how to add support for a new protocol + \brief The Web FTP Client example shows how to add support for a new protocol to QtWebKit-based applications. \image webkit-webftpclient.png An FTP client displaying the contents of the ftp.qt.nokia.com site. diff --git a/doc/src/examples/webkit-bridge-imageanalyzer.qdoc b/doc/src/examples/webkit-bridge-imageanalyzer.qdoc index a736879..7383abc 100644 --- a/doc/src/examples/webkit-bridge-imageanalyzer.qdoc +++ b/doc/src/examples/webkit-bridge-imageanalyzer.qdoc @@ -30,12 +30,13 @@ \startpage {index.html}{Qt Reference Documentation} \title The Webkit Bridge Tutorial - Hybrid Client Application - In this example, we will show how to write a hybrid application using + \brief In this example, we will show how to write a hybrid application using \l{The QtWebKit Bridge}{QtWebKit Bridge}, which distinguishes itself from a thin client in that it performs heavy calculations on the client side in C++, like a native application, but presents nothing more than a \c QWebView for its -user interface, displaying web content written in HTML/JavaScript. The -application uses QtConcurrent to distribute its work across as many CPU cores as +user interface, displaying web content written in HTML/JavaScript. + +The application uses QtConcurrent to distribute its work across as many CPU cores as are available from the system, so it can process each image in parallel. For the full reference documentation of QtWebKit hybrid development, see diff --git a/doc/src/examples/webkit-framecapture.qdoc b/doc/src/examples/webkit-framecapture.qdoc index 2d80c6a..1f9fa9f 100644 --- a/doc/src/examples/webkit-framecapture.qdoc +++ b/doc/src/examples/webkit-framecapture.qdoc @@ -29,7 +29,7 @@ \example webkit/framecapture \title WebKit Frame Capture Example - The Frame Capture example shows how to use the WebKit browser engine to + \brief The Frame Capture example shows how to use the WebKit browser engine to obtain images of frames in a Web page. This example is designed to be run from the command line. Run the diff --git a/doc/src/examples/webplugin.qdoc b/doc/src/examples/webplugin.qdoc index dcf4fb5..c607bef 100644 --- a/doc/src/examples/webplugin.qdoc +++ b/doc/src/examples/webplugin.qdoc @@ -29,7 +29,7 @@ \example webkit/webplugin \title Web Plugin Example - The Web Plugin example shows how to communicate between a Qt widget + \brief The Web Plugin example shows how to communicate between a Qt widget embedded in a Web page and the page itself. \image webkit-webplugin.png A table widget embedded in a Web page. diff --git a/doc/src/examples/widgets-softkeys.qdoc b/doc/src/examples/widgets-softkeys.qdoc index 336aac8..1c66718 100644 --- a/doc/src/examples/widgets-softkeys.qdoc +++ b/doc/src/examples/widgets-softkeys.qdoc @@ -29,5 +29,5 @@ \example widgets/softkeys \title Soft Keys Example - The Soft Keys example shows how to use soft key input on the Symbian platform. + \brief The Soft Keys example shows how to use soft key input on the Symbian platform. */ diff --git a/doc/src/examples/widgets-validators.qdoc b/doc/src/examples/widgets-validators.qdoc index d6c229d..1984d9f 100644 --- a/doc/src/examples/widgets-validators.qdoc +++ b/doc/src/examples/widgets-validators.qdoc @@ -29,5 +29,5 @@ \example widgets/validators \title Validators Example - The Validators example shows the signal emission behavior of input validators. + \brief The Validators example shows the signal emission behavior of input validators. */ diff --git a/doc/src/examples/wiggly.qdoc b/doc/src/examples/wiggly.qdoc index 3685741..2bb3d64 100644 --- a/doc/src/examples/wiggly.qdoc +++ b/doc/src/examples/wiggly.qdoc @@ -29,7 +29,7 @@ \example widgets/wiggly \title Wiggly Example - The Wiggly example shows how to animate a widget using + \brief The Wiggly example shows how to animate a widget using QBasicTimer and \l{QObject::timerEvent()}{timerEvent()}. In addition, the example demonstrates how to use QFontMetrics to determine the size of text on screen. diff --git a/doc/src/examples/windowflags.qdoc b/doc/src/examples/windowflags.qdoc index e690c37..d701498 100644 --- a/doc/src/examples/windowflags.qdoc +++ b/doc/src/examples/windowflags.qdoc @@ -29,7 +29,7 @@ \example widgets/windowflags \title Window Flags Example - The Window Flags example shows how to use the window flags + \brief The Window Flags example shows how to use the window flags available in Qt. A window flag is either a type or a hint. A type is used to diff --git a/doc/src/examples/worldtimeclockbuilder.qdoc b/doc/src/examples/worldtimeclockbuilder.qdoc index e8999ea..cf6d062 100644 --- a/doc/src/examples/worldtimeclockbuilder.qdoc +++ b/doc/src/examples/worldtimeclockbuilder.qdoc @@ -29,7 +29,7 @@ \example designer/worldtimeclockbuilder \title World Time Clock Builder Example - The World Time Clock Builder example shows how forms created with Qt + \brief The World Time Clock Builder example shows how forms created with Qt Designer that contain custom widgets can be dynamically generated at run-time. diff --git a/doc/src/examples/worldtimeclockplugin.qdoc b/doc/src/examples/worldtimeclockplugin.qdoc index 7b88708..ee1d534 100644 --- a/doc/src/examples/worldtimeclockplugin.qdoc +++ b/doc/src/examples/worldtimeclockplugin.qdoc @@ -29,7 +29,7 @@ \example designer/worldtimeclockplugin \title World Time Clock Plugin Example - The World Time Clock Plugin example shows how to create a custom + \brief The World Time Clock Plugin example shows how to create a custom widget plugin for \QD that uses signals and slots. \image worldtimeclockplugin-example.png diff --git a/doc/src/examples/xmlstreamlint.qdoc b/doc/src/examples/xmlstreamlint.qdoc index 98bee62..0a31fb0 100644 --- a/doc/src/examples/xmlstreamlint.qdoc +++ b/doc/src/examples/xmlstreamlint.qdoc @@ -29,7 +29,7 @@ \example xml/xmlstreamlint \title XML Stream Lint Example - The XML Stream Lint example provides a simple command line utility that + \brief The XML Stream Lint example provides a simple command line utility that accepts a file name as its single argument and writes it to the standard output file. diff --git a/doc/src/external-resources.qdoc b/doc/src/external-resources.qdoc index f528bf2..f81f517 100644 --- a/doc/src/external-resources.qdoc +++ b/doc/src/external-resources.qdoc @@ -420,7 +420,7 @@ */ /*! - \externalpage http://developer.symbian.org/wiki/index.php/Platform_Security_%28Fundamentals_of_Symbian_C%2B%2B%29#Self-Signed_Applications + \externalpage http://www.developer.nokia.com/Community/Wiki/Qt_&_Symbian_Platform_Security \title Symbian Platform Security */ diff --git a/doc/src/getting-started/demos.qdoc b/doc/src/getting-started/demos.qdoc index 5c0652c..201b5c7 100644 --- a/doc/src/getting-started/demos.qdoc +++ b/doc/src/getting-started/demos.qdoc @@ -149,13 +149,6 @@ implement a small Web browser. \endlist - \section1 Multimedia - - \list - \o \l{demos/spectrum}{Spectrum Analyser} shows how the \l{QtMultimedia} - module can be used to manipulate audio as it is played. - \endlist - \section1 Phonon \list diff --git a/doc/src/getting-started/installation.qdoc b/doc/src/getting-started/installation.qdoc index 36d63f5..a4ae63f 100644 --- a/doc/src/getting-started/installation.qdoc +++ b/doc/src/getting-started/installation.qdoc @@ -504,72 +504,27 @@ in the \l{Qt for Windows CE Requirements} document. \tableofcontents -Qt for the Symbian platform has some requirements that are given in more detail -in the \l{Qt for the Symbian platform Requirements} document. - - -\section1 Step 1: Install Qt - - Run \c{qt-symbian-opensource-%VERSION%.exe} and follow the instructions. - - \note Qt must be installed on the same drive as the Symbian SDK you are - using, and the install path must not contain any spaces. - -\section1 Step 2: Install Qt into a device - - To run Qt applications on a device, \c{qt_installer.sis} found - in the Qt installation directory must be first installed into the device. - \c{Qt_installer.sis} contains Qt libraries and Open C libraries all in one - convenient package. - Begin installation by connecting your device via USB cable to a computer that - has the \l{http://www.nokia.com/pcsuite}{Nokia PC Suite} installed. - On the device, select "PC Suite mode". In Windows Explorer right click - on the \c{qt_installer.sis} file, select "Install with Nokia Application - Installer" and follow the instructions. - -\section1 Running Qt demos - - We've included a subset of the Qt demos in this package for you - to try out. An excellent starting point is the "fluidlauncher" - demo. - - To run the demo on a real device, install \c{fluidlauncher.sis} - found in the Qt installation directory to a device that already has Qt installed. - After installation, you can find fluidlauncher in the applications folder of the device. - - To run the demos and examples on the emulator, you need to build them first. - Open the "Qt for the Symbian platform Command Prompt" from the Start menu and type: - - \snippet doc/src/snippets/code/doc_src_installation.qdoc 25 - - To run the demos on the emulator simply navigate to the directory of the demo - you want to see and run: - - \snippet doc/src/snippets/code/doc_src_installation.qdoc 27 - - For more information about building and running Qt programs on the -Symbian platform, - see \l{The Symbian platform - Introduction to Qt}. - -\bold{We hope you will enjoy using Qt.} - + Qt for Symbian binary packages (SIS files) are available from the \l + {http://qt.nokia.com/downloads}{Qt SDK}. */ /*! \page install-Symbian.html -\title Installing Qt for the Symbian platform +\title Installing Qt for the Symbian Platform \ingroup installation \ingroup qtsymbian \brief How to install Qt for the Symbian platform. \previouspage Installation \tableofcontents + \l {http://qt.nokia.com/downloads}{Qt SDK} provides all the necessary tools + and libraries for developing Qt applications. However, if you want to build + Qt itself for Symbian, follow the instructions below. + Qt for the Symbian platform has some requirements that are given in more detail in the \l{Qt for the Symbian platform Requirements} document. This document describes how to install and configure Qt for -the Symbian platform from scratch. If you are using pre-built binaries, follow -the instructions given in the \l{Installing Qt for the Symbian platform from a -Binary Package} document. +the Symbian platform from scratch. \section1 Step 1: Set Up the Development Environment @@ -635,7 +590,7 @@ Binary Package} document. The \l{Configuration Options for Qt} page gives a brief overview of these. - SBSv2 (also known as \l{http://developer.symbian.org/wiki/index.php/Introduction_to_RAPTOR} {Raptor}) + SBSv2 (also known as \l{http://projects.developer.nokia.com/raptor/wiki} {Raptor}) is a next-generation Symbian build system. SBSv2 is not officially supported by any of the S60 SDKs currently available from Forum Nokia. @@ -652,23 +607,39 @@ Binary Package} document. Congratulations, Qt is now ready to use. \section1 Step 7: Installing Qt Libraries on the Device + + To run a Qt application on a device, it must have Qt libraries installed. + + Symbian devices have a pre-installed Qt as follows: + \list + \o Symbian Anna devices have the pre-installed Qt, Qt Mobility, and Qt Webkit. + \o Symbian Belle and later devices have the pre-installed Qt on the device firmware. + \endlist + + \l {http://www.developer.nokia.com/Community/Wiki/Nokia_Smart_Installer_for_Symbian} + {Nokia Smart Installer for Symbian} deploys the required Qt libraries to supported S60 + and Symbian devices if the libraries are not pre-installed. + + Nokia Developer site's \l {http://www.developer.nokia.com/Devices/Device_specifications/?filter1=qt} + {Device specifications} provide information on which devices have a + pre-installed Qt and the used Qt version. + + To create your own Qt installation package, do as follows: + + \snippet doc/src/snippets/code/doc_src_installation.qdoc 29 + + The Qt libraries are built with "All -Tcb" capability, so they can support + all types of applications. If you don't have a suitable certificate, you can + patch the binaries in either of the following ways: + + \list + \o If you have no certificate, build a self-signed Qt: + \snippet doc/src/snippets/code/doc_src_installation.qdoc 34 - To run the demo on a real device, you first have to install - the Qt libraries on the device: - -\snippet doc/src/snippets/code/doc_src_installation.qdoc 29 - - The Qt libraries are built with "All -Tcb" capability, so that - they can support all types of application. - If you don't have a suitable certificate, it is possible to patch - the binaries as follows: - - If you have no certificate, build a self signed Qt: -\snippet doc/src/snippets/code/doc_src_installation.qdoc 34 - - If you have a symbian-signed developer certificate, specify the + \o If you have a symbian-signed developer certificate, specify the capabilities you can sign for, for example: -\snippet doc/src/snippets/code/doc_src_installation.qdoc 35 + \snippet doc/src/snippets/code/doc_src_installation.qdoc 35 + \endlist \section1 Running Qt demos @@ -1315,7 +1286,12 @@ We hope you will enjoy using Qt. \brief Setting up the Symbian platform environment for Qt. \previouspage General Qt Requirements - Qt for the Symbian platform requires the following software installed on your development PC: + \l {http://qt.nokia.com/downloads}{Qt SDK} provides all the necessary tools + and libraries for developing Qt applications. However, if you want to build + Qt itself for Symbian, follow the instructions below. + + Qt for the Symbian platform requires the following software installed on + your development PC: \list \o \l{http://www.forum.nokia.com/Library/Tools_and_downloads/Other/Carbide.c++/}{Carbide.c++ v2.3.0 or higher recommended}. \list @@ -1372,7 +1348,7 @@ We hope you will enjoy using Qt. \endlist - We recommend you to take a look at \l{http://developer.symbian.org/wiki/index.php/Qt_Quick_Start}{Symbian Foundation - Qt Quick Start} + We recommend you to take a look at \l{http://doc.qt.nokia.com/latest/install-symbian.html}{Installing Qt for the Symbian platform} to get more information about how to setup the development environment. \sa {Known Issues} diff --git a/doc/src/howtos/appicon.qdoc b/doc/src/howtos/appicon.qdoc index 8e7601f..2879b05 100644 --- a/doc/src/howtos/appicon.qdoc +++ b/doc/src/howtos/appicon.qdoc @@ -205,7 +205,7 @@ In order to set the application icon for Symbian platform applications, you need an SVG-T icon. For information on how to create SVG-T compliant icons, please refer to - \l{http://wiki.forum.nokia.com/index.php/How_to_create_application_icon(SVG)_in_S60_3rd_edition/} + \l{http://wiki.forum.nokia.com/index.php/How_to_create_application_icon(SVG)_in_S60_3rd_edition} Once the icon is available in the correct format and assuming you are using \c qmake to generate your makefiles, you only need to add a single diff --git a/doc/src/images/editbreaklayout.png b/doc/src/images/editbreaklayout.png Binary files differnew file mode 100644 index 0000000..07c5fae --- /dev/null +++ b/doc/src/images/editbreaklayout.png diff --git a/doc/src/internationalization/i18n.qdoc b/doc/src/internationalization/i18n.qdoc index 2abc286..f706623 100644 --- a/doc/src/internationalization/i18n.qdoc +++ b/doc/src/internationalization/i18n.qdoc @@ -514,7 +514,6 @@ \ingroup internationalization \previouspage Internationalization with Qt \contentspage Internationalization with Qt - \nextpage Translation Rules for Plurals \brief How to write source code in a way that makes it possible for user-visible text to be translated. \tableofcontents @@ -700,8 +699,8 @@ set using QLocale::setDefault(). (If no default locale was specified, the "C" locale is used.) - A summary of the rules used to translate strings containing plurals can be - found in the \l{Translation Rules for Plurals} document. + A summary of supported languages and the rules used to translate strings + containing plurals can be obtained by running \tt{lupdate -list-languages}. \section1 Enabling Translation @@ -717,55 +716,5 @@ \section1 Further Reading - \l{Qt Linguist Manual}, \l{Hello tr() Example}, \l{Translation Rules for Plurals} -*/ - -/*! - \page i18n-plural-rules.html - \title Translation Rules for Plurals - \ingroup internationalization - \previouspage Writing Source Code for Translation - \contentspage Internationalization with Qt - \brief A summary of the translation rules for plurals produced by Qt's i18n tools. - - The table below shows the specific rules that are produced by Qt Linguist - and \c lrelease for a selection of languages. Cells marked \e otherwise - indicate the form used when none of the other rules are appropriate for a - specific language. - - \table 80% - \header \o Language \o Rule 1 \o Rule 2 \o Rule 3 - \row \o English \o \c{n == 1} - \o \e{otherwise} \o N/A - \row \o French \o \c{n < 2} - \o \e{otherwise} \o N/A - \row \o Czech \o \c{n % 100 == 1} - \o \c{n % 100 >= 2 && n % 100 <= 4} - \o \e{otherwise} - \row \o Irish \o \c{n == 1} - \o \c{n == 2} \o \e{otherwise} - \row \o Latvian \o \c{n % 10 == 1&& n % 100 != 11} - \o \c{n != 0} \o \e{otherwise} - \row \o Lithuanian \o \c{n % 10 == 1&& n % 100 != 11} - \o \c{n % 100 != 12 && n % 10 == 2} - \o \e{otherwise} - \row \o Macedonian \o \c{n % 10 == 1} - \o \c{n % 10 == 2} \o \e{otherwise} - \row \o Polish \o \c{n == 1} - \o \c{n % 10 >= 2 && n % 10 <= 4 - && (n % 100 < 10 || n % 100 > 20)} - \o \e{otherwise} - \row \o Romanian \o \c{n == 1} - \o \c{n == 0|| (n % 100 >= 1 && n % 100 <= 20)} - \o \e{otherwise} - \row \o Russian \o \c{n % 10 == 1&& n % 100 != 11} - \o \c{n % 10 >= 2 && n % 10 <= 4 - && (n % 100 < 10 || n % 100 > 20)} - \o \e{otherwise} - \row \o Slovak \o \c{n == 1} \o \c{n >= 2 && n <= 4} - \o \e{otherwise} - \row \o Japanese \o \e{otherwise} \o N/A \o N/A - \endtable - - The rules themselves are not documented and are internal to Qt Linguist and \c lrelease. + \l{Qt Linguist Manual}, \l{Hello tr() Example} */ diff --git a/doc/src/legal/3rdparty.qdoc b/doc/src/legal/3rdparty.qdoc index ac1bc9d..d8276b3 100644 --- a/doc/src/legal/3rdparty.qdoc +++ b/doc/src/legal/3rdparty.qdoc @@ -361,7 +361,7 @@ See \c src/3rdparty/sha1/sha1.cpp for more information about the terms and conditions under which the code is supplied. - \section1 SQLite (\c sqlite) version 3.5.9 + \section1 SQLite (\c sqlite) version 3.7.7.1 \e{SQLite is a small C library that implements a self-contained, embeddable, zero-configuration SQL database engine.} diff --git a/doc/src/legal/commercialeditions.qdoc b/doc/src/legal/commercialeditions.qdoc deleted file mode 100644 index 9d7ac6b..0000000 --- a/doc/src/legal/commercialeditions.qdoc +++ /dev/null @@ -1,82 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies). -** All rights reserved. -** Contact: Nokia Corporation (qt-info@nokia.com) -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** 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. -** -** Other Usage -** Alternatively, this file may be used in accordance with the terms -** and conditions contained in a signed written agreement between you -** and Nokia. -** -** -** -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -/*! - \page commercialedition.html - \title Qt Commercial Edition - \ingroup licensing - \brief Information about the license and features of the Commercial Edition. - - Qt can be used to develop closed source software if you obtain a commercial - license. - - If you want to develop Free or Open Source software for release using a recognized - Open Source license, you can use the \l{Open Source Versions of Qt}. - - The following table is a summary of the licenses under which Qt is made available. - - \table - \row \o \bold{Qt Commercial Developer License} - \o The Qt Commercial Developer License is the appropriate version to use for the - development of proprietary and/or commercial software where the developer does not - wish to share or distribute any source code of the Qt libraries or otherwise comply - with the terms of the \l{GNU Lesser General Public License (LGPL)}{GNU Lesser General - Public License version 2.1} or \l{GNU General Public License (GPL)}{GNU GPL version - 3.0}. - \row \o \bold{Qt GNU LGPL v. 2.1} - \o This version of Qt is appropriate for the development of Qt applications - (proprietary or open source) provided you can comply with the terms and conditions - contained in the \l{GNU Lesser General Public License (LGPL)}{GNU LGPL version 2.1}. - \row \o \bold{Qt GNU GPL v. 3.0} - \o This version of Qt is appropriate for the development of Qt applications where - you wish to use such applications in combination with software subject to the terms - of the GNU General Public License version 3.0 or where you are otherwise willing to - comply with the terms of the - \l{GNU General Public License (GPL)}{GNU General Public License version 3.0}. - \endtable - - Please see the \l{Supported Platforms}{list of supported - platforms} for up-to-date information about the various platforms - and compilers that Qt supports. - - On the Qt Web site, you can find a - \l{Qt Licensing Overview} and information on \l{Qt License Pricing} - for commercial editions of Qt and other Qt-related products. - - \section1 Purchasing and Sales Information - - To purchase, please visit the \l{How to Order}{online order form}. - - For further information and assistance, please contact the Qt sales team - via one of the following channels: - - \table - \row \o Web: \o \bold{http://qt.nokia.com/contact} - \row \o Phone, U.S. office (for sales in North America): \o \bold{1-408-220-9020} - \row \o Phone, Norway office (for sales in the rest of the world): \o \bold{+47 21 60 48 00} - \endtable -*/ diff --git a/doc/src/mainpage.qdoc b/doc/src/mainpage.qdoc index 41818ee..154d14c 100644 --- a/doc/src/mainpage.qdoc +++ b/doc/src/mainpage.qdoc @@ -110,6 +110,7 @@ applications using layouts and Qt Quick interfaces with QML. \o \l{Qt Quick} - create UIs using QML \list \o \l{external: Developing Qt Quick Applications}{Creator's QML Design Mode} - design Qt Quick interfaces using Creator's design mode + \o \l{Qt Quick Components for Symbian 1.1}{Qt Quick Components for Symbian} - a native QML component set for the Symbian^3 platform \endlist \o \l{Widgets and Layouts} - primary elements for C++ based interfaces \list diff --git a/doc/src/network-programming/ssl.qdoc b/doc/src/network-programming/ssl.qdoc index 0bbcd8a..ab84a29 100644 --- a/doc/src/network-programming/ssl.qdoc +++ b/doc/src/network-programming/ssl.qdoc @@ -58,7 +58,7 @@ system: \code - ./configure -openssl-linked OPENSSL_LIBS='-L/opt/ssl/lib -lssl -lcrypto' + OPENSSL_LIBS='-L/opt/ssl/lib -lssl -lcrypto' ./configure -openssl-linked \endcode To disable SSL support in a Qt build, configure Qt with the \c{-no-openssl} diff --git a/doc/src/platforms/compiler-notes.qdoc b/doc/src/platforms/compiler-notes.qdoc deleted file mode 100644 index be149a9..0000000 --- a/doc/src/platforms/compiler-notes.qdoc +++ /dev/null @@ -1,44 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies). -** All rights reserved. -** Contact: Nokia Corporation (qt-info@nokia.com) -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** 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. -** -** Other Usage -** Alternatively, this file may be used in accordance with the terms -** and conditions contained in a signed written agreement between you -** and Nokia. -** -** -** -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -/*! - \page compiler-notes.html - \ingroup platform-specific - \title Compiler Notes - \brief Information about the C++ compilers and tools used to build Qt. - - This page used to contain information about the C++ compilers and tools - used to build Qt on various platforms. This information is now maintained - in the \l{Platform and Compiler Notes} for each platform. - - Please refer to the \l{Supported Platforms} page for information about the - status of each platform. - - If you have anything to add to this list or any of the platform or - compiler-specific pages, please submit it via the \l{Bug Report Form} - or through the \l{Public Qt Repository}. -*/ diff --git a/doc/src/platforms/platform-notes-rtos.qdoc b/doc/src/platforms/platform-notes-rtos.qdoc deleted file mode 100644 index 0b1265b..0000000 --- a/doc/src/platforms/platform-notes-rtos.qdoc +++ /dev/null @@ -1,361 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies). -** All rights reserved. -** Contact: Nokia Corporation (qt-info@nokia.com) -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** 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. -** -** Other Usage -** Alternatively, this file may be used in accordance with the terms -** and conditions contained in a signed written agreement between you -** and Nokia. -** -** -** -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -/*! - \page platform-notes-vxworks.html - \title Platform and Compiler Notes - VxWorks - \contentspage Platform and Compiler Notes - \target VxWorks - - \note VxWorks is a community supported platform. See the - \l{Supported Platforms} page for more information. - - This page contains information about the Qt for VxWorks port. More - information about the combinations of platforms and compilers supported - by Qt can be found on the \l{Supported Platforms} page. - - \tableofcontents - - \section1 Supported Versions - - Qt has been tested on WindRiver VxWorks 6.7 in kernel mode using the - vendor supplied GCC compiler, targetting both the x86 simulator - (simpentium) and Power-PC devices (ppc). - VxWorks' RTP mode is currently not supported. - - \section1 Limitations - - The VxWorks kernel has an optional POSIX compatibility layer, but this - layer does not implement all POSIX functionality needed for a complete - Qt port. - - \table - \header \o Function \o Notes - \row \o QProcess - \o Not available - VxWorks has no concept of processes. - \row \o QSharedMemory - \o Not available - VxWorks has only a global, flat address space. - \row \o QSystemSemaphore - \o Not available - VxWorks has no concept of processes. - \row \o QLibrary - \o QLibrary is only a small stub to make it possible to build - static plugins. - \row \o QCoreApplication - \o Can only be instantiated once. Qt's Q(CoreE)Application is - tightly coupled to one address space and process, while VxWorks - only supports one global address space and has no concept of - processes. - \row \o Phonon - \o There is no standard audio backend, which could be integrated into Phonon. - \row \o Qt3Support - \o The Qt3Support library is not available on VxWorks. - - \endtable - - \section1 Build Instructions - - Qt for VxWorks needs to be \l{Cross-Compiling Qt for Embedded Linux - Applications}{cross-compiled} on a Linux host. \c configure and \c make - the build like you would with a standard \l{Cross-Compiling Qt for - Embedded Linux Applications}{embedded Linux cross build}. Building the - VxWorks simulator would be done like this: - - \code - <path/to/qt/sources>/configure -xplatform unsupported/vxworks-simpentium-g++ -embedded vxworks -exceptions -no-gfx-linuxfb -no-mouse-linuxtp -no-mouse-pc -no-kbd-tty - make - \endcode - - \list - \o \c{-xplatform unsupported/qws/vxworks-simpentium-g++} - selects the x86 simulator mkspec for VxWorks - \o \c{-embedded vxworks} - builds the embedded version of Qt and sets the architecture to VxWorks - \o \c{-exceptions} - see General Notes below - \o \c{-no-gfx-linuxfb}, \c{-no-mouse-linuxtp}, \c{-no-mouse-pc} and \c{-no-kbd-tty} are Linux specific and won't work on VxWorks - \endlist - - \section1 General Notes - - \list - - \o Configuring with \c{-exceptions} is necessary, because the VxWorks - 6.7 g++ headers require exceptions to be enabled when compiling C++ - code. - - \o Configure's \c{-xplatform} can be any of - \c{unsupported/vxworks-(simpentium|ppc)-(g++|dcc)}, but \c{dcc} - (WindRiver DIAB compiler) has not yet tested been tested with Qt 4.6 and - VxWorks 6.7. - - \o Building shared libraries with \c{-shared} (the default) doesn't - really build shared libraries, like e.g. on Linux, since these are not - supported by VxWorks. Instead, qmake will created partially linked - objects, that can be loaded at runtime with \c{ld}. - - \o Creating static builds with \c{-static} is fully supported. - - \o "Munching" (generating constructors/destructors for static C++ - objects) is done automatically by a special qmake extension (for both - shared libraries and executables) - - \o VxWorks does not have a file system layer, but the low level storage - drivers have to supply a file system like interface to the applications. - Since each driver implements a different subset of the functionality - supported by this interface, Qt's file system auto-tests show wildly - differing results running on different "file systems". The best results - can be achieved when running on a (writable) NFS mount, since that - provides the most Unix-ish interface. The worst results come from the - FTP file system driver, which may crash when accessed by a - \c{QFileInfo}. - - \o Keep in mind that VxWorks doesn't call your \c{main()} function with - the standard \c{argc}/\c{argv} parameters. So either add a special - \c{vxmain()} function or use a tool like \c{callmain} to translate - VxWorks' commandline arguments to an \c{argc}/\c{argv} array. - - \o Some example will fail to build, due to some missing dependencies - (e.g. shared memory) - this will be fixed in a later release. - - \endlist -*/ - -/*! - \page platform-notes-qnx.html - \title Platform and Compiler Notes - QNX - \contentspage Platform and Compiler Notes - \target QNX - - \note QNX is a community supported platform. See the - \l{Supported Platforms} page for more information. - - This page contains information about the Qt for QNX port. More - information about the combinations of platforms and compilers supported - by Qt can be found on the \l{Supported Platforms} page. - - Note that Qt for QNX is currently based on \l{Qt for Embedded Linux}, which - contains its own windowing system. Mixing QNX's Photon environment with - Qt for QNX is currently not possible. Building Qt for QNX with Photon's - X11 embedded server is not recommended due to missing support for X11 extensions, - resulting in poor rendering quality. - - Qt for QNX contains screen and input drivers based on QNX's - \c devi-hid and \c io-display. For more information, check the class documentation - for QQnxScreen, QWSQnxKeyboardHandler and QQnxMouseHandler. See the - \l{Porting Qt for Embedded Linux to a New Architecture} document for information - on how to add custom screen or input drivers. - - \tableofcontents - - \section1 Supported Versions - - Qt has been tested on QNX 6.5 on i386, ARM/ARM-v7 and PowerPC targets with QNX's default - gcc compiler. - - \section1 Limitations - - Some of Qt's functionality is currently not available on QNX: - - \table - \header \o Function \o Notes - \row \o Phonon - \o There is no standard audio backend, which could be integrated into Phonon. - \row \o QtMultimedia - \o There is no standard backend, which could be integrated into QtMultimedia. - \row \o QtDBus - \o The the QtDBus library is not available on QNX. - \row \o Qt3Support - \o The Qt3Support library is not available on QNX. - \endtable - - \section1 Build Instructions - - Qt for QNX needs to be built either on a QNX system, or \l{Cross-Compiling Qt - for Embedded Linux Applications}{cross-compiled} on a Linux host. In either - case, The QNX Software Development Platform must be installed. - - Example configure line for cross-compiling Qt for QNX on a Linux host for an - i386 QNX target: - - \code - configure -xplatform unsupported/qws/qnx-i386-g++ -embedded x86 -no-gfx-linuxfb -no-mouse-linuxtp -no-kbd-tty -no-qt3support -qt-mouse-qnx -qt-kbd-qnx -qt-gfx-qnx -depths 16,24,32,generic -no-exceptions - \endcode - - \list - \o \c{-xplatform unsupported/qws/qnx-i386-g++} - selects the i386-g++ mkspec for QNX - \o \c{-embedded x86} - builds the embedded version of Qt and sets the architecture to i386 - \o \c{-no-gfx-linuxfb}, \c{-no-mouse-linuxtp} and \c{-no-kbd-tty} are Linux specific and won't work on QNX - \o \c{-no-qt3support} - required since the Qt3 support classes are not supported on QNX - \o \c{-no-exceptions} - reduces the size of the library by disabling exception support - \o \c{-qt-mouse-qnx} - enables the \c{devi-hid} based mouse driver - \o \c{-qt-kbd-qnx} - enables the \c{devi-hid} based keyboard driver - \o \c{-qt-gfx-qnx} - enables the \c{io-graphics} based screen driver - \o \c{-depths 16,24,32,generic} - enables all modes supported by the QNX screen driver - \endlist - - \section1 General Notes - - \list - \o To enable the QNX screen and input drivers, \c{io-display} needs to be - up and running. The \c devi-hid based Qt input drivers require \c devi-hid to run - in resource mode without Photon support. To enable a standard mouse and keyboard - combination, run \c devi-hid as follows: \c{/usr/photon/bin/devi-hid -Pr kbd mouse}. - Note that your current shell will not accept keyboard and mouse input anymore after - running that command, so run it either from a script that launches a Qt application - afterwards, or make sure to have remote login available to launch a Qt application. - In addition, the \c QWS_DISPLAY, \c QWS_MOUSE_PROTO and \c QWS_KEYBOARD environment - variables should all be set to \c{qnx} before running a Qt application. - - \o The 3rd party TIFF library currently doesn't build due to the missing \c inflateSync - symbol from QNX's \c{libz.so.2}. Workarounds would be to manually replace QNX's libz - with a newer version, or disable the TIFF plugin entierly by appending - \c{QT_CONFIG += no-tiff} to \c{.qmake.cache} after configuring Qt. - - \o Some of the tools, examples and demos do not compile due to dependencies on classes - that are not available on QNX. - \endlist - - \section1 Platform Regressions - - Qt for QNX's behavior is mostly identical with \l{Qt for Embedded Linux}. However, - some regressions were spotted in QDateTime computation around year 0 and year 1970, - which have been tracked back to faulty time zone data on some QNX versions. - - QString::localeAwareCompare() only works for C locale. - - QTranslator's default locale-based fallback mechanism doesn't work. - - QSystemSemaphore: Due to POSIX semaphores limitations, the semaphore operations aren't - automatically undone when the process terminates. This potentially may lead to unexpected - lock-ups in applications which does use the SysV semaphores behavior. -*/ - -/*! - \page platform-notes-integrity.html - \title Platform Notes - INTEGRITY - \contentspage Platform Notes - \target INTEGRITY - - \note INTEGRITY is a community supported platform. See the - \l{Supported Platforms} page for more information. - - This page contains information about the Qt for INTEGRITY port. More - information about the combinations of platforms and compilers supported - by Qt can be found on the \l{Supported Platforms} page. - - Note that Qt for INTEGRITY is currently based on \l{Qt for Embedded Linux}, - which contains its own windowing system. - - Qt for INTEGRITY contains experimental screen and input drivers based on the - gh_FB Framebuffer API for graphics, a Connection-based mouse and keyboard - support. For information about these drivers, please refer to Green Hills - Software standard support. - - \tableofcontents - - \section1 Supported Versions - - Qt has been tested on INTEGRITY 10 on various PowerPC, ARM and x86 targets. - On some platforms a native graphics FrameBuffer driver is available and has - then been used for testing. On all other platforms, the default FrameBuffer - VNC driver is used. - - \section1 Limitations - - Some of Qt's functionality is currently not available on INTEGRITY: - - \table - \header \o Function \o Notes - \row \o QProcess - \o Not implemented. Volunteers welcome. - \row \o QSharedMemory - \o Not available - INTEGRITY doesn't support SYSV style shared memory. - \row \o QSystemSemaphore - \o Not available - INTEGRITY doesn't support SYSV style system semaphores. - \row \o QWS Multi Process - \o QT_NO_QWS_MULTIPROCESS is always on due to missing shared memory support. - \row \o Phonon - \o There is no standard audio backend. - \row \o Qt3Support - \o The Qt3Support library is not available on INTEGRITY. - \row \o QtScript - \o Not available - INTEGRITY's mmap() doesn't support allocating memory. - \endtable - - \section1 Build Instructions - - Qt for INTEGRITY can be built on either a Linux or Windows (with cygwin) host. - In both cases, a standard installation of INTEGRITY is required, with the - addition of the FrameBuffer API. - - Example configure line for cross-compiling Qt for INTEGRITY for an - ARM INTEGRITY target: - - \code - ./configure --hostprefix=$PWD -embedded integrity -xplatform unsupported/qws/integrity-arm-cxarm -static -qt-kbd-integrity -qt-mouse-integrity -no-mouse-linuxtp -no-mouse-pc -no-kbd-tty -qt-gfx-integrityfb -no-qt3support -no-gfx-linuxfb -no-glib -no-openssl -no-largefile -little-endian -arch integrity -prefix / -opensource -no-feature-QWS_MULTIPROCESS -no-feature-SHAREDMEMORY -no-feature-PROCESS -no-feature-SYSTEMSEMAPHORE -no-feature-PRINTER -no-feature-QWS_QPF2 -no-scripttools - \endcode - - \list - \o \c{--hostprefix=$PWD} - specifies the current directory as the base source for Qt - \o \c{-arch integrity} - sets the architecture to INTEGRITY (for atomic operations) - \o \c{-embedded integrity} - builds the embedded version of Qt and sets the architecture to INTEGRITY - \o \c{-xplatform unsupported/qws/integrity-arm-cxarm} - selects the arm-cxarm mkspec for INTEGRITY - \o \c{-static} - specifies a static build of Qt - \o \c{-no-gfx-linuxfb}, \c{-no-mouse-linuxtp}, \c{-no-mouse-pc} and \c{-no-kbd-tty} are Linux specific and won't work on INTEGRITY - \o \c{-no-qt3support} - required since the Qt3 support classes are not supported on INTEGRITY - \o \c{-no-exceptions} - reduces the size of the library by disabling exception support - \o \c{-no-openssl} - disable support for OpenSSL - \o \c{-no-glib} - disable support for unavailable Glib - \o \c{-no-largefile} - disable support for large (> 2TB) files - \o \c{-no-scripttools} - disable support for QtScript tools - \o \c{-qt-gfx-integrity} - enables the experimental gh_FB based display driver - \o \c{-qt-mouse-integrity} - enables the experimental Connection-based mouse driver - \o \c{-qt-kbd-integrity} - enables the experimental Connection-based keyboard driver - \endlist - - The above script will generate MULTI .gpj Project files, not Makefiles. The - main benefit of using these project files is automatic dependency checking, - but this also provides an organization known to INTEGRITY customers. - For Qt libraries, the top-level file is projects.gpj. - - \section1 General Notes - - \list - \o Before you run the above configure line, you may want to modify the values - of INTEGRITY_DIR and INTEGRITY_BSP in unsupported/qws/integrity-arm-cxarm/qmake.conf. - If you do not do this, you will have to modify the resulting generated projects.gpj - - \o GIF support is currently not enabled. - - \o Default .int files are generated. You may want to modify the amount of heap assigned - to each example by modifying the HeapSize declaration in the specific example .int file. - - \o Some of the tools, examples and demos do not compile due to dependencies on QProcess - or other classes that are not available on INTEGRITY. - - \endlist - - \section1 Platform Regressions - -*/ diff --git a/doc/src/platforms/platform-notes.qdoc b/doc/src/platforms/platform-notes.qdoc index 477f125..0022704 100644 --- a/doc/src/platforms/platform-notes.qdoc +++ b/doc/src/platforms/platform-notes.qdoc @@ -50,632 +50,10 @@ supported by Qt can be found on the \l{Supported Platforms} page. \list - \o \l{Platform and Compiler Notes - X11} - \tableofcontents{1 Platform and Compiler Notes - X11} - \o \l{Platform and Compiler Notes - Windows} - \tableofcontents{1 Platform and Compiler Notes - Windows} - \o \l{Platform and Compiler Notes - Mac OS X} - \tableofcontents{1 Platform and Compiler Notes - Mac OS X} \o \l{Platform and Compiler Notes - Symbian} \tableofcontents{1 Platform and Compiler Notes - Symbian} - \o \l{Platform and Compiler Notes - Embedded Linux} - \tableofcontents{1 Platform and Compiler Notes - Embedded Linux} - \o \l{Platform and Compiler Notes - Windows CE} - \tableofcontents{1 Platform and Compiler Notes - Windows CE} - \o \l{Platform and Compiler Notes - QNX} - \tableofcontents{1 Platform and Compiler Notes - QNX} - \o \l{Platform and Compiler Notes - VxWorks} - \tableofcontents{1 Platform and Compiler Notes - VxWorks} \endlist - \section1 General Compiler Notes - - \section2 Supported Features - - Not all compilers used to build Qt are able to compile all modules. The following table - shows the compiler support for five modules that are not uniformly available for all - platforms and compilers. - - \table - \header \o Compiler \o{5,1} Features - \header \o \o Concurrent \o XmlPatterns \o WebKit(*) \o CLucene \o Phonon - \row \o g++ 3.3 \o \o \bold{X} \o \o \bold{X} \o \bold{X} - \row \o g++ 3.4 and up \o \bold{X} \o \bold{X} \o \bold{X} \o \bold{X} \o \bold{X} - \row \o SunCC 5.5 \o \o \o \o \bold{X} \o \bold{X} - \row \o aCC series 3 \o \o \o \o \bold{X} \o \bold{X} - \row \o aCC series 6 \o \bold{X} \o \bold{X} \o \bold{X} \o \bold{X} \o \bold{X} - \row \o xlC 6 \o \o \o \o \bold{X} \o \bold{X} - \row \o Intel CC 10 \o \bold{X} \o \bold{X} \o \bold{X} \o \bold{X} \o \bold{X} - \row \o MSVC 2003 \o \bold{X} \o \bold{X} \o \o \bold{X} \o \bold{X} - \row \o MSVC 2005 and up \o \bold{X} \o \bold{X} \o \bold{X} \o \bold{X} \o \bold{X} - \endtable - - * WebKit is only supported as a dynamically built library. Static linkage is not supported. - - \section2 GCC 3.4.6 (Debian 3.4.6-5) on AMD64 (x86_64) - - This compiler is known to miscompile some parts of Qt when doing a - release build. There are several workarounds: - - \list 1 - \o Use a debug build instead. - \o For each miscompilation encountered, recompile the file, removing the \c{-O2} option. - \o Add \c{-fno-gcse} to the - \l{qmake Variable Reference#QMAKE_CXXFLAGS_RELEASE}{QMAKE_CXXFLAGS_RELEASE} qmake - variable. - \endlist - - \section2 GCC 4.0.0 - - The released package of the compiler has some bugs that lead to - miscompilations. We recommend using GCC 4.0.1 or later, or to use - a recent CVS snapshot of the GCC 4.0 branch. The version of GCC - 4.0.0 that is shipped with Mac OS X 10.4 "Tiger" is known to work - with Qt for Mac OS X. - - \section2 Intel C++ Compiler - - Qt supports the Intel C++ compiler on both Windows and Linux. - However, there are a few issues on Linux; see - \l{Platform and Compiler Notes - X11#Intel C++ Compiler for Linux}{Intel C++ Compiler for Linux} - for details. - - \section1 Feedback and Corrections - - If you have anything to add to this list or any of the platform or - compiler-specific pages, please submit it via the \l{Bug Report Form} - or through the \l{Public Qt Repository}. -*/ - -/*! - \page platform-notes-x11.html - \title Platform and Compiler Notes - X11 - \contentspage Platform and Compiler Notes - - This page contains information about the X11 platforms Qt is currently - known to run on, with links to platform-specific notes. More information - about the combinations of platforms and compilers supported by Qt can be - found on the \l{Supported Platforms} page. - - \tableofcontents - - \target AIX - \section1 AIX - 5.2 - - Qt has been tested on AIX 5.2, using the xlC compiler. - - \table - \header \o Compiler \o Notes - \row \o xlC - \o If Qt is built correctly but all symbols are reported to be missing - when you link an application, your makeC++SharedLib script might be out - of date. Make sure you have the latest version from the - \l{http://www-306.ibm.com/software/awdtools/vacpp/support/}{IBM website}. - \row \o GCC - \o We have tested earlier versions of Qt 4 successfully with GCC version - 3.3 and above. Some versions of GCC may fail to link Qt with a "TOC overflow" - message. - Fix this by upgrading to the latest maintenance release of the dynamic - linker. On AIX this is bos.rte.bind_cmds.4.1.5.3 or later. - Some versions of GCC may fail to build Qt with STL and large-file support - enabled, due to - \l{http://gcc.gnu.org/bugzilla/show_bug.cgi?id=9551}{a bug in GCC}. - Fix this by upgrading to the latest maintenance release of the compiler. - It is also possible to work around this problem by running configure with - either \c{-no-stl} or \c{-no-largefile}. - \endtable - - \section2 IBM xlC - - The makeC++SharedLib utility must be in your PATH and be up to date to - build shared libraries. From IBM's - \l{http://www.redbooks.ibm.com/abstracts/sg245674.html}{C and C++ Application Development on AIX} - Redbook: - - \list - \o "The second step is to use the makeC++SharedLib command to create the - shared object. The command has many optional arguments, but in its - simplest form, can be used as follows:" - \snippet doc/src/snippets/code/doc_src_compiler-notes.qdoc 1 - \o "The full path name to the command is not required; however, to avoid - this, you will have to add the directory in which it is located to - your PATH environment variable. The command is located in the - /usr/vacpp/bin directory with the VisualAge C++ Professional for AIX, - Version 5 compiler." - \endlist - - \section2 VisualAge C++ for AIX, Version 6.0 - - Make sure you have the - \l{http://www-1.ibm.com/support/search.wss?rs=32&tc=SSEP5D&dc=D400}{latest upgrades} - installed. - - \target FreeBSD - \section1 FreeBSD - 6.0-RELEASE - - \note FreeBSD is a community supported platform. See the - \l{Supported Platforms} page for more information. - - The system compiler on FreeBSD 4.x is GCC 2.95.4, which is not - officially supported by Qt 4. We develop using and recommend - ports/lang/gcc34. You will need to run configure with the - \c{-platform freebsd-g++34} arguments. Optionally, you may use - ports/lang/icc. - - The system compiler on FreeBSD 5.x and 6.x is GCC 3.4.4, which should be - sufficient to build Qt. You do not need to add any special arguments when - running configure. Optionally, you may use ports/lang/icc. - - Note that we do not actively test FreeBSD 4.x and 5.x. Our developers - migrated to 6.x after the Qt 4 launch. FreeBSD-CURRENT is not supported. - - \section1 HP-UX - - Qt supports HP-UX on both PA-RISC and the Itanium (IA64) architectures. - - \section2 PA-RISC - B.11.11 or later - - You can configure Qt for aCC in 32 and 64 bit mode (hpux-acc-64 or - hpux-acc-32), or GCC in 32 bit mode (hpux-g++). The default platform is - hpux-acc-32. The minimum required version for aCC (HP ANSI C++) on PA-RISC - is A.03.57. The supported GCC compiler is GCC 3.4.3. - - \section2 Itanium - B.11.23 or later - - You can configure Qt for aCC in 32 and 64 bit mode (hpuxi-acc-64 or - hpuxi-acc-32). GCC is currently unsupported. The default platform is - hpuxi-acc-64. The minimum required version for aCC (HP ANSI C++) on - Itanium is A.06.12. - - \section2 HP ANSI C++ (aCC) - - The hpux-acc-32 and hpux-acc-64 platforms are tested with aCC A.03.57. The - hpuxi-acc-32 and hpuxi-acc-64 platforms are tested with aCC A.06.10. - - \section2 GCC - - The hpux-g++ platform is tested with GCC 3.4.4. - - \section2 OpenGL Support - - Qt's \l{QtOpenGL}{OpenGL} module requires GLX 1.3 or later to be installed. - This is available for HP-UX 11i - see the - \l{http://docs.hp.com/en/5992-2331/ch04s02.html}{Graphics and Technical Computing Software} - section of the release notes for more information. - - \target IRIX - \section1 IRIX - 6.5.x - - \bold{IRIX is an unsupported platform. See the \l{Supported Platforms} page - and Qt's Software's online \l{Platform Support Policy} page for details.} - - Unpackaging and IRIX tar: - Because of long filenames some files will be cut off incorrectly with IRIX - tar. Please use GNU tar to unpack Qt packages. - - \section2 MIPSpro - - Qt 4.4.x requires MIPSpro version 7.4.2m. - - Note that MIPSpro version 7.4.4m is currently not supported, since it has - introduced a number of problems that have not yet been resolved. - We recommend using 7.4.2m for Qt development. However, please note the - unsupported status of this platform. - - \section1 Linux - - There are no known problems with using Qt on production versions of - Linux/x86, Linux/ppc, Linux/amd64 and Linux/ia64 (including Altix(R)). - - For the GCC compiler, please also see the relevant - \l{Platform and Compiler Notes#General Compiler Notes}{General Compiler Notes}. - - \section2 Installation problems - - See also the \l{Installation FAQ}. - - If you experience problems when installing new open source versions of Qt - versions, try to use the open source Qt archives (e.g., RPM) - provided by your Linux distribution. If you need to install the source (.tgz) - archive, be aware that you will probably end up with two different - versions of the Qt library installed on your system, which will probably - lead to link errors, like this: - \snippet doc/src/snippets/code/doc_src_platform-notes.qdoc 0 - Fix this by removing the old version of the library. - - If you have problems installing open source versions of Qt - provided by your Linux distribution (e.g., RPM), please consult the - maintainers of the distribution, not us. - - Some RPM versions have problems installing some of the Qt RPM archives - where installation stops with an error message warning about a - "Failed Dependency". Use the \c{--nodeps} option to \c rpm to workaround - this problem. - - \section2 Intel C++ Compiler for Linux - - Nokia currently tests the following compilers: - - \list - - \o Intel(R) C++ Compiler for applications running on IA-32, - Version 10.1 Build 20080602 Package ID: l_cc_p_10.1.017 - - \o Intel(R) C++ Compiler for applications running on Intel(R) 64, - Version 10.1 Build 20080602 Package ID: l_cc_p_10.1.017 - - \endlist - - We do not currently test the IA-64 (Itanium) compiler. - - \section2 Known Issues with Intel C++ Compiler for Linux - - \list - - \o Precompiled header support does not work in version 10.0.025 - and older. For these compilers, you should configure Qt with - -no-pch. Precompiled header support works properly in version - 10.0.026 and later. - \o Version 10.0.026 for Intel 64 is known to miscompile qmake when - building in release mode. For now, configure Qt with - -debug. Version 10.1.008 and later can compile qmake in release - mode. - \o Versions 10.1.008 to 10.1.015 for both IA-32 and Intel 64 are - known crash with "(0): internal error: 0_47021" when compiling - QtXmlPatterns, QtWebKit, and Designer in release mode. Version - 10.1.017 compiles these modules correctly in release mode. - \endlist - - \target Solaris - \section1 Solaris - 9 or later - - \section2 Unpackaging and Solaris tar - - On some Solaris systems, both Solaris tar and GNU tar have been reported - to truncate long filenames. We recommend using star instead - (http://star.berlios.de). - - Please note that WebKit is not supported for Solaris, regardless of - which compiler is used. - - \section2 CC - - See the notes for \l{Forte Developer / Sun Studio}. - - \section2 GCC - - Please use GCC 3.4.2 or later. - - Do not use GCC with Sun's assembler/linker, this will result in link-time - errors in shared libraries. Use GNU binutils instead. - - GCC 3.2.* is known to miscompile Qt due to an optimizer bug that will - cause the resulting binaries to hang. - - \section2 Forte Developer / Sun Studio - - Qt is tested using Sun Studio 12 (Sun CC 5.9). Go to - \l{Sun Studio Patches} page on Sun's Web site to download - the latest patches for your Sun compiler. - - Please note that Qt 4.6 is stricter in its STL requirements and - that the default STL implementation used by Sun CC does not pass - those requirements. This does not affect binary compatibility and - you can continue to use STL in your own code, but Qt's - STL-compatibility functions will be disabled. - - Sun CC ships with a secondary STL implementation (called stlport4) - which is standards-compliant and can be used by Qt. You can enable - it by passing the -library=stlport4 option to the compiler. Note - that this does not affect Qt's binary compatibility, but it may - affect that of other libraries and programs that use STL. - - \section2 Sun WorkShop 5.0 - - Sun WorkShop 5.0 is not supported with Qt 4. -*/ - -/*! - \page platform-notes-windows.html - \title Platform and Compiler Notes - Windows - \contentspage Platform and Compiler Notes - - This page contains information about the Windows platforms Qt is currently - known to run on, with links to platform-specific notes. More information - about the combinations of platforms and compilers supported by Qt can be - found on the \l{Supported Platforms} page. - - \tableofcontents - - \section1 Windows Vista - - At the time Qt %VERSION% was released, there were no known Vista-specific issues. - - \target Windows NT - \section1 Windows XP, Windows 2000 and Windows NT - - \section2 Installation location - - Installing Qt into a directory with spaces, e.g. C:\\Program Files, may - cause linker errors like the following: - \snippet doc/src/snippets/code/doc_src_platform-notes.qdoc 2 - - Install Qt into a subdirectory without spaces to avoid this problem. - - \section2 Possible GL conflict - - There is a known issue with running Microsoft NetMeeting, Lotus SameTime - and other applications that require screen grabbing while direct - rendering is enabled. Other GL-applications may not work as expected, - unless direct rendering is disabled. - - \section2 GCC (MinGW) - - We have tested Qt with this compiler on Windows XP. - The minimal version of MinGW supported is GCC 4.4. - - \note For users of the MinGW binary package: This package is now - based on MinGW 4.4. The installer no longer offers to download - MinGW for you, but rather offers to use a version of MinGW that - you already have installed on your machine. You just tell the - installer which directory MinGW is installed in. If you don't - already have MinGW 4.4 installed, you can download a .zip archive - from our \l{ftp://ftp.trolltech.com/misc/MinGW-gcc440_1.zip}{FTP - site}. This archive provides fixes to MinGW and support for - missing API, See the _patches directory in the archive for - details. - - \note A MinGW installation is only needed to build against the - binary package, not to run the pre-compiled binaries that are in - the package. - - \section2 Intel C++ Compiler (Windows, Altix) - - Qt 4 has been tested successfully with: - - \list - \o Windows - Intel(R) C++ Compiler for 32-bit applications, - Version 9.1.040. - \o Altix - Intel(R) C++ Itanium(R) Compiler for Itanium(R)-based - applications Version 8.1 Build 20050406 Package ID: l_cc_pc_8.1.030 - \endlist - - We currently only test the Intel compiler on 32-bit Windows versions. - - \section2 Visual Studio (Windows) - - We do most of our Windows development on Windows XP, using Microsoft - Visual Studio .NET 2005 and Visual Studio 2008 (both the 32- and 64-bit - versions). - - Qt works with the Standard Edition, the Professional Edition and Team - System Edition of Visual Studio 2005. - - In order to use Qt with the Visual Studio 2005/2008 Express Edition you need - to download and install the platform SDK. Due to limitations in the - Express Edition it is not possible for us to install the Qt Visual - Studio Integration. You will need to use our command line tools to - build Qt applications with this edition. - - The Visual C++ Linker doesn't understand filenames with spaces (as in - \c{C:\Program files\Qt\}) so you will have to move it to another place, - or explicitly set the path yourself; for example: - - \snippet doc/src/snippets/code/doc_src_compiler-notes.qdoc 0 - - If you are experiencing strange problems with using special flags that - modify the alignment of structure and union members (such as \c{/Zp2}) - then you will need to recompile Qt with the flags set for the - application as well. - - If you're using Visual Studio .NET (2002) Standard Edition, you should be - using the Qt binary package provided, and not the source package. - As the Standard Edition does not optimize compiled code, your compiled - version of Qt would perform suboptimally with respect to speed. - - With Visual Studio 2005 Service Pack 1 a bug was introduced which - causes Qt not to compile, this has been fixed with a hotfix available - from Microsoft. See this - \l{http://qt.nokia.com/developer/faqs/faq.2006-12-18.3281869860}{Knowledge Base entry} - for more information. - - There currently is a problem when compiling Qt with Visual Studio 2010 for 64-bit. - Its optimizer causes trouble and generates code that crashes for the release builds. - To avoid the crashes, You need to apply the hotfix in the following article - http://support.microsoft.com/kb/2280741. -*/ - -/*! - \page platform-notes-mac.html - \title Platform and Compiler Notes - Mac OS X - \contentspage Platform and Compiler Notes - - This page contains information about the Mac OS X versions Qt is currently - known to run on, with links to platform-specific notes. More information - about the combinations of platforms and compilers supported by Qt can be - found on the \l{Supported Platforms} page. - - \tableofcontents - - \section1 General Information - - Qt 4.6 applications can only be deployed on Mac OS X 10.4 (Tiger) - and higher. - - Qt 4.4 and Qt 4.5 development is only supported on Mac OS X 10.4 and up. - Applications built against these version of Qt can be deployed on Mac OS X - 10.3, but cannot be developed on that version of the operating system due - to compiler issues. - - Qt 4.3 has been tested to run on Mac OS X 10.3.9 and up. See notes on - the binary package for more information. - - Qt 4.1 has been tested to run on Mac OS X 10.2.8 and up. Qt 4.1.4 is the - last release to work with Mac OS X 10.2. - - \section2 Required GCC version - - Apple's GCC 4 that is shipped with the Xcode Tools for both Mac OS X 10.4 - and 10.5 will compile Qt. There is preliminary support for GCC 4.2 which - is included with Xcode Tools 3.1+ (configurable with - \c{-platform macx-g++42}). - - Please use the latest GCC 3.3 from Apple or a later version of GCC 3. - The GCC 3.3 that is provided with Xcode 1.5 is known to generate bad code. - Use the November 2004 GCC 3.3 updater \l{http://connect.apple.com}{available from Apple}. - - \section2 Binary Package - - The binary package requires that you have your .qt-license file in your - home directory. Installer.app cannot complete without a valid .qt-license - file. Evaluation users of Qt will have information about how to create - this file in the email they receive. - - The binary package was built on Mac OS X 10.4 with Xcode Tools 2.1 - (GCC 4.0.0) for Qt 4.1.0, Xcode Tools 2.2 (GCC 4.0.1) for Qt 4.1.1-4.1.4 - and Xcode Tools 2.3 for 4.2.0. It will only link executables built - against 10.4 (or a 10.4 SDK). You should be able to run applications - linked against these frameworks on Mac OS X 10.3.9 and Mac OS X 10.4+. - If you require a different configuration, you will have to use the - source package and build with GCC 3.3. - - \section2 Mac OS X on Intel hardware - - Qt 4 fully supports both the Intel and PowerPC architectures on the Mac. - As of Qt 4.1 it is possible to support the Intel architecture by - creating Universal Binaries with qmake. As of Qt 4.1 it is possible to - build Qt as a set of universal binaries and frameworks from configure by - adding these extra flags: - - \snippet doc/src/snippets/code/doc_src_platform-notes.qdoc 3 - - If you are building on Intel hardware you can omit the sdk parameter, but - PowerPC hardware requires it. - - You can also generate universal binaries using qmake. Simply add these - lines to your .pro file: - - \snippet doc/src/snippets/code/doc_src_platform-notes.qdoc 4 - - \section2 Build Issues - - If Qt does not build upon executing make, and fails with an error message - such as - - \snippet doc/src/snippets/code/doc_src_platform-notes.qdoc 5 - - this could be an indication you have upgraded your version of Mac OS X - (e.g. 10.3 to 10.4), without upgrading your Developer Tools (Xcode Tools). - These must match in order to successfully compile files. - - Please be sure to upgrade both simultaneously. If problems still occur, - contact support. - - \section2 Fink - - If you have installed the Qt for X11 package from \l{Fink}, - it will set the QMAKESPEC environment variable to darwin-g++. This will - cause problems when you build the Qt for Mac OS X package. To fix this, simply - unset your QMAKESPEC or set it to macx-g++ before you run configure. - You need to have a fresh Qt distribution (make confclean). - - \section2 MySQL and Mac OS X - - There seems to be a issue when both -prebind and -multi_module are - defined when linking static C libraries into dynamic library. If you - get the following error message when linking Qt: - - \snippet doc/src/snippets/code/doc_src_platform-notes.qdoc 6 - - re-link Qt using -single_module. This is only a problem when building the - MySQL driver into Qt. It does not affect plugins or static builds. - - \section2 Qt and Precompiled Headers (PCH) - - Starting with Qt 3.3.0 it is possible to use precompiled headers. They - are not enabled by default as it appears that some versions of Apple's - GCC and make have problems with this feature. If you want to use - precompiled headers when building the Qt source package, specify the - -pch option to configure. If, while using precompiled headers, you - encounter an internal compile error, try removing the -include header - statement from the compile line and trying again. If this solves the - problem, it probably is a good idea to turn off precompiled headers. - Also, consider filing a bug report with Apple so that they can - improve support for this feature. - - \section2 Attributes - The following lists a set of useful attributes that can be used to tweak applications - on Mac: - - Qt::AA_MacPluginApplication, Qt::AA_DontUseNativeMenuBar, Qt::AA_MacDontSwapCtrlAndMeta - Qt::WA_MacNoClickThrough, Qt::WA_MacOpaqueSizeGrip, Qt::WA_MacShowFocusRect, - Qt::WA_MacNormalSize, Qt::WA_MacSmallSize, Qt::WA_MacMiniSize, Qt::WA_MacVariableSize, - Qt::WA_MacBrushedMetal, Qt::WA_MacAlwaysShowToolWindow, Qt::WA_MacFrameworkScaled, - Qt::WA_MacNoShadow, Qt::Sheet, Qt::Drawer, Qt::MacWindowToolBarButtonHint, - QMainWindow::unifiedTitleAndToolBarOnMac, WA_MacNoCocoaChildWindow - - \section2 Mixing Qt with native code - Two classes are awailable for either adding native Cocoa views/controls - inside a Qt application, or the opposite, embedding Qt into a native - Cocoa application: - - QMacCocoaViewContainer, QMacNativeWidget - - \section3 Using native Cocoa panels - Launching native Cocoa panels from within a Qt application can sometimes - be problematic. The reason is that Qt's event dispatcher is more flexible - than what Cocoa offers, and lets the user spin the event dispatcher (and - running QEventLoop::exec) without having to think about whether or not modal - dialogs are showing on screen (which is a difference to Cocoa). Therefore - we need to do special bookkeeping in Qt to handle this correctly, which - unfortunately make mixing in native panels hard. The best way at the moment - to do this, is to follow the pattern below, where we post the call to the - function with native code rather than calling it directly. Then we know that - Qt has cleanly updated any pending event loop recursions before the native - panel is shown: - - \code - #include <QtGui> - - class NativeProxyObject : public QObject - { - Q_OBJECT - public slots: - void execNativeDialogLater() - { - QMetaObject::invokeMethod(this, "execNativeDialogNow", Qt::QueuedConnection); - } - - void execNativeDialogNow() - { - NSRunAlertPanel(@"A Native dialog", @"", @"OK", @"", @""); - } - - }; - - #include "main.moc" - - int main(int argc, char **argv){ - QApplication app(argc, argv); - NativeProxyObject proxy; - QPushButton button("Show native dialog"); - QObject::connect(&button, SIGNAL(clicked()), &proxy, SLOT(execNativeDialogLater())); - button.show(); - return app.exec(); - } - - \endcode -*/ - -/*! - \page platform-notes-windows-ce.html - \title Platform and Compiler Notes - Windows CE - \contentspage Platform and Compiler Notes - - This page contains information about the Windows CE and Windows Mobile - platforms Qt is currently known to run on, with links to platform-specific - notes. More information about the combinations of platforms and compilers - supported by Qt can be found on the \l{Supported Platforms} page. */ /*! @@ -685,9 +63,10 @@ \ingroup platform-specific \brief Information about the state of support for the Symbian platform. - As with any port, the maturity for Qt for Symbian has not yet reached the - same level as other established Qt ports. This page documents the current - notes for the Symbian port. + This page describes implementation details regarding the Qt for Symbian port. To get + started with application development for Symbian devices, read the \l + {http://doc.qt.nokia.com/qtcreator/creator-developing-symbian.html} + {Connecting Symbian Devices} document. \section1 Source Compatibility @@ -698,55 +77,109 @@ \section1 Binary Compatibility - As with every supported platform, we will strive to maintain - application behavior and binary compatibility throughout the lifetime of - the Qt 4.x series. However, due to the fact that Symbian support is newly - added in 4.6.0, there is a slight possibility that minor corrections to the - application binary interface (ABI) might be required in 4.6.1, in order to - ensure compatibility going forward. Any such change will be clearly - documented in the release notes for 4.6.1. - + As with every supported platform, Qt strives to maintain application + behavior and binary compatibility throughout the lifetime of the Qt 4.x + major version and on the \l {Supported Devices}{Symbian devices that support Qt}. + Symbian support in Qt SDK and Ovi Store were introduced with Qt 4.6. Each Qt + release contains bug fixes that might change the API behavior and thereby + affect application compatibility. + + In addition, Symbian devices have different input methods, such as different + keyboard styles or touch input, screen sizes, memory, and CPU and GPU + capabilities. Therefore, you must test applications on specific target + devices to ensure compatibility. In order to build applications that are + supported also on earlier devices, select the target in Qt SDK carefully. + Generally, an earlier target (such as S60 5th Edition) is supported on a + larger number of devices than a later target (such as Symbian Belle). + + \target Supported Devices \section1 Supported Devices + + The \l {http://developer.qt.nokia.com/wiki/support_for_Symbian}{Support for Symbian} document + details the Qt support on different Symbian devices. - See the list of supported devices at - http://wiki.forum.nokia.com/index.php/Nokia_Smart_Installer_for_Symbian#Supported_Devices - - \section1 Supported Functionality + The \l {http://www.developer.nokia.com/Community/Wiki/Nokia_Smart_Installer_for_Symbian#Supported_Devices} + {Nokia Smart Installer for Symbian} document lists how Qt is supported on + different Symbian devices through Smart Installer. - The following technologies and classes are not currently supported: + Qt versions are supported by Symbian devices as follows: + \list + \o Qt 4.6 is supported by S60 3rd Edition feature pack 1 and newer devices + through \l {http://www.developer.nokia.com/Community/Wiki/Nokia_Smart_Installer_for_Symbian}{Smart Installer}. + \o Qt 4.7.3 is supported by S60 5th Edition and newer devices + through \l {http://www.developer.nokia.com/Community/Wiki/Nokia_Smart_Installer_for_Symbian}{Smart Installer}. + \endlist + + Symbian devices have a pre-installed Qt support as follows: + \list + \o Symbian Anna: Qt 4.7.3 in C: drive. Note that Qt 4.7.4 is supported in Symbian Anna + through \l {http://www.developer.nokia.com/Community/Wiki/Nokia_Smart_Installer_for_Symbian}{Smart Installer}. + \o Symbian Belle: Qt 4.7.4 in device firmware (ROM). + \endlist + - \table - \header \o Technology - \o Note - \row \o QtConcurrent - \o Planned for future release. - \row \o QtDBus - \o No current plans to support this feature. - \row \o Printing support - \o No current plans to support this feature. - \row \o Qt3Support - \o No current plans to support this feature. - \endtable + \section1 Functionality Support + The following technologies and classes are not supported: + \list + \o QtConcurrent + \o QtDBus + \o \l {http://doc.qt.nokia.com/4.8/printing.html}{Printing support} + \o Qt3Support + \endlist + The following technologies have limited support: + \table - \header \o Technology + \header \o Module \o Note \row \o QtSql - \o The only driver supported is SQLite. + \o The supported drivers are SQLite and QSYMSQL. \row \o QtMultimedia - \o Although the module itself is supported, no backend for Symbian - is currently available. However, there is a backend available - for Phonon. + \o For support details see \l {Multimedia Support} section. + \row \o QtGui + \o QtGui's widgets are deprecated (i.e. they are available but not + recommended to use) in the Symbian port. It is recommended to use \l + {http://doc.qt.nokia.com/qt-components-symbian-1.1/symbian-components-functional.html} + {Qt Quick Components for Symbian} instead, because they provide + better look and feel on Symbian devices. + + Moreover, the following classes of QtGui \bold {should not + be used} in a Symbian application: + + \list + \o QFileDialog with the \c DontUseNativeDialog option + \o QColorDialog with the \c DontUseNativeDialog option + \o QFontDialog + \o QWizard + \o QCalendarWidget + \o QDateTimeEdit + \o QMdiArea + \o QDockWidget + \o QMdiSubWindow + \o QPrintPreviewWidget + \endlist + + QScrollArea: The scrolling and focus handling of QScrollArea's all + scrollable widgets, for example QListView, differs from native Avkon + list widgets' one. Native Avkon scrollable components support + touch-gesture-based scrolling by dragging and flicking the UI + component but this functionality is not implemented in Qt widgets. + Scrolling by dragging and flicking works also in Qt Quick Components + that implements the \l + {http://www.developer.nokia.com/Resources/Library/Symbian_Design_Guidelines/} + {Symbian design guidelines}. + \endtable \section1 Compiler Notes - - \section2 GCCE (Symbian) - - GCCE cannot be used to compile Qt libaries for the Symbian platform, but GCCE is supported - when compiling Qt applications for the Symbian platform. + + For the application development the necessary compiler toolchain is included in \l + {http://qt.nokia.com/downloads}{Qt SDK}. For instructions compiling Qt + itself see the \l + {http://doc.qt.nokia.com/stable/install-symbian.html} + {Installing Qt for the Symbian platform} document. \section1 Known Issues @@ -762,11 +195,14 @@ \section1 Required Capabilities - The Qt libraries are typically signed with \c{All -TCB} capabilites, but + The Qt libraries are typically signed with \c{All -TCB} capabilites but that does not mean your Qt application needs to be signed with the same capabilities to function properly. The capabilities your application needs - to function properly depends on which parts of Qt you use, here is an - overview: + to function properly depends on which parts of Qt you use. + In a Qt application Symbian capabilities are defined in the + \l {http://doc.qt.nokia.com/4.8/qmake-variable-reference.html#target-capability} + {TARGET.CAPABILITY} qmake variable in the project file. + Here is an overview for which capabilities may be needed when using different modules: \table \header \o Module @@ -783,9 +219,9 @@ \o \c ReadUserData is required to include all the phone's SSL certificates in the system's default CA certificate list (for example those added by the user or stored in the SIM card), without this capability only the CA certs built into the phone are used. - \row \o QtMultiMedia + \row \o QtMultimedia \o \c UserEnvironment if QAudioInput is used. - \row \o QtWebkit + \row \o QtWebKit \o \c NetworkServices is automatically added for this module if no capabilities are explicitly specified. \endtable @@ -796,33 +232,45 @@ For more information see the documentation of the individual Qt classes. If a class does not mention Symbian capabilities, it requires none. - \section1 Multimedia and Phonon Support + \target Multimedia Support + \section1 Multimedia Support - Qt provides a high-level API for multimedia functionality with - (\l{http://doc.qt.nokia.com/qtmobility/multimedia.html}). + Qt Mobility provides a high-level API for multimedia functionality with + \l{http://doc.qt.nokia.com/qtmobility/multimedia.html}{QtMultimediaKit}. + In addition, Qt provides the low-level \l {QtMultimedia}{QtMultimedia} + module that is internally used by the QtMultimediaKit. For more information + on developing multimedia applications for Symbian devices, see + \l {http://www.developer.nokia.com/info/sw.nokia.com/id/4abf12e7-72d8-45ef-b1a2-46184abe18ba/Guide_for_Qt_Multimedia_Developers.html} + {Guide for Qt Multimedia Developers}. - Qt also provides a backend for Qt's Phonon module, which supports video and - sound playback through Symbian's Multimedia Framework, MMF. Note that Phonon - support is not being extended, and that Qt's multimedia module will - take over for Phonon at a later stage. + Moreover, there is a third multimedia-related module called Phonon. Qt + provides two backends for the Phonon module in Symbian: \i MMF and \i Helix. - In this release the support is experimental. Video playback may show - artifacts when the video is moved or resized (for instance during - orientation flips). This problem is present on Symbian^1 and earlier - versions, and on Symbian^3 systems. + Note that Phonon is a legacy module and the QtMultimediaKit module is + replacing Phonon in Qt 5. Although Phonon is supported in Symbian for + backwards compatibility and there is no plan to remove Phonon from Symbian + any new applications should use QtMultimediaKit in Symbian using Qt 4.7 + bundle. The QtMultimediaKit feature set is comparable to that in Phonon. - The audio and video formats that Phonon supports depends on what support + The following applies to Phonon: + \list + \o MMF Phonon backend supports video and sound playback through Symbian's + Multimedia Framework, MMF. Phonon's video playback may show artifacts when + the video is moved or resized (for instance, during device orientation + changes from portrait to landscape and vice versa). This problem is present + on S60 5th Edition and earlier versions, as well as in Symbian Anna devices. + \o The audio and video formats that Phonon supports depends on what support the platform provides for MMF. The emulator is known to have limited codec support. - - In addition, there exists a backend for the Helix framework. However, since + \o In addition, there exists a backend for the Helix framework. However, since it is not shipped with Qt, its availability depends on the Symbian platform in use. If the MFF plugin fails to load, the Helix plugin, if present on the device, will be loaded instead. + \endlist \section1 Hardware Accelerated Rendering - The default graphics system on Symbian^3 is OpenVG, which uses OpenVG + The default graphics system on Symbian Anna is OpenVG, which uses OpenVG hardware to accelerate \l QPainter functions. There are a few exceptions, where Qt will use software rendering fallback. @@ -837,17 +285,18 @@ \o Popups \endlist - \section1 QtOpenGL Support in Symbian + \section1 OpenGL Support in Symbian - Qt 4.7 introduces the \l {QtOpenGL} module to Symbian^3. QtOpenGL is + Qt 4.7 introduces the \l {QtOpenGL} module. QtOpenGL is supported on devices which support OpenGL ES 2.0. Symbian platforms prior - to Symbian^3 are not supported. + to Symbian Anna (and Symbian^3) are not supported. \l QGLWidget usage as a \l QGraphicsView viewport is not recommended on Symbian. The OpenVG graphics system is not able to manage OpenGL graphics resources. Also, a QGLWidget object is not able to release its GPU resources when the application goes to the background. If OpenGL functionality is - needed, OpenGL graphics system usage is recommended. If an application + needed, \l { http://doc.qt.nokia.com/4.7-snapshot/qapplication.html#setGraphicsSystem} + {OpenGL graphics system} usage is recommended. If an application decides to use QGLWidget, then it is the application's responsibility to destroy and release QGLWidget and related OpenGL resources when the application goes to the background. Otherwise, the \l{Graphics Out Of Memory monitor} @@ -858,7 +307,7 @@ QGLShader, and \l QGLShaderProgram are direct GPU resources and it is the application's responsibility to manage them. - \section1 UI Performance in devices prior to Symbian^3 + \section1 UI Performance in S60 3rd and 5th Edition Devices Qt uses the QPainter class to perform low-level painting on widgets and other paint devices. QPainter provides functions to draw complex shapes, @@ -866,11 +315,18 @@ transformations and Porter-Duff composition. If the underlying graphics architecture does not support all of these operations then Qt uses the raster graphics system for rendering. - - Most of the Symbian devices prior to Symbian^3 use a non-ScreenPlay - graphics architecture which does not have native support for all functions - provided by QPainter. In non-ScreenPlay devices Qt uses the raster - graphics system by default which has a performance penalty when compared + + In Symbian Anna (and Symbian^3) Qt uses hardware accelerated graphics as explained above. + This is enabled by \l + {http://library.developer.nokia.com/index.jsp?topic=/GUID-E35887BB-7E58-438C-AA27-97B2CDE7E069/GUID-D93978BE-11A3-5CE3-B110-1DEAA5AD566C.html} + {ScreenPlay Graphics Architecture} in these devices. + + Most of the Symbian S60 3rd and 5th Edition devices have a + graphics architecture that does not have native support for all functions + provided by QPainter. In these \l + {http://library.developer.nokia.com/index.jsp?topic=/GUID-E35887BB-7E58-438C-AA27-97B2CDE7E069/GUID-D93978BE-11A3-5CE3-B110-1DEAA5AD566C.html} + {non-ScreenPlay} devices Qt uses the raster + graphics system by default that has a performance penalty compared to native Symbian rendering. In order to be able to perform all functions provided by QPainter, the @@ -881,7 +337,8 @@ offscreen buffer is blitted to the framebuffer via Symbian Window Server. The following table shows the rendering stacks of native Symbian and Qt in - non-ScreenPlay devices. + \l {http://library.developer.nokia.com/index.jsp?topic=/GUID-E35887BB-7E58-438C-AA27-97B2CDE7E069/GUID-D93978BE-11A3-5CE3-B110-1DEAA5AD566C.html} + {non-ScreenPlay devices}. \table \header \o Symbian @@ -909,13 +366,3 @@ provided by QPainter in non-ScreenPlay architecture. */ -/*! - \page platform-notes-embedded-linux.html - \title Platform and Compiler Notes - Embedded Linux - \contentspage Platform and Compiler Notes - - This page contains information about the Embedded Linux platforms Qt is - currently known to run on, with links to platform-specific notes. More - information about the combinations of platforms and compilers supported - by Qt can be found on the \l{Supported Platforms} page. -*/ diff --git a/doc/src/platforms/platform-notes.qdocinc b/doc/src/platforms/platform-notes.qdocinc deleted file mode 100644 index e69de29..0000000 --- a/doc/src/platforms/platform-notes.qdocinc +++ /dev/null diff --git a/doc/src/platforms/supported-platforms.qdoc b/doc/src/platforms/supported-platforms.qdoc index ba59c37..f69bddb 100644 --- a/doc/src/platforms/supported-platforms.qdoc +++ b/doc/src/platforms/supported-platforms.qdoc @@ -49,8 +49,6 @@ - Requirements for developing with Qt on Windows. \o \l{Installing Qt for Windows}{Installing Qt for Windows} - Build Qt for Windows development. - \o \l{Platform and Compiler Notes - Windows}{Platform and Compiler Notes - Windows} - - Windows platform specific notes. \o \l{Getting Started Guides}{Getting started} - Getting started developing for Windows \endlist @@ -135,8 +133,6 @@ - Software required to run Qt on Linux/X11. \o \l{Installing Qt for X11 Platforms}{Installing Qt for X11 Platforms} - Build Qt for Linux/X11 development. - \o \l{Platform and Compiler Notes - X11}{Platform and Compiler Notes - X11} - - Platform specific notes. \o \l{Getting Started Guides}{Getting started} \endlist @@ -223,8 +219,6 @@ - Software required to run Qt on Mac OS X. \o \l{Installing Qt for X11 Platforms}{Installing Qt for X11 Platforms} - Build Qt for Mac OS X development. - \o \l{Platform and Compiler Notes - Mac OS X}{Platform and Compiler Notes - Mac OS X} - - Platform specific notes. \o \l{Getting Started Guides}{Getting started} \endlist @@ -285,82 +279,6 @@ \note Qt also provides support for 64-bit applications on top of Cocoa APIs. */ /*! - \page windowsCE-Mobile-support.html - \title Support for Windows CE and Windows Mobile - \brief Platform support for Windows CE and Windows Mobile. - \ingroup platform-specific - \ingroup platform-details - - \section1 Qt on Windows CE and Windows Mobile - - Qt is a C++ application and UI framework. You can use Qt to write - rich and high performance applications using an intuitive API - available for a wide range of devices. Use the code from one single - code-base and rebuild for all \l{Supported Platforms}{supported - Windows CE/Mobile versions as well as other other platforms}. - - Supporting most existing Windows CE configurations and with minimal - hardware dependencies, Qt is easy to build even for custom hardware - configurations. Unused components and features can even be compiled out. - - \section1 Getting Started on Windows CE/Mobile - - \list - \o \l{Supported Platforms}{Supported Windows CE/Mobile platforms} - - Qt supports a wide range of Windows CE/Mobile platform variants. - \o \l{Qt for Windows CE Requirements}{Qt for Windows CE/Mobile - Requirements} - Software required to run Qt on Windows CE/Mobile. - \o \l{Installing Qt for Windows CE}{Installing Qt for - Windows CE/Mobile Platforms} - Build Qt for Windows CE/Mobile - development. - \o \l{Platform and Compiler Notes - Windows CE}{Platform and - Compiler Notes - Windows CE/Mobile} - Platform specific notes. - \o \l{Getting Started Guides}{Getting started} - \endlist - - \section1 Key Features for Windows CE/Mobile Development - - On top of all the tools and API and class libraries that Qt offers, - Qt for Windows CE provides you with added functionality for an - optimized embedded development environment. - - \section2 Native and Customizable Look and Feel - - Windows Mobile and Windows CE styles are available with Qt. At runtime, - Qt applications will detect which style to use. The look and feel of - your applications can also be easily customized in a fraction of - the time and lines of code required for traditional UI styling with - Qt Style Sheets. - - \section2 Advanced Text Layout Engine - - Qt for Windows CE supports TrueType and raster fonts. Qt also has - extended Unicode support and right-to-left languages. Qt's rich text - engine adds capabilities for complex text layouts including tables, - path tracing and text which flows around shapes. - - \section2 Qt for Windows CE/Mobile also provide support for: - - \list - \o Graphics Acceleration using \l{Qt for Windows CE and OpenGL - ES}{OpenGL ES} - \o \l{Graphics View Framework}{2D graphics canvas} capable of - handling millions of items. - \o \l{Qt Designer Manual}{Qt Designer} for GUI layout and - forms builder. - \o \l{Qt Linguist Manual}{Qt Linguist} provides internationalization - and translation features. - \endlist - - Applications created with Qt for Windows CE/Mobile can be ported to - Symbian, Maemo and any other OS that Qt supports. - - Additional \l{Cross-Platform and Platform-Specific Development} - information. - -*/ - -/*! \page embeddedLinux-support.html \title Support for Embedded Linux \brief Platform support for Embedded Linux. @@ -378,6 +296,8 @@ one single code-base and rebuild for all \l{Supported Platforms} {supported platforms}. + \note Qt on Embedded Linux will not exist as a separate platform for Qt 5.0. + \section1 Getting Started on Embedded Linux \list @@ -387,8 +307,6 @@ Requirements} - Software required to run Qt on Embedded Linux. \o \l{Installing Qt for Embedded Linux}{Installing Qt for Embedded Linux} - Build Qt for development on Embedded Linux. - \o \l{Platform and Compiler Notes - Embedded Linux}{Platform and - Compiler Notes - Embedded Linux} - Platform specific notes. \o \l{Getting Started Guides}{Getting started} \endlist @@ -465,6 +383,8 @@ \o \l{Platform and Compiler Notes - Symbian}{Platform Notes - Symbian} - Platform specific notes. \o \l{Getting Started Guides}{Getting started} + \o \l{Qt Quick Components for Symbian 1.1}{Qt Quick Components for Symbian} + - provides a QML component set for the Symbian^3 platform \endlist \section1 Key Features for Symbian Development @@ -481,6 +401,9 @@ time and lines of code required for traditional UI styling with Qt Style Sheets. + The \l{Qt Quick Components for Symbian 1.1}{Qt Quick Components for Symbian 1.1} + provides a native QML component set. + \section2 Graphics Features Qt for Symbian contains a powerful paint engine that provides @@ -519,161 +442,6 @@ */ /*! - \page maemo-support.html - \title Support for Maemo - \brief Platform support for Maemo. - \ingroup platform-specific - \ingroup platform-details - - \section1 Qt on Maemo - - Qt is a comprehensive application and UI framework for developing - Maemo applications that can also be deployed across major - device and desktop operating systems without rewriting the source code. - If you are developing apps for the Symbian, Mameo platforms - in most cases, you can use Qt under the free LGPL licensing option. - Qt is cross-platform, and that means that you can use the code from - one single code-base and rebuild for all \l{Supported Platforms} - {supported platforms}. Maemo 6 is now MeeGo. - - \section1 Getting Started on Maemo - \list - \o \l{Supported Platforms}{Supported Maemo platforms} - - Qt support for Maemo versions. - \omit - \o \l{Qt for Maemo Requirements}{Qt for Maemo - Requirements} - Software required to run Qt on Maemo. - \o \l{Installing Qt for Maemo}{Installing Qt for - Maemo} - Build Qt for Maemo development. - \o \l{Platform and Compiler Notes - Maemo}{Platform and - Compiler Notes - Maemo} - Platform specific notes. - \endomit - \o \l{Getting Started Guides}{Getting started} - \endlist - - \section1 Key Features for Maemo Development - - \section2 Native Look and Feel - - Qt will detect which theme the device is running and applies the - style at runtime to your Qt application. Widgets are optimized - for touch screen usage. - - \section2 Graphics Features - - Qt for Maemo provides a powerful paint engine that cotain - features such as anti aliasing, gradients, curves and transparency. - It also has animation support with timelines and easing curves. Qt - for Maemo also supports hardware acceleration using ARM NEON - and OpenGL ES 2.0. - - \section2 Device Configurations - - Applications developed with Qt for Maemo will across all - supported Maemo devices provide automatic support for switching - between landscape and portrait mode. They will support input methods, - including predictive text input and on-screen keyboard. The - applications will also have support for one finger touch events and - gestures, and have configurable kinetic scrolling. - - \section2 Maemo - Linux/X11 - - Qt supports a wide range of X11 platform variants, such as: Solaris, - AIX, HP-UX, Maemo 5 and MeeGo. Qt for Maemo contains all Qt modules - and features the same functionality as the Qt on X11 version. - - \section2 Cross-Platform Development using Qt Creator - - \l{http://doc.qt.nokia.com/qtcreator-snapshot/index.html}{Qt Creator} is - a complete Cross-platform IDE included in the Qt SDK. The IDE allows - programmers to create, build, debug and run Qt applications accross all - supported platforms. - - Additional \l{Cross-Platform and Platform-Specific Development} - information. -*/ - -/*! - - \page meego-support.html - \title Support for MeeGo - \brief Platform support for MeeGo. - \ingroup platform-specific - \ingroup platform-details - - \section1 Qt on MeeGo - - Qt is a comprehensive application and UI framework for developing - MeeGo applications that can also be deployed across major - device and desktop operating systems without rewriting the source code. - If you are developing apps for the Symbian, MeeGo platforms - in most cases, you can use Qt under the free LGPL licensing option. - Qt is cross-platform, and that means that you can use the code from - one single code-base and rebuild for all \l{Supported Platforms} - {supported platforms}. - - \section1 Getting Started on MeeGo - - \list - \o \l{Supported Platforms}{Supported MeeGo platforms} - - Qt support for MeeGo versions. - \omit - \o \l{Qt for MeeGo Requirements}{Qt for MeeGo - Requirements} - Software required to run Qt on MeeGo. - \o \l{Installing Qt for MeeGo}{Installing Qt for - MeeGo} - Build Qt for MeeGo development. - \o \l{Platform and Compiler Notes - MeeGo}{Platform and - Compiler Notes - MeeGo} - Platform specific notes. - \endomit - \o \l{Getting Started Guides}{Getting started} - \endlist - - \section1 Key Features for MeeGo Development - - \section2 Native Look and Feel - - Qt will detect which theme the device is running and applies the - style at runtime to your Qt application. Widgets are optimized - for touch screen usage. - - \section2 Graphics Features - - Qt for MeeGo provides a powerful paint engine that cotain - features such as anti aliasing, gradients, curves and transparency. - It also has animation support with timelines and easing curves. Qt - for MeeGo also supports hardware acceleration using ARM NEON, x86, - and OpenGL ES 2.0. - - \section2 Device Configurations - - Qt is the foundation of MeeGo UI and application development and - therefore Qt will be present in all upcoming MeeGo devices. Qt - can provide automatic support for: - \list - \o Switching between landscape and portrait mode - \o Input Methods, including predictive text input and on-screen - keyboard - \o Configurable kinetic scrolling - \endlist - - \section2 Maemo - Linux/X11 - - Qt supports a wide range of X11 platform variants, such as: Solaris, - AIX, HP-UX, Maemo 5 and MeeGo. Qt for MeeGo contains all Qt modules - and features the same functionality as the Qt on X11 version. - - \section2 Cross-Platform Development using Qt Creator - - \l{http://doc.qt.nokia.com/qtcreator-snapshot/index.html}{Qt Creator} is - a complete Cross-platform IDE included in the Qt SDK. The IDE allows - programmers to create, build, debug and run Qt applications accross all - supported platforms. - - Additional \l{Cross-Platform and Platform-Specific Development} - information. -*/ - -/*! \page supported-platforms.html \title Supported Platforms \brief The platforms supported by Nokia for Qt. @@ -692,26 +460,22 @@ \o {2,1} Qt Cross Platform Support \header \o {1,1} Desktop - \o {1,1} Mobile/Embedded + \o {1,1} Embedded/Mobile \row \o \l{Support for Windows}{Windows} - \o \l{Support for Windows CE and Windows Mobile}{Windows CE and Windows Mobile} - \row - \o \l{Support for Linux/X11}{Linux/X11} \o \l{Support for Embedded Linux}{Embedded Linux} \row - \o \l{Support for Mac OS X}{Mac OS X} + \o \l{Support for Linux/X11}{Linux/X11} \o \l{Support for Symbian}{Symbian} \row - \o\l{Support for MeeGo}{MeeGo} - \o\l{Support for Maemo}{Maemo} + \o \l{Support for Mac OS X}{Mac OS X} \endtable \section1 Supported Platform Details The Qt team strives to provide support for the platforms most frequently used by Qt users. We have designed our internal testing procedure to - divide platforms into three test categories (Tier 1, Tier 2 and Tier 3) in order + divide platforms into three test categories (Tier 1 and Tier 2) in order to prioritize internal testing and development resources so that the most frequently used platforms are subjected to our most rigorous testing processes. @@ -738,30 +502,18 @@ \table \header \o Platform \o Compilers - \row \o Linux (32 and 64-bit) - \o gcc 4.2 - \row \o Microsoft Windows XP - \o gcc 4.4 (MinGW) (32-bit), MSVC 2005 (32 and 64-bit) - \row \o Microsoft Windows Vista - \o MSVC 2005, 2008 - \row \o Microsoft Windows Vista 64bit + \row \o Ubuntu Linux 10.04 (32-bit) + \o As provided by Ubuntu + \row \o Microsoft Windows XP SP3 (32-bit) \o MSVC 2008 - \row \o Microsoft Windows 7 + \row \o Microsoft Windows 7 (32-bit) \o MSVC 2008 - \row \o Apple Mac OS X 10.6 "Snow Leopard" + \row \o Microsoft Windows 7 (32-bit) + \o MSVC 2010 SP1 + \row \o Apple Mac OS X 10.6 "Snow Leopard" (64-bit) \o As provided by Apple - \row \o Apple Mac OS X 10.5 "Leopard" x86_64 (Cocoa 32 and 64bit) + \row \o Apple Mac OS X 10.7 "Lion" (64-bit) \o As provided by Apple - \row \o Embedded Linux QWS (ARM) - \o gcc (\l{http://www.codesourcery.com/}{Codesourcery version)} - \row \o Windows CE 5.0 (ARMv4i, x86, MIPS) - \o MSVC 2005 WinCE 5.0 Standard (x86, pocket, smart, mipsii) - \row \o Maemo 5(Linux, ARM, X11) - \o gcc (\l{http://www.scratchbox.org/}{Scratchbox)} - \row \o MeeGo (Linux, ARM, X11) - \o gcc (\l{http://www.scratchbox.org/}{Scratchbox)} - \row \o Symbian (Symbian/S60 5.0) - \o RVCT 2.2 [build 686 or later], WINSCW 3.2.5 [build 482 or later], GCCE (for applications) \endtable \section1 Tier 2 Platforms @@ -774,47 +526,26 @@ \table \header \o Platform \o Compilers - \row \o Windows 7 - \o MSVC 2010 - \row \o Apple Mac OS X 10.4 "Tiger" (Carbon) - \o As provided by Apple - \row \o Apple Mac OS X 10.5 "Leopard" (Carbon) + \row \o Ubuntu Linux 10.04 QWS (x86 32-bit) + \o As provided by Ubuntu + \row \o Ubuntu Linux 10.04 (32-bit) + \o Intel Compiler [version 12] + \row \o Ubuntu Linux 10.04 (64-bit) + \o As provided by Ubuntu + \row \o Microsoft Windows XP SP3 (32-bit) + \o GCC 4.4 (MinGW) + \row \o Microsoft Windows 7 (64-bit) + \o MSVC 2010 SP1 + \row \o Apple Mac OS X 10.6 "Snow Leopard" Cocoa (32-bit) \o As provided by Apple - \row \o HPUXi 11.23 - \o aCC 6.10 - \row \o Solaris 10 UltraSparc - \o Sun Studio 12 - \row \o AIX 6 - \o Power5 xlC 7 - \row \o Microsoft Windows XP - \o Intel Compiler - \row \o Linux - \o Intel Compiler - \row \o Embedded Linux QWS (Mips, PowerPC) - \o gcc (\l{http://www.codesourcery.com/}{Codesourcery version)} - \row \o Embedded Linux X11 (ARM) - \o gcc (\l{http://www.scratchbox.org/}{Scratchbox)} - \row \o Windows CE 5.0 (ARMv4i, x86, MIPS) - \o MSVC 2005 WinCE 5.0 Standard (x86, pocket, smart, mipsii) - \row \o Windows Embedded CE 6.0 (ARMv4i, x86, MIPS) - \o MSVC 2008 WinCE Embedded 6.0 Professional - \row \o Symbian (Symbian/S60 3.1, 3.2) - \o RVCT 2.2 [build 686 or later], WINSCW 3.2.5 [build 482 or later], GCCE (for applications) \endtable - \note The PPC architecture on Mac has been downgraded from tier 1 to tier 2 for 4.7. - \section1 Tier 3 Platforms (Not Supported by Nokia) All platforms not specifically listed above are not supported by Nokia. Nokia does not run its unit test suite or perform any other internal tests on platforms not listed above. - Even though some Tier 3 platforms are available under the Qt Commercial License, - technical support is not included in that license. - However, \l{How to Order}{contact our sales team} to find out about the - availability of other services for those platforms. - Qt users should note, however, that there may be various open source projects, community users and/or Qt partners who are able to provide assistance with platforms not supported by Nokia. @@ -827,13 +558,4 @@ warranties and conditions, either express or implied, including, but not limited to, implied warranties of merchantability, fitness for a particular purpose, title and non-infringement with regard to the Licensed Software. - - \section1 Planned Changes for Qt 4.8 - - The following changes to the list of supported platforms are at time of publishing - planned for Qt 4.8: - - \list - \o Plans not yet released - \endlist */ diff --git a/doc/src/platforms/symbian-introduction.qdoc b/doc/src/platforms/symbian-introduction.qdoc index e5d4a16..f6979ef 100644 --- a/doc/src/platforms/symbian-introduction.qdoc +++ b/doc/src/platforms/symbian-introduction.qdoc @@ -42,7 +42,6 @@ \o \list \o \l {Qt for the Symbian platform Requirements} - \o \l {Installing Qt for the Symbian platform from a Binary Package} \o \l {Installing Qt for the Symbian platform} \o \l {The Symbian platform - Introduction to Qt}{Introduction to using Qt} \endlist @@ -95,9 +94,6 @@ \section1 Installing Qt and Running Demos - Follow the instructions found in \l{Installing Qt for the Symbian platform from a Binary Package} - to learn how to install Qt using a binary package and how to build and run Qt demos. - Follow the instructions found in \l{Installing Qt for the Symbian platform} to learn how to install Qt using using source package and how to build and run the Qt demos. @@ -209,7 +205,7 @@ \table \row \o \c QT_SIS_OPTIONS \o Options accepted by \c .sis creation. See \l{Supported options for QT_SIS_OPTIONS}{Supported options} - below. By default no otions are given. + below. By default no options are given. \row \o \c QT_SIS_TARGET \o Target for which \c .sis file is created. Accepted values are build targets listed in previous table. By default last build target. diff --git a/doc/src/qt-webpages.qdoc b/doc/src/qt-webpages.qdoc index f67ff83..271fa18 100644 --- a/doc/src/qt-webpages.qdoc +++ b/doc/src/qt-webpages.qdoc @@ -117,10 +117,6 @@ \title Qt License Pricing */ /*! - \externalpage http://qt.nokia.com/about/contact-us - \title How to Order -*/ -/*! \externalpage http://doc.qt.nokia.com/supported-platforms.html \title Platform Support Policy */ @@ -531,6 +527,95 @@ */ /*! + \externalpage http://developer.qt.nokia.com/elearning/watch/qt_essentials_widget_edition_fundamentals_of_qt_part_2_hello_world_in_qtcre + \title Qt Essentials - Fundamentals of Qt part 1 +*/ +/*! + \externalpage http://developer.qt.nokia.com/elearning/watch/qt_essentials_widget_edition_fundamentals_of_qt_part_1_your_first_qt_applic + \title Qt Essentials - Fundamentals of Qt part 2 +*/ +/*! + \externalpage http://developer.qt.nokia.com/elearning/watch/qt_essentials_widget_edition_application_creation_part_1_mainwindows + \title Qt Essentials - Application Creation part 1 +*/ +/*! + \externalpage http://developer.qt.nokia.com/elearning/watch/application_creation_part_2_settings_resources_and_application_deployment + \title Qt Essentials - Application Creation part 2 +*/ +/*! + \externalpage http://developer.qt.nokia.com/elearning/watch/application_creation_part_3_translation_for_developers + \title Qt Essentials - Application Creation part 3 +*/ +/*! + \externalpage http://developer.qt.nokia.com/elearning/watch/widgets_part_1_common_widgets + \title Qt Essentials - Widgets part 1 +*/ +/*! + \externalpage http://developer.qt.nokia.com/elearning/watch/widgets_part_2_layout_management + \title Qt Essentials - Widgets part 2 +*/ +/*! + \externalpage http://developer.qt.nokia.com/elearning/watch/widgets_part_3_guidelines_for_custom_widgets + \title Qt Essentials - Widgets part 3 +*/ +/*! + \externalpage http://developer.qt.nokia.com/elearning/watch/graphics_view_part_1_using_graphicsview_classes + \title Qt Essentials - Graphics View part 1 +*/ +/*! + \externalpage http://developer.qt.nokia.com/elearning/watch/graphics_view_part_2_transformations_and_coordinate_systems + \title Qt Essentials - Graphics View part 2 +*/ +/*! + \externalpage http://developer.qt.nokia.com/elearning/watch/graphics_view_part_3_creating_custom_items + \title Qt Essentials - Graphics View part 3 +*/ +/*! + \externalpage http://developer.qt.nokia.com/elearning/watch/model_view_part_1_model_view_concept + \title Qt Essentials - Model/View I part 1 +*/ +/*! + \externalpage http://developer.qt.nokia.com/elearning/watch/model_view_part_2_showing_simple_data + \title Qt Essentials - Model/View I part 2 +*/ +/*! + \externalpage http://developer.qt.nokia.com/elearning/watch/model_view_part_3_proxy_models + \title Qt Essentials - Model/View I part 3 +*/ +/*! + \externalpage http://developer.qt.nokia.com/elearning/watch/model_view_part_4_custom_models + \title Qt Essentials - Model/View I part 4 +*/ +/*! + \externalpage http://developer.qt.nokia.com/elearning/watch/model_view_ii_part_1_editing_item_data + \title Qt Essentials - Model/View II part 1 +*/ +/*! + \externalpage + \title Qt Essentials - Model/View II part 2 +*/ +/*! + \externalpage http://developer.qt.nokia.com/elearning/watch/model_view_ii_part_3_data_widget_mapper + \title Qt Essentials - Model/View II part 3 +*/ +/*! + \externalpage http://developer.qt.nokia.com/elearning/watch/model_view_ii_part_4_custom_tree_model + \title Qt Essentials - Model/View II part 4 +*/ +/*! + \externalpage http://developer.qt.nokia.com/elearning/watch/model_view_ii_part_5_drag_and_drop + \title Qt Essentials - Model/View II part 5 +*/ +/*! + \externalpage http://qt.nokia.com/certification + \title Qt Certification +*/ +/*! + \externalpage http://qt.nokia.com/developer/learning/certification/exams/preparation-prerequisites + \title Qt Certification Exam Preparation and Prerequisites +*/ + +/*! \externalpage http://qt.nokia.com/developer/learning/online/training/materials \title Download Qt training materials */ @@ -554,3 +639,8 @@ \externalpage http://labs.qt.nokia.com/2011/05/03/qt-modules-maturity-level/ \title Qt Modules' Maturity Level - Description */ + +/*! + \externalpage http://doc.qt.nokia.com/qtquick-components-symbian-1.1/index.html + \title Qt Quick Components for Symbian 1.1 +*/ diff --git a/doc/src/qt4-intro.qdoc b/doc/src/qt4-intro.qdoc index 01103a8..ce1726d 100644 --- a/doc/src/qt4-intro.qdoc +++ b/doc/src/qt4-intro.qdoc @@ -558,7 +558,14 @@ Qt 4.8 introduces changes to the Qt API. \list + \o C++11 support: + Qt supports some of the features of the C++11 standard. QList, QVector and + QStringList can be initialized with initializer lists. Most of the tool + classes have a move operator. It is possible to use lambda functions in some + of the QtConcurrent functions. + \o Localization API + Changes to the Localization APIs include improvements to \l QLocale and more support for different language code formats. @@ -579,6 +586,7 @@ \endlist \o IP Multicast API \o Multithreaded HTTP + \o QThreadLocalStorage can now store simple objects in addition to pointers \endlist \section1 New Classes, Functions, Macros, etc. diff --git a/doc/src/snippets/code/doc_src_examples_icons.cpp b/doc/src/snippets/code/doc_src_examples_icons.cpp index 411c49f..dfb0182 100644 --- a/doc/src/snippets/code/doc_src_examples_icons.cpp +++ b/doc/src/snippets/code/doc_src_examples_icons.cpp @@ -40,5 +40,5 @@ //! [0] if (!condition) - qFatal("ASSERT: "condition" in file ..."); + qFatal("ASSERT: " condition " in file ..."); //! [0] diff --git a/doc/src/snippets/code/doc_src_examples_imageviewer.cpp b/doc/src/snippets/code/doc_src_examples_imageviewer.cpp index c86f8ac..07e50be 100644 --- a/doc/src/snippets/code/doc_src_examples_imageviewer.cpp +++ b/doc/src/snippets/code/doc_src_examples_imageviewer.cpp @@ -45,7 +45,7 @@ imageLabel->resize(imageLabel->pixmap()->size()); //! [1] if (!imageLabel->pixmap()) - qFatal("ASSERT: "imageLabel->pixmap()" in file ..."); + qFatal("ASSERT: " imageLabel->pixmap() " in file ..."); //! [1] diff --git a/doc/src/snippets/code/doc_src_stylesheet.qdoc b/doc/src/snippets/code/doc_src_stylesheet.qdoc index 99b31c9..78d76a8 100644 --- a/doc/src/snippets/code/doc_src_stylesheet.qdoc +++ b/doc/src/snippets/code/doc_src_stylesheet.qdoc @@ -481,7 +481,7 @@ QTextEdit { background-position: bottom center } //! [81] -QDialog { etch-disabled-text: 1 } +QDialogButtonBox { dialogbuttonbox-buttons-have-icons: 1; } //! [81] @@ -1479,7 +1479,7 @@ QSplitter::handle:vertical { } QSplitter::handle:pressed { - url(images/splitter_pressed.png); + image: url(images/splitter_pressed.png); } //! [142] diff --git a/doc/src/snippets/code/doc_src_unix-signal-handlers.cpp b/doc/src/snippets/code/doc_src_unix-signal-handlers.cpp index fd5f386..a5f3ed1 100644 --- a/doc/src/snippets/code/doc_src_unix-signal-handlers.cpp +++ b/doc/src/snippets/code/doc_src_unix-signal-handlers.cpp @@ -44,7 +44,7 @@ class MyDaemon : public QObject Q_OBJECT public: - MyDaemon(QObject *parent = 0, const char *name = 0); + MyDaemon(QObject *parent = 0); ~MyDaemon(); // Unix signal handlers. @@ -67,8 +67,8 @@ class MyDaemon : public QObject //! [1] -MyDaemon::MyDaemon(QObject *parent, const char *name) - : QObject(parent,name) +MyDaemon::MyDaemon(QObject *parent) + : QObject(parent) { if (::socketpair(AF_UNIX, SOCK_STREAM, 0, sighupFd)) qFatal("Couldn't create HUP socketpair"); diff --git a/doc/src/snippets/code/src_corelib_concurrent_qtconcurrentrun.cpp b/doc/src/snippets/code/src_corelib_concurrent_qtconcurrentrun.cpp index 11f5163..e695572 100644 --- a/doc/src/snippets/code/src_corelib_concurrent_qtconcurrentrun.cpp +++ b/doc/src/snippets/code/src_corelib_concurrent_qtconcurrentrun.cpp @@ -76,7 +76,7 @@ QString result = future.result(); //! [4] // call 'QList<QByteArray> QByteArray::split(char sep) const' in a separate thread QByteArray bytearray = "hello world"; -QFuture<QList<QByteArray> > future = QtConcurrent::run(bytearray, &QByteArray::split), ','); +QFuture<QList<QByteArray> > future = QtConcurrent::run(bytearray, &QByteArray::split, ','); ... QList<QByteArray> result = future.result(); //! [4] @@ -84,7 +84,7 @@ QList<QByteArray> result = future.result(); //! [5] // call 'void QImage::invertPixels(InvertMode mode)' in a separate thread QImage image = ...; -QFuture<void> future = QtConcurrent::run(image, &QImage::invertPixels, QImage::InvertRgba); +QFuture<void> future = QtConcurrent::run(&image, &QImage::invertPixels, QImage::InvertRgba); ... future.waitForFinished(); // At this point, the pixels in 'image' have been inverted diff --git a/doc/src/snippets/code/src_corelib_io_qsettings.cpp b/doc/src/snippets/code/src_corelib_io_qsettings.cpp index 5abb0e3..91c5401 100644 --- a/doc/src/snippets/code/src_corelib_io_qsettings.cpp +++ b/doc/src/snippets/code/src_corelib_io_qsettings.cpp @@ -230,7 +230,7 @@ settings.setValue("sofa", true); settings.setValue("tv", false); QStringList groups = settings.childGroups(); -// group: ["fridge"] +// groups: ["fridge"] //! [21] @@ -314,3 +314,24 @@ int main(int argc, char *argv[]) ... } //! [29] + +//! [30] +QSettings settings(QApplication::applicationDirPath() + "/MySoft.conf"); +//! [30] + +//! [31] +#include <QSettings> +#include <QDesktopServices> +int main(int argc, char *argv[]) +{ +#ifdef Q_OS_SYMBIAN + // Use QDesktopServices:storageLocation as QApplication is not yet created + QSettings::setPath( + QSettings::NativeFormat, QSettings::UserScope, + QDesktopServices::storageLocation(QDesktopServices::DataLocation) + "/settings"); +#endif + QApplication app(argc, argv); + + ... +} +//! [31] diff --git a/doc/src/snippets/code/src_corelib_tools_qvector.cpp b/doc/src/snippets/code/src_corelib_tools_qvector.cpp index fc46d91..fc1a7f7 100644 --- a/doc/src/snippets/code/src_corelib_tools_qvector.cpp +++ b/doc/src/snippets/code/src_corelib_tools_qvector.cpp @@ -148,10 +148,10 @@ vector.lastIndexOf("X"); // returns -1 //! [14] -QVector<double> vect; +QVector<QString> vect; vect << "red" << "green" << "blue" << "black"; -QList<double> list = vect.toList(); +QList<QString> list = vect.toList(); // list: ["red", "green", "blue", "black"] //! [14] diff --git a/doc/src/snippets/code/src_opengl_qglcolormap.cpp b/doc/src/snippets/code/src_opengl_qglcolormap.cpp index 3bd780b..535777d 100644 --- a/doc/src/snippets/code/src_opengl_qglcolormap.cpp +++ b/doc/src/snippets/code/src_opengl_qglcolormap.cpp @@ -42,7 +42,7 @@ #include <QApplication> #include <QGLColormap> -int main() +int main(int argc, char *argv[]) { QApplication app(argc, argv); @@ -51,7 +51,8 @@ int main() // This will fill the colormap with colors ranging from // black to white. - for (int i = 0; i < colormap.size(); i++) + const int size = 256; + for (int i = 0; i < size; ++i) colormap.setEntry(i, qRgb(i, i, i)); widget.setColormap(colormap); diff --git a/doc/src/snippets/code/src_sql_kernel_qsqldriver.cpp b/doc/src/snippets/code/src_sql_kernel_qsqldriver.cpp index d49b6e0..1a3772f 100644 --- a/doc/src/snippets/code/src_sql_kernel_qsqldriver.cpp +++ b/doc/src/snippets/code/src_sql_kernel_qsqldriver.cpp @@ -41,7 +41,7 @@ //! [0] QSqlDatabase db = ...; QVariant v = db.driver()->handle(); -if (v.isValid() && qstrcmp(v.typeName(), "sqlite3*")==0) { +if (v.isValid() && qstrcmp(v.typeName(), "sqlite3*") == 0) { // v.data() returns a pointer to the handle sqlite3 *handle = *static_cast<sqlite3 **>(v.data()); if (handle != 0) { // check that it is not NULL @@ -52,12 +52,12 @@ if (v.isValid() && qstrcmp(v.typeName(), "sqlite3*")==0) { //! [1] -if (v.typeName() == "PGconn*") { +if (qstrcmp(v.typeName(), "PGconn*") == 0) { PGconn *handle = *static_cast<PGconn **>(v.data()); if (handle != 0) ... } -if (v.typeName() == "MYSQL*") { +if (qstrcmp(v.typeName(), "MYSQL*") == 0) { MYSQL *handle = *static_cast<MYSQL **>(v.data()); if (handle != 0) ... } diff --git a/doc/src/snippets/qxmlquery/bindingExample.cpp b/doc/src/snippets/qxmlquery/bindingExample.cpp index 62e19be..a2c53eb 100644 --- a/doc/src/snippets/qxmlquery/bindingExample.cpp +++ b/doc/src/snippets/qxmlquery/bindingExample.cpp @@ -44,6 +44,7 @@ device.open(QIODevice::ReadOnly); QXmlQuery query; - query.setQuery("doc($inputDocument)/query[theDocument]"); query.bindVariable("inputDocument", &device); + query.setQuery("doc($inputDocument)/query[theDocument]"); + //! [0] diff --git a/doc/src/sql-programming/sql-driver.qdoc b/doc/src/sql-programming/sql-driver.qdoc index 40c7c6a..ed60e7f 100644 --- a/doc/src/sql-programming/sql-driver.qdoc +++ b/doc/src/sql-programming/sql-driver.qdoc @@ -60,6 +60,7 @@ \row \o \link #QPSQL QPSQL\endlink \o PostgreSQL (versions 7.3 and above) \row \o \link #QSQLITE2 QSQLITE2\endlink \o SQLite version 2 \row \o \link #QSQLITE QSQLITE\endlink \o SQLite version 3 + \row \o \link #QSYMSQL QSYMSQL\endlink \o SQLite version 3 for Symbian SQL Database \row \o \link #QTDS QTDS\endlink \o Sybase Adaptive Server \note obsolete from Qt 4.7 \endtable @@ -665,6 +666,106 @@ ship your own database plugin with your own SQLite library as illustrated above. Some versions of SQLite can be forced to write a specific file format by setting the \c{SQLITE_DEFAULT_FILE_FORMAT} define when building SQLite. + + \target QSYMSQL + \section2 QSYMSQL for SQLite (Version 3 and Above) with Symbian SQL Database + + \section3 General Information about QSYMSQL + + QSYMSQL driver enables clients to access the native Symbian database engine (“Symbian SQL”) + through the QtSQL API. + + The main difference to QSQLITE is that, with Symbian SQL database client can specify a + set of access control policies when creating a new database. It uses Symbian SQL security policy + definitions within open() call (security policy is defined with in the connection options parameters). + + Symbian RSqlSecurityPolicy class is a container for the security policies for a shared SQL database. + + The container can contain: + security policies that apply to the database. + security policies that apply to individual database objects, i.e. database tables. + + For the database, you use RSqlSecurityPolicy::SetDbPolicy() to apply a separate security policy to: + the database schema. + read activity on the database. + write activity on the database. + + For database tables, you use RSqlSecurityPolicy::SetPolicy() to apply a separate security policy to: + write activity on each named database table. + read activity on each named database table. + + More information about Symbian SQL and RSqlSecurityPolicy class reference about policy definitions, + can be found from Forum Nokia Library: http://library.developer.nokia.com/. + + +Example of setting Security Policy: + + Connection options hold definition for security policies and all parameters that does not contain "POLICY_" will be + passed to RSqlDatabase. Policy will be filled according to parsed values. + + Value in database wide parameters starts by definition which can be vendorId or secureId. These come directly from TSecurityPolicy class in Symbian. + + POLICY_DB_DEFAULT + Default security policy which will be used for the database and all database objects. POLICY_DB_DEFAULT must be + defined before any other policy definitions can be used. + POLICY_DB_READ + Read database security policy. An application with read database security policy can read from database. + POLICY_DB_WRITE: + Write database security policy. An application with write database security policy can write to database. + POLICY_DB_SCHEMA: + Schema database security policy. An application with schema database security policy can modify + the database schema, write to database, read from database. + + Format: + POLICY_DB_DEFAULT=cap1,cap2,cap3,cap4,cap5,cap6,cap7 (Up to 7 capabilities) + POLICY_DB_READ=cap1,cap2,cap3,cap4,cap5,cap6,cap7 (Up to 7 capabilities) + POLICY_DB_WRITE=vendorid,cap1,cap2,cap3 (Vendor ID and up to 3 capabilities) + POLICY_DB_SCHEMA=secureid,cap1,cap2,cap3 (Secure ID and up to 3 capabilities) + + Table policies does not support schema policy as database level does. + + Table specific parameters would be as: + POLICY_TABLE_WRITE=tablename,cap1,cap2,cap3,cap4,cap5,cap6,cap7 + POLICY_TABLE_READ=tablename,cap1,cap2,cap3,cap4,cap5,cap6,cap7 + + Vendor Id and Secure id format: + vid[0x12345678] (Hex) + sid[0x12345678] (Hex) + + Examples: + Setting default policy: + QSqlDatabase database = QSqlDatabase::addDatabase("QSYMSQL", "MyConnection"); + database.setConnectOptions("POLICY_DB_DEFAULT=ReadDeviceData"); + database.setDatabaseName("[12345678]myDatabase"); + bool ok = database.open(); + + Setting POLICY_DB_WRITE: + QSqlDatabase database = QSqlDatabase::addDatabase("QSYMSQL", "MyConnection"); + database.setConnectOptions("POLICY_DB_DEFAULT=None; POLICY_DB_WRITE=sid[0x12345678], WriteDeviceData"); + database.setDatabaseName("[12345678]myDatabase"); + bool ok = database.open(); + + FOREIGN KEY: + Enabling foreign key support from underlying SQLite + add: "foreign_keys = ON" to your connection options string. This will be passes to SQLite. + + Foreign key Example: + QSqlDatabase database = QSqlDatabase::addDatabase("QSYMSQL", "MyConnection"); + database.setDatabaseName("[12345678]myDatabase"); + database.setConnectOptions("foreign_keys = ON"); + bool ok = database.open(); + + \section3 How to Build the QSYMSQL Plugin + + Building QSYMSQL requires Symbian SDK. + + The build sequence is similar to the QSQLITE plugin with installing the plugin in the standard location. + + Build sequence: + + >cd sf\mw\qt\src\plugins\sqldrivers\symsql\ + >qmake + >sbs -c winscw_udeb|armv5_urel \target QIBASE \section2 QIBASE for Borland InterBase diff --git a/doc/src/template/scripts/functions.js b/doc/src/template/scripts/functions.js index 3ab4a08..af204d8 100755 --- a/doc/src/template/scripts/functions.js +++ b/doc/src/template/scripts/functions.js @@ -183,17 +183,6 @@ var blankRE=/^\s*$/; function CheckEmptyAndLoadList() { - /* Start Extracting information for feedback and adding this to the feedback form */ - var pageUrl = window.location.pathname; - var pageVal = $('title').html(); - $('#pageType').removeClass('red'); - $('#feedUrl').remove(); - $('#pageVal').remove(); - $('.menuAlert').remove(); - $('#feedform').append('<input id="feedUrl" name="feedUrl" value="'+pageUrl+'" style="display:none;">'); - $('#feedform').append('<input id="pageVal" name="pageVal" value="'+pageVal+'" style="display:none;">'); - /* End Extracting information for feedback and adding this to the feedback form */ - /* extracts search query */ var value = document.getElementById('pageType').value; /* if the search is less than three chars long remove class names and remove elements from old search*/ @@ -255,4 +244,4 @@ function CheckEmptyAndLoadList() }); }, 500); /* timer set to 500 ms */ }); - });
\ No newline at end of file + }); |
