Restructure the documentation, both on a file and on a content level.

- directory structure in doc/src - moving of class-specific documentation together with classes - new, less cluttered index page - significantely reduced number of "groups of classes" - categorized all (?) documentation into "Frameworks" or "Howtos" - reformatting of examples pages - splitting of very long documentation pages into walkthroughs - some writing where it was missing Squashed commit of the following: commit b44ea6c917a7470a678509f4c6c9b8836d277346 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 17 18:32:09 2009 +0200 Some cleaning up in the categories. commit b592c6eba72332fd23911251d836cf0af4514bae Merge: 1e10d9e 285d4b1 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 17 18:20:57 2009 +0200 Merge branch 'master' into doccleanup commit 1e10d9e732f4171e61b3d1ecf0b64f7509e71607 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 17 18:19:03 2009 +0200 Split the "io" group into "io" and "network". And list the network classes in the respective overview documentation. commit fae86d24becb69c532a9c3b4fbf744c44a54f49d Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 17 18:00:32 2009 +0200 Move the string-processing classes together with the Unicode in Qt docu. commit d2a6dd3307b0306bd7a8e283e11a99e833206963 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 17 18:00:14 2009 +0200 Not a toplevel topic, it's within the "paint system" set of pages. commit 44cba00cdf7fb086dd3bb62b15c0f9a7915e20c2 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 17 17:57:37 2009 +0200 "Canvas UI" is not a stand-alone concept in Qt - yet! commit 5f6e69b38fbca661709bc20b502ab0bc1b251b96 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 17 17:43:01 2009 +0200 Can just as well delete the old index. commit aa5ec5327dceb1d3df62b990a32c970cce03ba9c Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 17 17:39:52 2009 +0200 Some rephrasing and easier access to the "Keyboard Focus" docu. commit 6248de281565cafce12221c902e9944867b338b3 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 17 17:37:02 2009 +0200 Replace the old index with the new index. commit 110acab8af0c99db9905b0f4cc6e93c325b1e3c6 Merge: d88d526 53807e5 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 17 16:04:59 2009 +0200 Merge branch 'master' into doccleanup commit d88d52681d758e9e730de0e69290472728bf8c40 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Sun Aug 16 17:34:14 2009 +0200 Give the "Widgets and Layouts" topic a bit more content. commit 01e108a5f2d1d0948c2093987a77f222d6cc4d09 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Sun Aug 16 14:21:41 2009 +0200 Move OpenVG "best practices" documentation into howtos directory. commit 86f4ca38f965909a29cee0478c537558a4ea8f5a Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Sun Aug 16 14:18:32 2009 +0200 Add module documentation for OpenVG and Multimedia. commit 9fef923acbbb75cdc3fc4e984aec177ddcd24c53 Merge: e7e5cd9 72c1cb2 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Sun Aug 16 13:20:23 2009 +0200 Merge branch 'master' into doccleanup commit e7e5cd9444ac0e7be55ecfbeb8c9ace23784205b Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Sun Aug 16 13:20:08 2009 +0200 Add Google custom search box. Not sure why that change was never merged in by git. commit 348372947a3d7da2b28325731ac02bbc67cdec41 Merge: 3ff51b9 aa09d4f Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Sat Aug 15 02:14:31 2009 +0200 Merge branch 'master' into doccleanup commit 3ff51b9b52af39c00a938db380809e36b6c701c9 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Sat Aug 15 02:09:38 2009 +0200 Minor word-smithing. commit da612b4130061e094a16d47a450f3f3fe6f547c7 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Sat Aug 15 01:55:16 2009 +0200 Separating the "multimedia" group into reasonable sets of classes. commit 838955a1a780e41ea77676e1bef8e471c7a2a2f5 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Aug 14 23:12:33 2009 +0200 Just one file, doesn't need a separate directory. commit b99f56262faa4410880d08787f2c8d9a509d303d Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Aug 14 23:05:59 2009 +0200 Move documentation for Asian codecs into src/corelib/codecs. Not ideal, the source of most of those codecs live in src/plugins/codecs, but since this is no real API documentation it's probably appropriate. commit ba2258c0b6587d959cdfe6ff99c4d36319077aac Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Aug 14 22:24:33 2009 +0200 Renaming of files that used old product/company names. commit 30ee7deb935bb3de4257cd71be5ba9610376047c Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Aug 14 22:14:30 2009 +0200 Those will only used by "Qt 4 for Qt 3" users, so leave the original text. commit d0c110d047bbbd2dde70fc51ad702db59fa3883b Merge: c5eccd5 8198d35 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Aug 14 22:12:15 2009 +0200 Merge branch 'master' into doccleanup commit c5eccd51ad85cfaf07ea8522a977b7bef70f70fd Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Aug 14 22:09:43 2009 +0200 Moving some last files from doc/src into subdirectories. commit d2dc303d92c1f66bf721b65fca1c6d55ab7ec01d Merge: 0bdf16e a835ec7 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Aug 14 15:39:59 2009 +0200 Merge branch 'master' into doccleanup commit 0bdf16e1bb04e532d4cc72c5646cb28470d5e627 Merge: 04bb351 c73fd72 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Aug 14 13:08:37 2009 +0200 Merge branch 'master' into doccleanup Conflicts: src/3rdparty/webkit/WebKit/qt/Api/qwebelement.cpp commit 04bb3513f107a895cfbbf98f8c4f9a67e392c72a Merge: 8a52ce8 07d2ce1 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Wed Aug 12 19:58:04 2009 +0200 Merge branch 'master' into doccleanup Conflicts: tools/qdoc3/test/qt-html-templates.qdocconf commit 8a52ce8055d5d8b1bf799bf1fdde18aaf8b940c7 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Wed Aug 12 13:30:50 2009 +0200 Fix some links to the qt.nokia.com page, and at least some linking to IO. commit f7823801bf750b0b76ce0871c3f9e8e59c7901fe Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Wed Aug 12 12:27:19 2009 +0200 Make links in header point to the pages with links to everything else. commit 335012b7e96698d6ec7994fdfd52813140f12413 Merge: 21b1263 96b6a3c Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Wed Aug 12 12:17:57 2009 +0200 Merge branch 'master' into doccleanup Conflicts: doc/src/classes/qtdesigner-api.qdoc doc/src/desktop-integration.qdoc doc/src/distributingqt.qdoc doc/src/examples-overview.qdoc doc/src/examples.qdoc doc/src/frameworks-technologies/dbus-adaptors.qdoc doc/src/geometry.qdoc doc/src/groups.qdoc doc/src/objecttrees.qdoc doc/src/plugins-howto.qdoc doc/src/qt4-accessibility.qdoc doc/src/qt4-scribe.qdoc doc/src/qt4-sql.qdoc doc/src/qt4-styles.qdoc doc/src/qtdbus.qdoc doc/src/qtgui.qdoc doc/src/qtmain.qdoc doc/src/qtopengl.qdoc doc/src/qtscripttools.qdoc doc/src/qtsvg.qdoc doc/src/qtuiloader.qdoc doc/src/qundo.qdoc doc/src/richtext.qdoc doc/src/topics.qdoc doc/src/xml-processing/xml-processing.qdoc commit 21b126346989a86a828ee8a66bb12108d2bb2b71 Merge: 88e7d76 204c771 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Tue Aug 11 18:15:17 2009 +0200 Merge branch 'master' into doccleanup commit 88e7d76ceec664404a913469025ed9a7ca6f4fb0 Merge: 97c4128 1c62dc4 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Tue Aug 11 18:00:56 2009 +0200 Merge branch 'master' into doccleanup commit 97c412815162859d853c5a4ede1eb9bd4be4af9b Merge: cf5d8ae 4096911 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 10 19:27:08 2009 +0200 Merge branch 'master' into doccleanup commit cf5d8ae4b09a92fed5b4e4cabbcfd49116e9e13f Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 10 19:09:57 2009 +0200 This should link to the platform specific documentation. commit 38610f0ff210286f92528495d48f434d2c0db8e8 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 10 18:59:35 2009 +0200 These groups are embedded in the respective framework overview already. commit 1e58a90c561d33aada9427b17db8e0f7bbe02fa7 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 10 18:54:47 2009 +0200 Remove howtos and overviews from script group. The "Making Applications Scriptable" page needs to be split into a walkthrough anyway. commit 1e68b8d7d53500b8fb6c9c821d46e045ed7efe6f Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 10 18:30:10 2009 +0200 Groups are for classes. The objectmodel framework overview links to those. commit a0a95420c82e2a77150b070e98609aa3e1b3b1a6 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 10 18:22:20 2009 +0200 Kill the "buildsystem" group. All documents can be reached through the "Developing with Qt" page. commit 7b23a40c5ba3a215fba6032ad96199b5c9797e98 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 10 18:07:23 2009 +0200 This guide should only be in the porting group. commit ef731bcc53a9b34ba3b42e5ad7caf4234941c4a9 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 10 18:06:21 2009 +0200 Phonon is a framework on its own. The whole "multimedia" group is a rather random collection of stuff... commit 5d290d48fc428573ccd31861cf57d214051ba349 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 10 17:59:36 2009 +0200 Move the Qt Help documentation into frameworks. This needs a bit of a rewrite, and the list of classes needs to be integrated. commit 5e4d094c8712bfb46d844e09746aad5da3ac4a91 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 10 17:58:52 2009 +0200 The list of all classes that use implicit sharing is not useful on its own. commit 2059a0be23c5953f9758098cb7a9416cb86d5ad1 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 10 17:55:20 2009 +0200 Make the QtScript overview documentation part of frameworks. commit 3413696bd745ee5862aa517dcfc9c8446fee9b82 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 10 17:54:59 2009 +0200 Make the list of drag & drop classes part of the framework docu. commit f1c85ea263b30de1e1a1f6c5cb8b8d9ee12254cb Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 10 17:44:57 2009 +0200 Porting guides are part of the Howto's commit cfcc742f938cf7c278f1f8b11b24a61f62fb4c62 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 10 17:44:26 2009 +0200 All platform specific docu is available through one toplevel page. commit 53c642fe4cbc2dbd44fe5b9b4e32feeca438b5c3 Merge: c564285 41537bb Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 10 16:48:09 2009 +0200 Merge branch 'master' into doccleanup commit c5642857b2f2364134f58776661cc08a9da13b2c Merge: 9cdeba7 24aa363 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 10 15:53:47 2009 +0200 Merge branch 'master' into doccleanup commit 9cdeba712c51eb0bf71eab35080734a2b93efcc5 Merge: 09dac33 d13418e Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Sat Aug 8 11:46:42 2009 +0200 Merge branch 'master' into doccleanup commit 09dac333d427792a8d33fa311a63c620678e7920 Merge: f7b211e dfa2842 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Aug 7 15:40:33 2009 +0200 Merge branch 'master' into doccleanup Conflicts: doc/src/examples.qdoc commit f7b211e5588fee20913a8d02c55cca0e05ea2859 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Thu Aug 6 14:58:49 2009 +0200 Rename file to follow naming scheme and resulting html. commit ed6432fea376e60e4dd7c8987ed61a063af11ac7 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Thu Aug 6 14:58:10 2009 +0200 Structure the XML documentation into a walk-through. The XmlPatterns docu should probably be split into two or three sections, XQuery, XPath and XML Schema. commit 3dbc1d4ca08d3cac47ca2709b6fb1a2419442c36 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Thu Aug 6 14:15:00 2009 +0200 Add a table of contents. commit 1569c35cb90c10ead72dcea2c4b99a0a6cbfcc13 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Thu Aug 6 14:04:52 2009 +0200 Splitting the long SQL documentation into walkthrough steps. commit 6a05688bce3cca34dd1b8b323b8feb49d3133d7e Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Thu Aug 6 13:49:50 2009 +0200 Combining various desktop integration topics into one document. commit c02c9adca98ba1d4494dd9c7de4ef5b191d9721a Merge: 4cc4a81 2a286b0 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Thu Aug 6 08:16:04 2009 +0200 Merge branch 'doccleanup' of git@scm.dev.nokia.troll.no:qt/vohis-docuwork into doccleanup commit 4cc4a81324cff3c1ad91867cf3acb87d9b4184c6 Merge: a88dc5d 06d57fc Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Thu Aug 6 08:15:52 2009 +0200 Merge branch 'master' into doccleanup commit 2a286b03167ce028821b4007bf08537d2c5637c2 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Wed Aug 5 23:23:28 2009 +0200 Some writing on windows and dialogs. Also some restructuring of the existing content. commit a88dc5d72bec7abeec23b289c212418499c25e4a Merge: 86f956c fb8bb14 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Wed Aug 5 18:09:58 2009 +0200 Merge branch 'master' into doccleanup commit 86f956c89b9b8fb3d684665797d4a5b5e538fb2c Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Wed Aug 5 17:09:36 2009 +0200 All "Qt 4 vs Qt 3" docu lives in porting. Some of those files have been changed by now to move docu into overview files where the respective information was missing. commit ac6f1fc8b1e760ae69ce799e13ac92144eeb89e2 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Wed Aug 5 17:06:15 2009 +0200 Start work on windows and dialogs docu. commit 4253dea2661dc3526a9dec53f336301992b543cb Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Wed Aug 5 16:03:52 2009 +0200 Make QtWebKit module documentation follow the other modules: - Module overview only lists classes, library, header and license implication - Usage-documentation is separated commit a27f1b8498ba8d06743e70ecde4fc1e44d5f02f0 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Wed Aug 5 16:01:25 2009 +0200 Make QtWebKit classes show up in the module overview. commit d38d185ec8b7d32037e86b4ecbbc725343aabea7 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Wed Aug 5 15:40:17 2009 +0200 Make the most important sections a bit larger. commit 70991dcdfb8c00baa960381b297fdcb8ed7f50d0 Merge: deb4c2b e95166d Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Wed Aug 5 14:35:07 2009 +0200 Merge branch 'master' into doccleanup commit deb4c2bb4d7120579fda541b03c0a77d989089d5 Merge: 37e5373 f78bd88 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Wed Aug 5 12:59:22 2009 +0200 Merge branch 'master' into doccleanup commit 37e5373dcc5455b1e029ee389ce7985a98f579d9 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Wed Aug 5 11:32:43 2009 +0200 These new examples are not yet fully documented commit 85fb40ea11458040e09302bb898d89664eb280b5 Merge: 8b78e18 bcf41cf Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Wed Aug 5 11:30:26 2009 +0200 Merge branch 'master' into doccleanup Conflicts: doc/src/examples-overview.qdoc doc/src/examples.qdoc tools/qdoc3/htmlgenerator.cpp commit 8b78e1828b93a9762301d80cb110a1f1b7c4211f Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Wed Aug 5 00:04:36 2009 +0200 Line-feed fixes. commit 2fa80a411dd96369c0e09defc54af44118930ae5 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Wed Aug 5 00:04:00 2009 +0200 The "buildsystem" docu seems a reasonable start for proper documentation. Three lists of tools - in the buildsystem table, in the tools-list docu and implicitly through \ingroup qttools. Needs to be consolidated. commit 8d4043feab66698664cfa17bd150eabf4fe2420d Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Wed Aug 5 00:01:32 2009 +0200 Restructure the i18n page. The list of classes needs to be reviewed. commit 49f718b1e75c02bc43feac93d5b233064c032555 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Wed Aug 5 00:00:45 2009 +0200 The Accessibility group is just a group of classes. commit b17db7dc54c1945cd2651fdebde471c71ef4001d Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Tue Aug 4 23:40:21 2009 +0200 Remove the "Topics" group. Things are part of frameworks or how-to documentation. Top-level groups are right now still on the "all overviews" document. commit 31e5c276b50130542dbd824b0b8cc20b16ca1cb1 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Tue Aug 4 22:45:43 2009 +0200 Splitting the thread documentation into multiple pages. Also add relevant classes from QtConcurrent to the thread group. commit d491ffb0e949f1d8653d73495e091b241a025558 Merge: e99794c 3ff7afd Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Tue Aug 4 19:29:18 2009 +0200 Merge branch 'doccleanup' of git@scm.dev.nokia.troll.no:qt/vohis-docuwork into doccleanup commit 3ff7afd6c11d824af38c72afdea4b6578f6de784 Merge: 1dae0ad 2df403d Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Tue Aug 4 18:07:11 2009 +0200 Merge branch 'doccleanup' of git@scm.dev.nokia.troll.no:qt/vohis-docuwork into doccleanup Conflicts: doc/src/accessible.qdoc doc/src/activeqt.qdoc doc/src/animation.qdoc doc/src/containers.qdoc doc/src/custom-types.qdoc doc/src/desktop-integration.qdoc doc/src/dnd.qdoc doc/src/frameworks-technologies/accessible.qdoc doc/src/frameworks-technologies/activeqt-container.qdoc doc/src/frameworks-technologies/activeqt-server.qdoc doc/src/frameworks-technologies/activeqt.qdoc doc/src/frameworks-technologies/animation.qdoc doc/src/frameworks-technologies/containers.qdoc doc/src/frameworks-technologies/dbus-adaptors.qdoc doc/src/frameworks-technologies/dbus-intro.qdoc doc/src/frameworks-technologies/desktop-integration.qdoc doc/src/frameworks-technologies/dnd.qdoc doc/src/frameworks-technologies/implicit-sharing.qdoc doc/src/frameworks-technologies/ipc.qdoc doc/src/frameworks-technologies/model-view-programming.qdoc doc/src/frameworks-technologies/phonon.qdoc doc/src/frameworks-technologies/qt4-interview.qdoc doc/src/frameworks-technologies/qtdesigner.qdoc doc/src/frameworks-technologies/qthelp.qdoc doc/src/frameworks-technologies/statemachine.qdoc doc/src/frameworks-technologies/templates.qdoc doc/src/frameworks-technologies/unicode.qdoc doc/src/frameworks/accessible.qdoc doc/src/frameworks/activeqt-container.qdoc doc/src/frameworks/activeqt-server.qdoc doc/src/frameworks/activeqt.qdoc doc/src/frameworks/animation.qdoc doc/src/frameworks/containers.qdoc doc/src/frameworks/dbus-adaptors.qdoc doc/src/frameworks/dbus-intro.qdoc doc/src/frameworks/desktop-integration.qdoc doc/src/frameworks/dnd.qdoc doc/src/frameworks/ipc.qdoc doc/src/frameworks/model-view-programming.qdoc doc/src/frameworks/phonon.qdoc doc/src/frameworks/qt4-interview.qdoc doc/src/frameworks/qtdesigner.qdoc doc/src/frameworks/qthelp.qdoc doc/src/frameworks/qundo.qdoc doc/src/frameworks/richtext.qdoc doc/src/frameworks/statemachine.qdoc doc/src/graphicsview.qdoc doc/src/howtos/custom-types.qdoc doc/src/howtos/session.qdoc doc/src/implicit-sharing.qdoc doc/src/introtodbus.qdoc doc/src/ipc.qdoc doc/src/model-view-programming.qdoc doc/src/modules.qdoc doc/src/new_index.qdoc doc/src/objectmodel/custom-types.qdoc doc/src/objectmodel/object.qdoc doc/src/objectmodel/objecttrees.qdoc doc/src/overviews.qdoc doc/src/phonon.qdoc doc/src/porting/qt4-tulip.qdoc doc/src/qaxcontainer.qdoc doc/src/qaxserver.qdoc doc/src/qdbusadaptors.qdoc doc/src/qt4-interview.qdoc doc/src/qtdesigner.qdoc doc/src/qthelp.qdoc doc/src/statemachine.qdoc doc/src/technologies/implicit-sharing.qdoc doc/src/technologies/templates.qdoc doc/src/technologies/unicode.qdoc doc/src/templates.qdoc doc/src/unicode.qdoc doc/src/widgets-and-layouts/layout.qdoc doc/src/widgets-and-layouts/styles.qdoc doc/src/widgets-and-layouts/widgets.qdoc src/gui/kernel/qstandardgestures.cpp commit 1dae0adf3d85620f7574a2a0475510a627a896dc Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Tue Aug 4 17:46:58 2009 +0200 This way it appears as part of the overview, and the moc docu links to it. commit 5802092887e46dc5eb034bb9b45dd34a265607f5 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Tue Aug 4 17:45:09 2009 +0200 Not sure what it is yet, but definitely not an architecture. QDataStream links to this page, that might just as well be enough. commit 69d32c4ff079bcaea098b34de70b7d9587e51e88 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Tue Aug 4 17:43:42 2009 +0200 Use \annotatedlist command to list all widget classes. Needs nicer formatting, ie qdoc could be \table aware for those lists and skip the header. commit 02057d7575bb4f0875e82ea4cb76552f2d8ac17a Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Tue Aug 4 17:35:46 2009 +0200 This should be together with all the other licensing documentation. commit be91b2fe15c67cb90eaa59121d7ff51eb21b4dba Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Tue Aug 4 17:26:02 2009 +0200 These are best practices. commit 8e0b104db1266a736ac246c9466656c058df18f2 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Tue Aug 4 17:25:35 2009 +0200 Another technology. commit 19c16384d712c652716776c94c749030b0742752 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Tue Aug 4 17:24:55 2009 +0200 Remove duplicate and out-of-date license headers. commit 689aa91de0f840fc0f98f0adfbb2f18d72c6b985 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Tue Aug 4 17:21:00 2009 +0200 Move into frameworks. Add explicitly printed list of classes instead of using a separate \group page. The \group page is still there as long as qdoc requires it. Threading and WebKit are still "architectures", coming later. commit 3f96833ab78dacd7ae66e6dd58a3a0dee22229e7 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Tue Aug 4 16:35:17 2009 +0200 Remove IPC group. Only two classes, and those are explicitly listed in the real documentation about IPC in Qt. commit bbb02d8cc55c9595226f42fe5b617261584c6bdd Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Tue Aug 4 15:54:46 2009 +0200 Use the new \annotatedlist command, and make it a framework. commit ba3a0376acb44ae5cafc8bd3802bd425dcb663a5 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Tue Aug 4 15:38:24 2009 +0200 Make \annotatedlist <group> work. commit c80fb8d6a143c81700c2aefe7af1e83dd487dde4 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Tue Aug 4 15:37:51 2009 +0200 These are API documentation, not architecture. commit 713744520bd35d510864ad48464575f1c8a35668 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Tue Aug 4 15:10:25 2009 +0200 Frameworks and technologies used in Qt are really one thing. commit a86d4248c1e3c13f245c49f3f2d018ec4babc822 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Tue Aug 4 15:00:35 2009 +0200 Move into correct groups and make the howto a walk-through. commit 7cc88f310e0dfa37d39026d67443f518531d7fe9 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Tue Aug 4 12:50:58 2009 +0200 Architecture -> Frameworks and Technologies commit 4a3ba3f19d78c4df5343af951c761df47e22759a Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Tue Aug 4 12:50:41 2009 +0200 Some consolidation of the Tulip documentation. commit d3dab98b96d83ce408523f8ccb9363a09eed1f34 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Tue Aug 4 12:01:10 2009 +0200 Start with "Frameworks and Technologies" vs "howtos and best practices". commit 37a8e364442e6234c6a83667eb64af1c79b38e9b Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Tue Aug 4 12:00:34 2009 +0200 Beautify. commit c86d844a79406d4b9fee67578efd67e27ce96b83 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Tue Aug 4 00:04:40 2009 +0200 Fix some headers. commit 20b775d781d3b1d91164320807c21c8a6efcf011 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 3 23:48:17 2009 +0200 Split the accessibility docu into a "compared to Qt 3" section, and move real information into the overview. commit 6846a1bccf7d212f7ee0471f992cfb16efb71c43 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 3 23:47:37 2009 +0200 The gui-programming seems rather arbitrary and should go away. Some things fit into the desktop integration, which is probably more a howto. Focus is a concept in the widgets context, and application-wide techniques like accelerators should probably be part of the "window" docu. commit 8c7bc99e78a69751080de07618bf003bc227e2db Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 3 23:45:28 2009 +0200 Move "Getting Started" documentation into getting-started directory. commit 561cc3eafa20903243f3946ac4b7b724554c341c Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 3 19:06:16 2009 +0200 Group "getting started" documents into a walkthrough structure. commit 6d703807348923a068dea7360fb4456cbde071b6 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 3 17:35:15 2009 +0200 Add screenshots for example-overview page. commit f7a47536305e157c16e8a863f145a2617606a2cc Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Sun Aug 2 16:57:04 2009 +0200 Link to the real documentation, not just to the modules overview. commit 92ce250ba206f4dde198637f1a30cd10768d9ae5 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Sun Aug 2 16:56:41 2009 +0200 A new layout for the examples. Needs a bit of shuffeling around, and more screenshots and descriptive text for some categories. commit a5e2e2939b32dee0aceabe136aa4c13b12c88070 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Sat Aug 1 22:39:27 2009 +0200 Cleanup the script-related groups a bit. commit ca469165a9f55ca6bd31e53d85d74883fe892ed4 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Sat Aug 1 22:17:16 2009 +0200 Add QContiguousCache to the list of containers as a special case. commit a21292704bd12daf2495195b216424442e097220 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Sat Aug 1 21:52:37 2009 +0200 Cleaning up groups of text- and string-related classes. Make a clear separation between classes that deal with string data (ie QString, QByteArray, QTextStream) and classes that are part of the "scribe" framework. Merge documentation from the Qt 4.0 introduction of Scribe into the richtext processing guide. commit 3854592806e23955f69613bdc1e2998d5d6f3a8a Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Sat Aug 1 20:50:06 2009 +0200 One group of thread-related classes should be enough. commit b8935bc0ec3d33b6a3fe7b3b220b5781ad79d68d Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Sat Aug 1 19:32:21 2009 +0200 Move documentation for classes into same directory as the respective header files (or implementation file, if one exists). This follows the Qt standard, and there is no particular reason why .qdoc files cannot live in src. Since there are a number of .cpp files that have only documentation it might also be an idea to rename the .qdoc files to .cpp and add them to the .pro-files to have them included in generated project files for easier access. commit b61cc5eaf2f2bf72cff209ab0f69fde48fb87471 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 19:29:46 2009 +0200 Starting to tie together the widgets and layouts groups and documentation. commit 47fb0c6cf1dacdbfa07a59cf4dc703dd2c35eb8c Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 18:43:34 2009 +0200 This is all duplicate information that is better covered in the sql-programming guide. commit d3c70dd9ed84b4688cbabf30f6b906665b676b76 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 18:37:53 2009 +0200 Consolidate style documentation. commit 1d8d30eee1e2fe9f8e77ce1462803921b2132ade Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 17:13:44 2009 +0200 Split plugin-documentation into two: writing plugins and deploying plugins. commit a329665353a78749b0d4fdd6e75403252d34f679 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 14:19:47 2009 +0200 Some final module cleaning up. commit e3de6579d43cc9796b69188cfb9d3d415a91a770 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 13:51:54 2009 +0200 Move remaining overview groups into one file. commit 7d783342f520f8376e561246268371d0b74a4e44 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 13:51:34 2009 +0200 The "io" group should be about file access (be it local or networked). commit 961fcefb034fea89d1aab2bfed5acaabb65e8d34 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 13:36:51 2009 +0200 Kill the "time" group. The "How to use timers in your application" documentation covers the usecase. commit c7bebf1a4c3e2da54ce6a5d649926d76bf65e41e Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 13:28:21 2009 +0200 Kill the group "misc". commit e414a8945cb938ccc6bd1bd8cd52adbfade096c2 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 13:09:24 2009 +0200 Kill the "Environment" group. It was a random collection of classes, mostly ending up in there because of copy/paste (I suspect). commit 9236a04e7ac6dd3910f035d15b8ab23297fd5f24 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 13:08:37 2009 +0200 More moving of files and content. commit 1ef3134bade2df33ff68c7c906cf20343abd86a5 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 02:03:07 2009 +0200 Workaround qdoc being difficult. commit 49064b0570088fe749fc08c02c5ab6d23855089f Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 01:49:52 2009 +0200 Some more moving of files into meaningful directories. commit df4ced831cf9f49c638c231fa9f2754699a8a59d Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 01:41:14 2009 +0200 Separate module documentation from frameworks documentation. Module documentation will list the classes in each module, how to use the respective libraries and headerfiles from a build-system perspective and what the legal implications are when linking against those libraries. The documentation of frameworks lives now in the frameworks subdirectory, or in dedicated subdirectories for the key frameworks. commit f4ccabe1abb97f91f196dab1948fee6135c9fa6e Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 00:47:54 2009 +0200 Group files in subdirectories that would correspond to top level topics. commit ceb0110a364185b8b5d7bea3d3d1d54500035fcc Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Thu Jul 30 21:48:45 2009 +0200 Group files in subdirectories that would correspond to top level topics. commit 72a4dae65b25c9df400218252f1c68d59724ff75 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Thu Jul 30 20:57:39 2009 +0200 Fix a few links. commit ecb79681417e8bc3d8e46065dc12146f4d4dfc5f Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Thu Jul 30 20:20:55 2009 +0200 Consolidate the two example documents into one page. commit d30d980055e7c531c9e73cdf9a1b220ce9691eef Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Thu Jul 30 19:25:16 2009 +0200 The QtAssistant module is obsolete, remove it. QAssistantClient is in the list of obsolete classes. commit 137ecd1ee70f0766fd94c6199d8a6b8217d020ca Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Thu Jul 30 18:56:14 2009 +0200 Get rid of \mainclass If we want to select a list of main classes, then we can use \ingroup for that, and document them coherently as part of the Fundamentals or a relevant framework. commit 042a7f21e68120e43b68444cbf3cfeca3aad4488 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Thu Jul 30 18:23:55 2009 +0200 The new index page and respective style changes. commit 5245d784eb46287f8e1ae41addb2765eb19b0663 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Thu Jul 30 17:05:46 2009 +0200 Deployment group is gone. commit 567d737a8d08f227133674ebfe2d161888862b8c Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Thu Jul 30 16:48:53 2009 +0200 All "lists of classes etc" are now in classes.qdoc... I hope. commit 0bb6074c0b38f07697e72a50a2ef60b561e718fe Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Thu Jul 30 16:47:20 2009 +0200 Cleaning up files documenting deployment. Text need to be reviewed and merged. commit 2df403da24a2959c02d0d845d1d4fac0c3aa38e0 Author: Thierry Bastian <thierry.bastian@nokia.com> Date: Mon Aug 3 16:49:46 2009 +0200 fix warnings on mingw (gcc4.4) basically reordering members initialization in constructors or fixing singed/unsigned checks. Reviewed-by: Trustme commit e887c7705b8b7f218b3605eeefb316dea274fe27 Author: Richard Moe Gustavsen <richard.gustavsen@nokia.com> Date: Tue Aug 4 10:00:01 2009 +0200 Mac: Remove debug work output commit 62687960508b2855b48d64825b445e5738c44142 Author: Richard Moe Gustavsen <richard.gustavsen@nokia.com> Date: Tue Aug 4 09:45:47 2009 +0200 Modify imagewidget example so it works with new API commit 9c7aed68270b336ae9a309d9eb0107d49729c1f3 Author: Richard Moe Gustavsen <richard.gustavsen@nokia.com> Date: Tue Aug 4 09:43:14 2009 +0200 Add support for pan gesture on mac (carbon and cocoa) commit be5783878a977148b34dc64c464e951be312964e Author: Morten Sorvig <msorvig@trolltech.com> Date: Tue Aug 4 09:47:05 2009 +0200 Remove the "preliminary support" warning for 10.6 Also make the "usupported on > 10.6" error a warning. No need to stop the build, the warning will be printed enough times. commit f6282eec434d073fef46d50ef141df6fa36033b9 Author: Morten Sorvig <msorvig@trolltech.com> Date: Tue Aug 4 09:31:56 2009 +0200 Build on snow leopard. Don't error out when building qmake, just let it build a 64-bit binary (even for carbon) RebBy: Richard Moe Gustavsen commit abae82a26f4dec34635827acf0784058be638e31 Author: Morten Sorvig <msorvig@trolltech.com> Date: Tue Aug 4 08:15:21 2009 +0200 Make Cocoa builds 64-bit by default on snow leopard. commit 4672e771c164503d998ccb6ca05cf7e7906fb031 Author: Jason McDonald <jason.mcdonald@nokia.com> Date: Tue Aug 4 15:40:15 2009 +1000 Fix incorrect license headers. Reviewed-by: Trust Me commit a3bd65e8eb0fd39e14539919cc9ced645c969883 Author: Bill King <bill.king@nokia.com> Date: Tue Aug 4 14:57:36 2009 +1000 Fixes failed queries when mysql auto-prepares Queries like "Show Index" etc, fail on mysql when automatically prepared due to a bug in several versions of mysql. Basically anything but a select query will fail. This fixes this by making the user explicitly prepare the query if they want to, and the blame then falls on them if they try and prepare a statement likely to fail. This fix also seems to result in a speedup for single-execution queries, possibly due to reduction in roundtrip communications. All autotests pass & behaviour conforms to documentation. Task-number: 252450, 246125 commit 4612596a6a945ab0199fe06727ff3ea350092ec1 Author: Jason McDonald <jason.mcdonald@nokia.com> Date: Tue Aug 4 14:49:14 2009 +1000 Fix obsolete license headers Reviewed-by: Trust Me commit c3bcc8b094341e0dc768ef5820ba359e2c23436a Author: Aaron Kennedy <aaron.kennedy@nokia.com> Date: Tue Aug 4 10:59:02 2009 +1000 Doc fixes Reviewed-by: TrustMe commit 1d60528ced1f6818a60889d672089bfe4d2290bb Author: Morten Sorvig <msorvig@trolltech.com> Date: Mon Aug 3 15:57:44 2009 +0200 Fix spelling error. commit e99794c1200515f18ffdd0bec9c143db46e009a1 Merge: 199db81 d65f893 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Tue Aug 4 09:24:14 2009 +0200 Merge branch 'master' into doccleanup commit 199db8104a680f91451cf2c93d2d41077b5605bb Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Tue Aug 4 00:04:40 2009 +0200 Fix some headers. commit e8f8193b951a9f9e4b6d309c44151c47b715e901 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 3 23:48:17 2009 +0200 Split the accessibility docu into a "compared to Qt 3" section, and move real information into the overview. commit 8006ec36024e972be21e8397c2cc758a0e9b2ba0 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 3 23:47:37 2009 +0200 The gui-programming seems rather arbitrary and should go away. Some things fit into the desktop integration, which is probably more a howto. Focus is a concept in the widgets context, and application-wide techniques like accelerators should probably be part of the "window" docu. commit 8dab96460280b8af6726905e8d5d24020930b882 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 3 23:45:28 2009 +0200 Move "Getting Started" documentation into getting-started directory. commit 523fd47c29c24a865855d085a0036fc741203930 Merge: a1e50f6 2076f15 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 3 19:10:51 2009 +0200 Merge branch 'master' into doccleanup commit a1e50f6619ff1a302dd1fefbcb6b0cd62a653e7d Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 3 19:06:16 2009 +0200 Group "getting started" documents into a walkthrough structure. commit e393b4f458263cb2f011cc5e5e67cdcc48610ea9 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 3 17:35:15 2009 +0200 Add screenshots for example-overview page. commit 8c84f307f73ab7b77a91e61ed18fdc685afebcc5 Merge: a16033a 34e272a Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Mon Aug 3 11:03:41 2009 +0200 Merge branch 'master' into doccleanup commit a16033a287afe2f494401e24f02f046ec98d944c Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Sun Aug 2 16:57:04 2009 +0200 Link to the real documentation, not just to the modules overview. commit 6c4ed0361c860e738b9344dfb191f55d35b3309f Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Sun Aug 2 16:56:41 2009 +0200 A new layout for the examples. Needs a bit of shuffeling around, and more screenshots and descriptive text for some categories. commit 2dde2faa8f6e86acf738a808412c5e3c21c44658 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Sat Aug 1 22:39:27 2009 +0200 Cleanup the script-related groups a bit. commit a66227d0bed87c633a22a4d155f6a7f0061fc34e Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Sat Aug 1 22:17:16 2009 +0200 Add QContiguousCache to the list of containers as a special case. commit b22133eef28566f1c3c5d57aa0e8272af26da86a Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Sat Aug 1 21:52:37 2009 +0200 Cleaning up groups of text- and string-related classes. Make a clear separation between classes that deal with string data (ie QString, QByteArray, QTextStream) and classes that are part of the "scribe" framework. Merge documentation from the Qt 4.0 introduction of Scribe into the richtext processing guide. commit b30ba739308905b6c06987cec47d4de1e5d172de Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Sat Aug 1 20:50:06 2009 +0200 One group of thread-related classes should be enough. commit a2511650577126026f98cb7416c159498f6f2db5 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Sat Aug 1 19:32:21 2009 +0200 Move documentation for classes into same directory as the respective header files (or implementation file, if one exists). This follows the Qt standard, and there is no particular reason why .qdoc files cannot live in src. Since there are a number of .cpp files that have only documentation it might also be an idea to rename the .qdoc files to .cpp and add them to the .pro-files to have them included in generated project files for easier access. commit f333ad71384cf42c20219a55d9dfa1e29a8c263e Merge: bad9ba5 5aed3db Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Sat Aug 1 12:04:55 2009 +0200 Merge branch 'master' into doccleanup commit bad9ba5468333be2f08da7f28950c980bc63c787 Merge: 49f38b7 c57ed13 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 19:31:04 2009 +0200 Merge branch 'master' into doccleanup commit 49f38b7afe3205eedccf655c0ad749d685cb3d52 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 19:29:46 2009 +0200 Starting to tie together the widgets and layouts groups and documentation. commit e6c4b8316b7c90b19815c0008a282983012c68b3 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 18:43:34 2009 +0200 This is all duplicate information that is better covered in the sql-programming guide. commit 620620ae969bed86d970519bead45762bd39ede1 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 18:37:53 2009 +0200 Consolidate style documentation. commit 01c78ff78888d3ccb50189206b9bcacaf13f5c80 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 17:13:44 2009 +0200 Split plugin-documentation into two: writing plugins and deploying plugins. commit a21f510c982dce06ac1769e61e93574f90cc48c4 Merge: da93c4c c6cdfcb Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 16:04:51 2009 +0200 Merge branch 'master' into doccleanup commit da93c4ccc25dd189dfb9b71bda28bd1e3a7230c1 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 14:19:47 2009 +0200 Some final module cleaning up. commit 9eb0815bbd01b7e30877110b53aa6f82b8e9221d Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 13:51:54 2009 +0200 Move remaining overview groups into one file. commit 65d4c4145386a409aeb1372ae5adc6f3e71e444b Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 13:51:34 2009 +0200 The "io" group should be about file access (be it local or networked). commit 1a3de3a7add6d9e7653e46b57b00852845384a42 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 13:36:51 2009 +0200 Kill the "time" group. The "How to use timers in your application" documentation covers the usecase. commit dbadf1c060e051dbac7f5c72528ef6a3125d5ba3 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 13:28:21 2009 +0200 Kill the group "misc". commit 7b7484b37b074d52af5c4ff9b138087a75965508 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 13:09:24 2009 +0200 Kill the "Environment" group. It was a random collection of classes, mostly ending up in there because of copy/paste (I suspect). commit b5271d81e7da6666d339041d028a0ae6c8ed75c4 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 13:08:37 2009 +0200 More moving of files and content. commit 96a707d25342c273cdd7629fc1e24b0ead4118de Merge: 4ffe572 18fbfdf Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 11:08:11 2009 +0200 Merge branch 'master' into doccleanup commit 4ffe572a954e99d604c1360fc55db25e8586436c Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 02:03:07 2009 +0200 Workaround qdoc being difficult. commit 7f0e965c7cf613782e8189069444a4b549f0c11a Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 01:49:52 2009 +0200 Some more moving of files into meaningful directories. commit b0d67674469e57b29e60110888352ae955adcdd8 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 01:41:14 2009 +0200 Separate module documentation from frameworks documentation. Module documentation will list the classes in each module, how to use the respective libraries and headerfiles from a build-system perspective and what the legal implications are when linking against those libraries. The documentation of frameworks lives now in the frameworks subdirectory, or in dedicated subdirectories for the key frameworks. commit 45240a9c0eba9e42e6e441a55a407173a81a7344 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Fri Jul 31 00:47:54 2009 +0200 Group files in subdirectories that would correspond to top level topics. commit 896507f2f4fdc541fc436cf901a2beb72d35f6aa Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Thu Jul 30 21:48:45 2009 +0200 Group files in subdirectories that would correspond to top level topics. commit 37eb554f75d8b1d9d76993f6fcf632933c9616a2 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Thu Jul 30 20:57:39 2009 +0200 Fix a few links. commit 74027c3568c1bdbb9960d203266f4ccc5e89c05c Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Thu Jul 30 20:20:55 2009 +0200 Consolidate the two example documents into one page. commit cfc0fd3df050cf6c0e3229d22adfbff35aed46af Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Thu Jul 30 19:25:16 2009 +0200 The QtAssistant module is obsolete, remove it. QAssistantClient is in the list of obsolete classes. commit 0f86c7a176fc920669ca8a880afa141434f37767 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Thu Jul 30 18:56:14 2009 +0200 Get rid of \mainclass If we want to select a list of main classes, then we can use \ingroup for that, and document them coherently as part of the Fundamentals or a relevant framework. commit c4dfbc6bf58ef741fdab01538e75e9472e8370bf Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Thu Jul 30 18:23:55 2009 +0200 The new index page and respective style changes. commit a3e4eb6712e24a4d6156c340ee98671887a2b2fa Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Thu Jul 30 17:05:46 2009 +0200 Deployment group is gone. commit f03ee6192450db977bc2e4b07ffc613314b63a80 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Thu Jul 30 16:48:53 2009 +0200 All "lists of classes etc" are now in classes.qdoc... I hope. commit c5fb9a4b5208498454812d27578ac62ae23652a4 Author: Volker Hilsheimer <volker.hilsheimer@nokia.com> Date: Thu Jul 30 16:47:20 2009 +0200 Cleaning up files documenting deployment. Text need to be reviewed and merged.
author: Volker Hilsheimer <volker.hilsheimer@nokia.com> 2009-08-17 16:37:42 (GMT)
committer: Volker Hilsheimer <volker.hilsheimer@nokia.com> 2009-08-17 16:37:42 (GMT)
commit: 911557fcf7dedc002e689a0d66efd2b77e044bd1 (patch)
tree: a66138f008c27f39e5306dc6f2df01c129e11988 /doc/src/sql-programming/sql-driver.qdoc
parent: 285d4b12cb937a5672d6eb15781f03d249f8cfc1 (diff)
download: Qt-911557fcf7dedc002e689a0d66efd2b77e044bd1.zip
Qt-911557fcf7dedc002e689a0d66efd2b77e044bd1.tar.gz
Qt-911557fcf7dedc002e689a0d66efd2b77e044bd1.tar.bz2
1 files changed, 762 insertions, 0 deletions
diff --git a/doc/src/sql-programming/sql-driver.qdoc b/doc/src/sql-programming/sql-driver.qdoc
new file mode 100644
index 0000000..832fd0c
--- /dev/null
+++ b/doc/src/sql-programming/sql-driver.qdoc
@@ -0,0 +1,762 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the either Technology Preview License Agreement or the
+** Beta Release License Agreement.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain
+** additional rights. These rights are described in the Nokia Qt LGPL
+** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
+** package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+** If you are unsure which license is appropriate for your use, please
+** contact the sales department at http://qt.nokia.com/contact.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \page sql-driver.html
+    \title SQL Database Drivers
+    \brief How to configure and install QtSql drivers for supported databases.
+
+    \ingroup best-practices
+
+    The QtSql module uses driver \l{How to Create Qt
+    Plugins}{plugins} to communicate with the different database
+    APIs. Since Qt's SQL Module API is database-independent, all
+    database-specific code is contained within these drivers. Several
+    drivers are supplied with Qt and other drivers can be added. The
+    driver source code is supplied and can be used as a model for
+    \l{#development}{writing your own drivers}.
+
+    \tableofcontents
+
+    \section1 Supported Databases
+
+    The table below lists the drivers included with Qt. Due to
+    license incompatibilities with the GPL, not all of the plugins
+    are provided with Open Source Versions of Qt.
+
+    \table
+    \header \o Driver name \o DBMS
+    \row \o \link #QDB2 QDB2\endlink \o IBM DB2 (version 7.1 and above)
+    \row \o \link #QIBASE QIBASE\endlink \o Borland InterBase
+    \row \o \link #QMYSQL QMYSQL\endlink \o MySQL
+    \row \o \link #QOCI QOCI\endlink \o Oracle Call Interface Driver
+    \row \o \link #QODBC QODBC\endlink
+         \o Open Database Connectivity (ODBC) - Microsoft SQL Server and other
+            ODBC-compliant databases
+    \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 #QTDS QTDS\endlink \o Sybase Adaptive Server
+    \endtable
+
+    \bold{Note:} To build a driver plugin you need to have the appropriate
+    client library for your Database Management System (DBMS). This provides
+    access to the API exposed by the DBMS, and is typically shipped with it.
+    Most installation programs also allow you to install "development
+    libraries", and these are what you need. These libraries are responsible
+    for the low-level communication with the DBMS.
+
+    \target building
+    \section1 Building the Drivers Using Configure
+
+    On Unix and Mac OS X, the Qt \c configure script tries to
+    automatically detect the available client libraries on your
+    machine. Run \c{configure -help} to see what drivers can be
+    built. You should get an output similar to this:
+
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 0
+
+    The \c configure script cannot detect the neccessary libraries
+    and include files if they are not in the standard paths, so it
+    may be necessary to specify these paths using the \c -I and \c -L
+    command-line options. For example, if your MySQL include files
+    are installed in \c /usr/local/mysql (or in \c{C:\mysql\include}
+    on Windows), then pass the following parameter to configure: \c
+    -I/usr/local/mysql (or \c{-I C:\mysql\include} for Windows).
+
+    On Windows the \c -I parameter doesn't accept spaces in
+    filenames, so use the 8.3 name instead; for example, use
+    \c{C:\progra~1\mysql} instead of \c{C:\Program Files\mysql}.
+
+    Use the \c{-qt-sql-<driver>} parameter to build the database driver
+    statically into your Qt library or \c{-plugin-sql-<driver>} to build
+    the driver as a plugin. Look at the sections that follow for
+    additional information about required libraries.
+
+    \target buildingmanually
+    \section1 Building the Plugins Manually
+
+    \target QMYSQL
+    \section2 QMYSQL for MySQL 4 and higher
+
+    \section3 QMYSQL Stored Procedure Support
+
+    MySQL 5 introduces stored procedure support at the SQL level, but no
+    API to control IN, OUT and INOUT parameters. Therefore, parameters
+    have to be set and read using SQL commands instead of QSqlQuery::bindValue().
+
+    Example stored procedure:
+
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 1
+
+    Source code to access the OUT values:
+
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 2
+
+    \bold{Note:} \c{@outval1} and \c{@outval2} are variables local to the current
+    connection and will not be affected by queries sent from another host
+    or connection.
+
+    \section3 Embedded MySQL Server
+
+    The MySQL embedded server is a drop-in replacement for the normal
+    client library. With the embedded MySQL server, a MySQL server is
+    not required to use MySQL functionality.
+
+    To use the embedded MySQL server, simply link the Qt plugin to \c
+    libmysqld instead of libmysqlclient. This can be done by replacing
+    \c -lmysqlclient_r by \c -lmysqld in the \c qmake command in the
+    section below.
+
+    Please refer to the MySQL documentation, chapter "libmysqld, the Embedded
+    MySQL Server Library" for more information about the MySQL embedded server.
+
+    \section3 How to Build the QMYSQL Plugin on Unix and Mac OS X
+
+    You need the MySQL header files and as well as the shared library
+    \c{libmysqlclient.so}. Depending on your Linux distribution you may
+    need to install a package which is usually called "mysql-devel".
+
+    Tell \l qmake where to find the MySQL header files and shared
+    libraries (here it is assumed that MySQL is installed in
+    \c{/usr/local}) and run \c{make}:
+
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 3
+
+    After installing Qt, as described in the \l{Installing Qt on X11
+    Platforms} document, you also need to install the plugin in the
+    standard location:
+
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 4
+
+    \section3 How to Build the QMYSQL Plugin on Windows
+
+    You need to get the MySQL installation files. Run \c SETUP.EXE and
+    choose "Custom Install". Install the "Libs & Include Files" Module.
+    Build the plugin as follows (here it is assumed that MySQL is
+    installed in \c{C:\MySQL}):
+
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 5
+
+    If you are not using a Microsoft compiler, replace \c nmake with \c
+    make in the line above.
+
+    \note This database plugin is not supported for Windows CE.
+
+    \note Including \c{"-o Makefile"} as an argument to \l qmake to
+    tell it where to build the makefile can cause the plugin to be
+    built in release mode only. If you are expecting a debug version
+    to be built as well, don't use the \c{"-o Makefile"} option.
+
+    \target QOCI
+    \section2 QOCI for the Oracle Call Interface (OCI)
+
+    \section3 General Information about the OCI plugin
+
+    The Qt OCI plugin supports Oracle 9i, 10g and higher. After
+    connecting to the Oracle server, the plugin will auto-detect the
+    database version and enable features accordingly.
+
+    It's possible to connect to a Oracle database without a tnsnames.ora file.
+    This requires that the database SID is passed to the driver as the database
+    name and that a hostname is given.
+
+    \section3 OCI User Authentication
+
+    The Qt OCI plugin supports authentication using
+    external credentials (OCI_CRED_EXT). Usually, this means that the database
+    server will use the user authentication provided by the operating system
+    instead of its own authentication mechanism.
+
+    Leave the username and password empty when opening a connection with
+    QSqlDatabase to use the external credentials authentication.
+
+    \section3 OCI BLOB/LOB Support
+
+    Binary Large Objects (BLOBs) can be read and written, but be aware
+    that this process may require a lot of memory. You should use a forward
+    only query to select LOB fields (see QSqlQuery::setForwardOnly()).
+
+    Inserting BLOBs should be done using either a prepared query where the
+    BLOBs are bound to placeholders or QSqlTableModel, which uses a prepared
+    query to do this internally.
+
+    \section3 How to Build the OCI Plugin on Unix and Mac OS X
+
+    For Oracle 10g, all you need is the "Instant Client Package - Basic" and
+    "Instant Client Package - SDK". For Oracle prior to 10g, you require
+    the standard Oracle client and the SDK packages.
+
+    Oracle library files required to build the driver:
+
+    \list
+    \i \c libclntsh.so (all versions)
+    \i \c libwtc9.so (only Oracle 9)
+    \endlist
+
+    Tell \c qmake where to find the Oracle header files and shared
+    libraries and run make:
+
+    For Oracle version 9:
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 6
+
+    For Oracle version 10, we assume that you installed the RPM packages of the
+    Instant Client Package SDK (you need to adjust the version number accordingly):
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 7
+
+    \bold{Note:} If you are using the Oracle Instant Client package,
+    you will need to set LD_LIBRARY_PATH when building the OCI SQL plugin
+    and when running an applicaiton that uses the OCI SQL plugin. You can
+    avoid this requirement by setting and RPATH and listing all of the
+    libraries to link to. Here is an example:
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 32
+
+    If you wish to build the OCI plugin manually with this method the procedure looks like this:
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 33
+
+    \section3 How to Build the OCI Plugin on Windows
+
+    Choosing the option "Programmer" in the Oracle Client Installer from
+    the Oracle Client Installation CD is sufficient to build the plugin.
+
+    Build the plugin as follows (here it is assumed that Oracle Client is
+    installed in \c{C:\oracle}):
+
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 8
+
+    If you are not using a Microsoft compiler, replace \c nmake with \c
+    make in the line above.
+
+    When you run your application you will also need to add the \c oci.dll
+    path to your \c PATH environment variable:
+
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 9
+
+    \bold{Note:} This database plugin is not supported for Windows CE.
+
+    \target QODBC
+    \section2 QODBC for Open Database Connectivity (ODBC)
+
+    \section3 General Information about the ODBC plugin
+
+    ODBC is a general interface that allows you to connect to multiple
+    DBMSs using a common interface. The QODBC driver allows you to connect
+    to an ODBC driver manager and access the available data sources. Note
+    that you also need to install and configure ODBC drivers for the ODBC
+    driver manager that is installed on your system. The QODBC plugin
+    then allows you to use these data sources in your Qt applications.
+
+    \bold{Note:} You should use native drivers in preference to the ODBC
+    driver where they are available. ODBC support can be used as a fallback
+    for compliant databases if no native drivers are available.
+
+    On Windows an ODBC driver manager should be installed by default.
+    For Unix systems there are some implementations which must be
+    installed first. Note that every client that uses your application is
+    required to have an ODBC driver manager installed, otherwise the
+    QODBC plugin will not work.
+
+    Be aware that when connecting to an ODBC datasource you must pass in
+    the name of the ODBC datasource to the QSqlDatabase::setDatabaseName()
+    function rather than the actual database name.
+
+    The QODBC Plugin needs an ODBC compliant driver manager version 2.0 or
+    later to work. Some ODBC drivers claim to be version 2.0 compliant,
+    but do not offer all the necessary functionality. The QODBC plugin
+    therefore checks whether the data source can be used after a
+    connection has been established and refuses to work if the check
+    fails. If you don't like this behavior, you can remove the \c{#define
+    ODBC_CHECK_DRIVER} line from the file \c{qsql_odbc.cpp}. Do this at
+    your own risk!
+
+    By default, Qt instructs the ODBC driver to behave as an ODBC 2.x
+    driver. However, for some \e{driver-manager/ODBC 3.x-driver}
+    combinations (e.g., \e{unixODBC/MaxDB ODBC}), telling the ODBC
+    driver to behave as a 2.x driver can cause the driver plugin to
+    have unexpected behavior. To avoid this problem, instruct the ODBC
+    driver to behave as a 3.x driver by
+    \l{QSqlDatabase::setConnectOptions()} {setting the connect option}
+    \c{"SQL_ATTR_ODBC_VERSION=SQL_OV_ODBC3"} before you
+    \l{QSqlDatabase::open()} {open your database connection}. Note
+    that this will affect multiple aspects of ODBC driver behavior,
+    e.g., the SQLSTATEs.  Before setting this connect option, consult
+    your ODBC documentation about behavior differences you can expect.
+
+    If you experience very slow access of the ODBC datasource, make sure
+    that ODBC call tracing is turned off in the ODBC datasource manager.
+
+    Some drivers don't support scrollable cursors. In that case case only
+    queries in forwardOnly mode can be used successfully.
+
+    \section3 ODBC Stored Procedure Support
+
+    With Microsoft SQL Server the result set returned by a stored
+    procedure that uses the return statement, or returns multiple result
+    sets, will be accessible only if you set the query's forward only
+    mode to \e forward using \l QSqlQuery::setForwardOnly().
+
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 10
+
+    \bold{Note:} The value returned by the stored procedure's return statement
+    is discarded.
+
+    \section3 ODBC Unicode Support
+
+    The QODBC Plugin will use the Unicode API if UNICODE is defined. On
+    Windows NT based systems, this is the default. Note that the ODBC
+    driver and the DBMS must also support Unicode.
+
+    Some driver managers and drivers don't support UNICODE. To use the
+    QODBC plugin with such drivers it has to be compiled with the
+    Q_ODBC_VERSION_2 defined.
+
+    For the Oracle 9 ODBC driver (Windows), it is neccessary to check
+    "SQL_WCHAR support" in the ODBC driver manager otherwise Oracle
+    will convert all Unicode strings to local 8-bit.
+
+    \section3 How to Build the ODBC Plugin on Unix and Mac OS X
+
+    It is recommended that you use unixODBC. You can find the latest
+    version and ODBC drivers at \l http://www.unixodbc.org.
+    You need the unixODBC header files and shared libraries.
+
+    Tell \c qmake where to find the unixODBC header files and shared
+    libraries (here it is assumed that unixODBC is installed in
+    \c{/usr/local/unixODBC}) and run \c{make}:
+
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 11
+
+    \section3 How to Build the ODBC Plugin on Windows
+
+    The ODBC header and include files should already be installed in the
+    right directories. You just have to build the plugin as follows:
+
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 12
+
+    If you are not using a Microsoft compiler, replace \c nmake with \c
+    make in the line above.
+
+    \bold{Note:} This database plugin is not officially supported for Windows CE.
+
+    \target QPSQL
+    \section2 QPSQL for PostgreSQL (Version 7.3 and Above)
+
+    \section3 General Information about the QPSQL driver
+
+    The QPSQL driver supports version 7.3 and higher of the PostgreSQL server.
+    We recommend that you use a client library from version 7.3.15, 7.4.13,
+    8.0.8, 8.1.4 or more recent as these versions contain security fixes, and
+    as the QPSQL driver might not build with older versions of the client
+    library depending on your platform.
+
+    For more information about PostgreSQL visit \l http://www.postgresql.org.
+
+    \section3 QPSQL Unicode Support
+
+    The QPSQL driver automatically detects whether the PostgreSQL
+    database you are connecting to supports Unicode or not. Unicode is
+    automatically used if the server supports it. Note that the driver
+    only supports the UTF-8 encoding. If your database uses any other
+    encoding, the server must be compiled with Unicode conversion
+    support.
+
+    Unicode support was introduced in PostgreSQL version 7.1 and it will
+    only work if both the server and the client library have been compiled
+    with multibyte support. More information about how to set up a
+    multibyte enabled PostgreSQL server can be found in the PostgreSQL
+    Administrator Guide, Chapter 5.
+
+    \section3 QPSQL BLOB Support
+
+    Binary Large Objects are supported through the \c BYTEA field type in
+    PostgreSQL server versions >= 7.1.
+
+    \section3 How to Build the QPSQL Plugin on Unix and Mac OS X
+
+    You need the PostgreSQL client library and headers installed.
+
+    To make \c qmake find the PostgreSQL header files and shared
+    libraries, run \c qmake the following way (assuming that the
+    PostgreSQL client is installed in \c{/usr}):
+
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 13
+
+    After installing Qt, as described in the \l{Installing Qt on X11 Platforms} document,
+    you also need to install the plugin in the standard location:
+
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 14
+
+    \section3 How to Build the QPSQL Plugin on Windows
+
+    Install the appropriate PostgreSQL developer libraries for your
+    compiler. Assuming that PostgreSQL was installed in \c{C:\psql},
+    build the plugin as follows:
+
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 15
+
+    Users of MinGW may wish to consult the following online document:
+    \l{Compiling PostgreSQL On Native Win32 FAQ}.
+
+    \bold{Note:} This database plugin is not supported for Windows CE.
+
+    \target QTDS
+    \section2 QTDS for Sybase Adaptive Server
+    \section3 General Information about QTDS
+
+    It is not possible to set the port with QSqlDatabase::setPort() due to limitations in the
+    Sybase client library. Refer to the Sybase documentation for information on how to set up
+    a Sybase client configuration file to enable connections to databases on non-default ports.
+
+    \section3 How to Build the QDTS Plugin on Unix and Mac OS X
+
+    Under Unix, two libraries are available which support the TDS protocol:
+
+    \list
+    \i FreeTDS, a free implementation of the TDS protocol
+      (\l{http://www.freetds.org}). Note that FreeTDS is not yet stable,
+      so some functionality may not work as expected.
+
+    \i Sybase Open Client, available from \l{http://www.sybase.com}.
+      Note for Linux users: Get the Open Client RPM from
+      \l{http://linux.sybase.com}.
+    \endlist
+
+    Regardless of which library you use, the shared object file
+    \c{libsybdb.so} is needed. Set the \c SYBASE environment variable to
+    point to the directory where you installed the client library and
+    execute \c{qmake}:
+
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 16
+
+    \section3 How to Build the QDTS Plugin on Windows
+
+    You can either use the DB-Library supplied by Microsoft or the Sybase
+    Open Client (\l{http://www.sybase.com}). You must include \c
+    NTWDBLIB.LIB to build the plugin:
+
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 17
+
+    By default the Microsoft library is used on Windows, if you want to
+    force the use of the Sybase Open Client, you must define \c
+    Q_USE_SYBASE in \c{%QTDIR%\src\sql\drivers\tds\qsql_tds.cpp}. If you
+    are not using a Microsoft compiler, replace \c nmake with \c make in
+    the line above.
+
+    \bold{Note:} This database plugin is not supported for Windows CE.
+
+    \target QDB2
+    \section2 QDB2 for IBM DB2 (Version 7.1 and Above)
+
+    \section3 General Information about QDB2
+
+    The Qt DB2 plugin makes it possible to access IBM DB2 databases. It
+    has been tested with IBM DB2 v7.1 and 7.2. You must install the IBM
+    DB2 development client library, which contains the header and library
+    files necessary for compiling the QDB2 plugin.
+
+    The QDB2 driver supports prepared queries, reading/writing of Unicode
+    strings and reading/writing of BLOBs.
+
+    We suggest using a forward-only query when calling stored procedures
+    in DB2 (see QSqlQuery::setForwardOnly()).
+
+    \section3 How to Build the QDB2 Plugin on Unix and Mac OS X
+
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 18
+
+    After installing Qt, as described in the \l{Installing Qt on X11 Platforms} document,
+    you also need to install the plugin in the standard location:
+
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 19
+
+    \section3 How to Build the QDB2 Plugin on Windows
+
+    The DB2 header and include files should already be installed in the
+    right directories. You just have to build the plugin as follows:
+
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 20
+
+    If you are not using a Microsoft compiler, replace \c nmake
+    with \c make in the line above.
+
+    \bold{Note:} This database plugin is not supported for Windows CE.
+
+    \target QSQLITE2
+    \section2 QSQLITE2 for SQLite Version 2
+
+    The Qt SQLite 2 plugin is offered for compatibility. Whenever
+    possible, use the \l{#QSQLITE}{version 3 plugin} instead. The
+    build instructions for version 3 apply to version 2 as well.
+
+    \target QSQLITE
+    \section2 QSQLITE for SQLite (Version 3 and Above)
+
+    \section3 General Information about QSQLITE
+
+    The Qt SQLite plugin makes it possible to access SQLite
+    databases. SQLite is an in-process database, which means that it
+    is not necessary to have a database server. SQLite operates on a
+    single file, which must be set as the database name when opening
+    a connection. If the file does not exist, SQLite will try to
+    create it. SQLite also supports in-memory databases, simply pass
+    ":memory:" as the database name.
+
+    SQLite has some restrictions regarding multiple users and
+    multiple transactions. If you try to read/write on a resource from different
+    transactions, your application might freeze until one transaction commits
+    or rolls back. The Qt SQLite driver will retry to write to a locked resource
+    until it runs into a timeout (see \c{QSQLITE_BUSY_TIMEOUT}
+    at QSqlDatabase::setConnectOptions()).
+
+    In SQLite any column, with the exception of an INTEGER PRIMARY KEY column,
+    may be used to store any type of value. For instance, a column declared as
+    INTEGER may contain an integer value in one row and a text value in the
+    next. This is due to SQLite associating the type of a value with the value
+    itself rather than with the column it is stored in. A consequence of this
+    is that the type returned by QSqlField::type() only indicates the field's
+    recommended type. No assumption of the actual type should be made from
+    this and the type of the individual values should be checked.
+
+    The driver is locked for updates while a select is executed. This
+    may cause problems when using QSqlTableModel because Qt's item views
+    fetch data as needed (with QSqlQuery::fetchMore() in the case of
+    QSqlTableModel).
+
+    You can find information about SQLite on \l{http://www.sqlite.org}.
+
+    \section3 How to Build the QSQLITE Plugin
+
+    SQLite version 3 is included as a third-party library within Qt.
+    It can be built by passing the following parameters to the
+    configure script: \c{-plugin-sql-sqlite} (build as a plugin) or
+    \c{-qt-sql-sqlite} (linked directly into the Qt library).
+
+    If you don't want to use the SQLite library included with Qt, you
+    can build it manually (replace \c $SQLITE by the directory where
+    SQLite resides):
+
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 21
+
+    After installing Qt, as described in the \l{Installing Qt on X11 Platforms} document,
+    you also need to install the plugin in the standard location:
+
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 22
+
+    On Windows:
+
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 23
+
+    \section3 QSQLITE File Format Compatibility
+
+    SQLite minor releases sometimes break file format forward compatibility.
+    For example, SQLite 3.3 can read database files created with SQLite 3.2,
+    but databases created with SQLite 3.3 cannot be read by SQLite 3.2.
+    Please refer to the SQLite documentation and change logs for information about
+    file format compatibility between versions.
+
+    Qt minor releases usually follow the SQLite minor releases, while Qt patch releases
+    follow SQLite patch releases. Patch releases are therefore both backward and forward
+    compatible.
+
+    To force SQLite to use a specific file format, it is neccessary to build and
+    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 QIBASE
+    \section2 QIBASE for Borland InterBase
+
+    \section3 General Information about QIBASE
+
+    The Qt InterBase plugin makes it possible to access the InterBase and
+    Firebird databases. InterBase can either be used as a client/server or
+    without a server in which case it operates on local files. The
+    database file must exist before a connection can be established.
+
+    Note that InterBase requires you to specify the full path to the
+    database file, no matter whether it is stored locally or on another
+    server.
+
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 24
+
+    You need the InterBase/Firebird development headers and libraries
+    to build this plugin.
+
+    Due to license incompatibilities with the GPL, users of the Qt Open Source
+    Edition are not allowed to link this plugin to the commercial editions of
+    InterBase. Please use Firebird or the free edition of InterBase.
+
+    \section3 QIBASE Unicode Support and Text Encoding
+
+    By default the driver connects to the database using UNICODE_FSS. This can
+    be overridden by setting the ISC_DPB_LC_CTYPE parameter with
+    QSqlDatabase::setConnectOptions() before opening the connection.
+
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 25
+
+    If Qt doesn't support the given text encoding the driver will issue a
+    warning message and connect to the database using UNICODE_FSS.
+
+    Note that if the text encoding set when connecting to the database is
+    not the same as in the database, problems with transliteration might arise.
+
+    \section3 QIBASE Stored procedures
+
+    InterBase/Firebird return OUT values as result set, so when calling stored
+    procedure, only IN values need to be bound via QSqlQuery::bindValue(). The
+    RETURN/OUT values can be retrieved via QSqlQuery::value(). Example:
+
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 26
+
+    \section3 How to Build the QIBASE Plugin on Unix and Mac OS X
+
+    The following assumes InterBase or Firebird is installed in
+    \c{/opt/interbase}:
+
+    If you are using InterBase:
+
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 27
+
+    If you are using Firebird, the Firebird library has to be set explicitly:
+
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 28
+
+    \section3 How to Build the QIBASE Plugin on Windows
+
+    The following assumes InterBase or Firebird is installed in
+    \c{C:\interbase}:
+
+    If you are using InterBase:
+
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 29
+
+    If you are using Firebird, the Firebird library has to be set explicitely:
+
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 30
+
+    If you are not using a Microsoft compiler, replace \c nmake
+    with \c make in the line above.
+
+    Note that \c{C:\interbase\bin} must be in the \c PATH.
+
+    \bold{Note:} This database plugin is not supported for Windows CE.
+
+    \target troubleshooting
+    \section1 Troubleshooting
+
+    You should always use client libraries that have been compiled with
+    the same compiler as you are using for your project. If you cannot get
+    a source distibution to compile the client libraries yourself, you
+    must make sure that the pre-compiled library is compatible with
+    your compiler, otherwise you will get a lot of "undefined symbols"
+    errors. Some compilers have tools to convert libraries, e.g. Borland
+    ships the tool \c{COFF2OMF.EXE} to convert libraries that have been
+    generated with Microsoft Visual C++.
+
+    If the compilation of a plugin succeeds but it cannot be loaded,
+    make sure that the following requirements are met:
+
+    \list
+    \i Ensure that you are using a shared Qt library; you cannot use the
+        plugins with a static build.
+    \i Ensure that the plugin is in the correct directory. You can use
+        QApplication::libraryPaths() to determine where Qt looks for plugins.
+    \i Ensure that the client libraries of the DBMS are available on the
+        system. On Unix, run the command \c{ldd} and pass the name of the
+        plugin as parameter, for example \c{ldd libqsqlmysql.so}. You will
+        get a warning if any of the client libraries couldn't be found.
+        On Windows, you can use Visual Studio's dependency walker.
+    \i Compile Qt with \c{QT_DEBUG_COMPONENT} defined to get very verbose
+        debug output when loading plugins.
+    \endlist
+
+    Make sure you have followed the guide to \l{Deploying Plugins}.
+    If you experience plugin load problems and see output like this:
+
+    \snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 31
+
+    the problem is usually that the plugin had the wrong \l{Deploying
+    Plugins#The Build Key}{build key}. This might require removing an
+    entry from the \l{Deploying Plugins#The Plugin Cache} {plugin cache}.
+
+    \target development
+    \section1 How to Write Your Own Database Driver
+
+    QSqlDatabase is responsible for loading and managing database driver
+    plugins. When a database is added (see QSqlDatabase::addDatabase()),
+    the appropriate driver plugin is loaded (using QSqlDriverPlugin).
+    QSqlDatabase relies on the driver plugin to provide interfaces for
+    QSqlDriver and QSqlResult.
+
+    QSqlDriver is an abstract base class which defines the functionality
+    of a SQL database driver. This includes functions such as
+    QSqlDriver::open() and QSqlDriver::close(). QSqlDriver is responsible
+    for connecting to a database, establish the proper environment, etc.
+    In addition, QSqlDriver can create QSqlQuery objects appropriate for
+    the particular database API. QSqlDatabase forwards many of its
+    function calls directly to QSqlDriver which provides the concrete
+    implementation.
+
+    QSqlResult is an abstract base class which defines the functionality
+    of a SQL database query. This includes statements such as \c{SELECT},
+    \c{UPDATE}, and \c{ALTER} \c{TABLE}. QSqlResult contains functions
+    such as QSqlResult::next() and QSqlResult::value(). QSqlResult is
+    responsible for sending queries to the database, returning result
+    data, etc. QSqlQuery forwards many of its function calls directly to
+    QSqlResult which provides the concrete implementation.
+
+    QSqlDriver and QSqlResult are closely connected. When implementing a
+    Qt SQL driver, both of these classes must to be subclassed and the
+    abstract virtual methods in each class must be implemented.
+
+    To implement a Qt SQL driver as a plugin (so that it is
+    recognized and loaded by the Qt library at runtime), the driver
+    must use the Q_EXPORT_PLUGIN2() macro. Read \l{How to Create Qt
+    Plugins} for more information on this. You can also check out how
+    this is done in the SQL plugins that are provided with Qt in
+    \c{QTDIR/src/plugins/sqldrivers} and \c{QTDIR/src/sql/drivers}.
+
+    The following code can be used as a skeleton for a SQL driver:
+
+    \snippet doc/src/snippets/sqldatabase/sqldatabase.cpp 47
+    \codeline
+    \snippet doc/src/snippets/sqldatabase/sqldatabase.cpp 48
+*/
author	Volker Hilsheimer <volker.hilsheimer@nokia.com>	2009-08-17 16:37:42 (GMT)
committer	Volker Hilsheimer <volker.hilsheimer@nokia.com>	2009-08-17 16:37:42 (GMT)
commit	911557fcf7dedc002e689a0d66efd2b77e044bd1 (patch)
tree	a66138f008c27f39e5306dc6f2df01c129e11988 /doc/src/sql-programming/sql-driver.qdoc
parent	285d4b12cb937a5672d6eb15781f03d249f8cfc1 (diff)
download	Qt-911557fcf7dedc002e689a0d66efd2b77e044bd1.zip Qt-911557fcf7dedc002e689a0d66efd2b77e044bd1.tar.gz Qt-911557fcf7dedc002e689a0d66efd2b77e044bd1.tar.bz2