diff --git a/examples/assistant/assistant.pro b/examples/assistant/assistant.pro index fd289a670e4af6e5f4acbfd130140de4c3b958a8..578c7ff5bf734576d5f624e60da5d0f63d2cfcde 100644 --- a/examples/assistant/assistant.pro +++ b/examples/assistant/assistant.pro @@ -1,4 +1,5 @@ TEMPLATE = subdirs CONFIG += ordered -SUBDIRS += simpletextviewer +SUBDIRS += simpletextviewer \ + remotecontrol diff --git a/examples/assistant/simpletextviewer/doc/images/simpletextviewer-example.png b/examples/assistant/doc/images/simpletextviewer-example.png similarity index 100% rename from examples/assistant/simpletextviewer/doc/images/simpletextviewer-example.png rename to examples/assistant/doc/images/simpletextviewer-example.png diff --git a/examples/assistant/simpletextviewer/doc/images/simpletextviewer-findfiledialog.png b/examples/assistant/doc/images/simpletextviewer-findfiledialog.png similarity index 100% rename from examples/assistant/simpletextviewer/doc/images/simpletextviewer-findfiledialog.png rename to examples/assistant/doc/images/simpletextviewer-findfiledialog.png diff --git a/examples/assistant/simpletextviewer/doc/images/simpletextviewer-mainwindow.png b/examples/assistant/doc/images/simpletextviewer-mainwindow.png similarity index 100% rename from examples/assistant/simpletextviewer/doc/images/simpletextviewer-mainwindow.png rename to examples/assistant/doc/images/simpletextviewer-mainwindow.png diff --git a/examples/assistant/doc/src/remotecontrol.qdoc b/examples/assistant/doc/src/remotecontrol.qdoc new file mode 100644 index 0000000000000000000000000000000000000000..5a8106fdb90d2ff6f7d866c61635414861d11948 --- /dev/null +++ b/examples/assistant/doc/src/remotecontrol.qdoc @@ -0,0 +1,34 @@ +/**************************************************************************** +** +** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/contact-us. +** +** GNU Free Documentation License Usage +** 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. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \example remotecontrol + \ingroup examples-qtassistant + \title Remote Control Example + + \brief Using and controlling Qt Assistant as a help viewer. +*/ diff --git a/examples/assistant/simpletextviewer/doc/src/simpletextviewer.qdoc b/examples/assistant/doc/src/simpletextviewer.qdoc similarity index 99% rename from examples/assistant/simpletextviewer/doc/src/simpletextviewer.qdoc rename to examples/assistant/doc/src/simpletextviewer.qdoc index 5469e0270a916d5852d124d2eafc8cce6178ad77..bf74e10ede947f381bb75118550ecbe0ceb493bb 100644 --- a/examples/assistant/simpletextviewer/doc/src/simpletextviewer.qdoc +++ b/examples/assistant/doc/src/simpletextviewer.qdoc @@ -27,10 +27,10 @@ /*! \example simpletextviewer + \ingroup examples-qtassistant \title Simple Text Viewer Example - \brief The Simple Text Viewer example shows how to use \QA as a customized - help viewer for your application. + \brief Using \QA as a customized help viewer for your application. \image simpletextviewer-example.png diff --git a/examples/help/remotecontrol/enter.png b/examples/assistant/remotecontrol/enter.png similarity index 100% rename from examples/help/remotecontrol/enter.png rename to examples/assistant/remotecontrol/enter.png diff --git a/examples/help/remotecontrol/main.cpp b/examples/assistant/remotecontrol/main.cpp similarity index 100% rename from examples/help/remotecontrol/main.cpp rename to examples/assistant/remotecontrol/main.cpp diff --git a/examples/help/remotecontrol/remotecontrol.cpp b/examples/assistant/remotecontrol/remotecontrol.cpp similarity index 100% rename from examples/help/remotecontrol/remotecontrol.cpp rename to examples/assistant/remotecontrol/remotecontrol.cpp diff --git a/examples/help/remotecontrol/remotecontrol.h b/examples/assistant/remotecontrol/remotecontrol.h similarity index 100% rename from examples/help/remotecontrol/remotecontrol.h rename to examples/assistant/remotecontrol/remotecontrol.h diff --git a/examples/help/remotecontrol/remotecontrol.pro b/examples/assistant/remotecontrol/remotecontrol.pro similarity index 100% rename from examples/help/remotecontrol/remotecontrol.pro rename to examples/assistant/remotecontrol/remotecontrol.pro diff --git a/examples/help/remotecontrol/remotecontrol.qrc b/examples/assistant/remotecontrol/remotecontrol.qrc similarity index 100% rename from examples/help/remotecontrol/remotecontrol.qrc rename to examples/assistant/remotecontrol/remotecontrol.qrc diff --git a/examples/help/remotecontrol/remotecontrol.ui b/examples/assistant/remotecontrol/remotecontrol.ui similarity index 100% rename from examples/help/remotecontrol/remotecontrol.ui rename to examples/assistant/remotecontrol/remotecontrol.ui diff --git a/examples/designer/doc/src/arthurplugin.qdoc b/examples/designer/doc/src/arthurplugin.qdoc index 0f116e72c609e0383e649e66d9c7343834178b11..9dbfaa7e83a4c81a3b44a4a07181178939efd40e 100644 --- a/examples/designer/doc/src/arthurplugin.qdoc +++ b/examples/designer/doc/src/arthurplugin.qdoc @@ -27,10 +27,10 @@ /*! \example arthurplugin + \ingroup examples-designer \title Arthur Plugin - \brief In this example we demonstrate the abilities of Qt's painting system - in combination with \QD's custom widget plugin facilities. + \brief Using the Qt painting system with \QD custom widget plugins. \image arthurplugin-demo.png diff --git a/examples/designer/doc/src/calculatorbuilder.qdoc b/examples/designer/doc/src/calculatorbuilder.qdoc index b8453544fddf61561c7eb15ff63631a0d732cb11..cb6f6f458f5dbace58b87189ba1e04c2fb2567ca 100644 --- a/examples/designer/doc/src/calculatorbuilder.qdoc +++ b/examples/designer/doc/src/calculatorbuilder.qdoc @@ -27,10 +27,10 @@ /*! \example calculatorbuilder + \ingroup examples-designer \title Calculator Builder Example - \brief The Calculator Builder example shows how to create a user interface from - a \QD form at run-time, using the QUiLoader class. + \brief Creating a user interface from a \QD form at run-time. \image calculatorbuilder-example.png diff --git a/examples/designer/doc/src/calculatorform.qdoc b/examples/designer/doc/src/calculatorform.qdoc index 063086b3bd5aa4c35e444760057cfe9356d5da43..68e47c121815cb4d1d9e9d68ff8261a5834a204f 100644 --- a/examples/designer/doc/src/calculatorform.qdoc +++ b/examples/designer/doc/src/calculatorform.qdoc @@ -27,9 +27,12 @@ /*! \example calculatorform + \ingroup examples-designer \title Calculator Form Example - \brief The Calculator Form Example shows how to use a form created with + \brief Using a form created with \QD in an application. + + 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} {uic's auto-connection} feature to automatically connect signals diff --git a/examples/designer/doc/src/containerextension.qdoc b/examples/designer/doc/src/containerextension.qdoc index 093993a5fce2e7c8971626d2a4ebb9431a7ddaab..5b1b55157055dd0e8d63527c97536ea9761fa614 100644 --- a/examples/designer/doc/src/containerextension.qdoc +++ b/examples/designer/doc/src/containerextension.qdoc @@ -27,10 +27,13 @@ /*! \example containerextension + \ingroup examples-designer \title Container Extension Example - \brief The Container Extension example shows how to create a custom - multi-page plugin for Qt Designer using the + \brief Creating a custom multi-page plugin for \QD. + + The Container Extension example shows how to create a custom multi-page + plugin for \QD using the QDesignerContainerExtension class. \image containerextension-example.png diff --git a/examples/designer/doc/src/customwidgetplugin.qdoc b/examples/designer/doc/src/customwidgetplugin.qdoc index 3206136bb2f2ecd2dcbe38d3f5cdbb89b2437c6a..b96b3d3ce9b8a4433a718326216b42d18ecdbd6f 100644 --- a/examples/designer/doc/src/customwidgetplugin.qdoc +++ b/examples/designer/doc/src/customwidgetplugin.qdoc @@ -27,9 +27,10 @@ /*! \example customwidgetplugin + \ingroup examples-designer \title Custom Widget Plugin Example - \brief The Custom Widget example shows how to create a custom widget plugin for \QD. + \brief Creating a custom widget plugin for Qt Designer. \image customwidgetplugin-example.png diff --git a/examples/designer/doc/src/taskmenuextension.qdoc b/examples/designer/doc/src/taskmenuextension.qdoc index ee80bad9faa009cda70634daab3352d1f9b4244f..b40e7b811e3d7ab82642a2f5f770b88e5e95d0a7 100644 --- a/examples/designer/doc/src/taskmenuextension.qdoc +++ b/examples/designer/doc/src/taskmenuextension.qdoc @@ -27,9 +27,13 @@ /*! \example taskmenuextension + \ingroup examples-designer \title Task Menu Extension Example - \brief The Task Menu Extension example shows how to create a custom + \brief Creating a custom widget plugin for \QD and providing custom task + menu entries that are associated with the plugin. + + 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/examples/designer/doc/src/worldtimeclockbuilder.qdoc b/examples/designer/doc/src/worldtimeclockbuilder.qdoc index 721d59e91674bf215daf6c06845e64ce11a4ebb5..980c0f6b1c43e804f73fd5b7b71f425dad1be6a2 100644 --- a/examples/designer/doc/src/worldtimeclockbuilder.qdoc +++ b/examples/designer/doc/src/worldtimeclockbuilder.qdoc @@ -27,11 +27,11 @@ /*! \example worldtimeclockbuilder + \ingroup examples-designer \title World Time Clock Builder Example - \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. + \brief Creating forms with Qt Designer that contain custom widgets that can be + dynamically generated at run-time. \image worldtimeclockbuilder-example.png diff --git a/examples/designer/doc/src/worldtimeclockplugin.qdoc b/examples/designer/doc/src/worldtimeclockplugin.qdoc index 58770a4a5ca2f04e797a5d606dbe003c67d83a49..4d3042be180c264c86fb7a9bdafcc089ea4982cf 100644 --- a/examples/designer/doc/src/worldtimeclockplugin.qdoc +++ b/examples/designer/doc/src/worldtimeclockplugin.qdoc @@ -27,10 +27,10 @@ /*! \example worldtimeclockplugin + \ingroup examples-designer \title World Time Clock Plugin Example - \brief The World Time Clock Plugin example shows how to create a custom - widget plugin for \QD that uses signals and slots. + \brief Creating a custom widget plugin for \QD that uses signals and slots. \image worldtimeclockplugin-example.png diff --git a/examples/help/doc/src/contextsensitivehelp.qdoc b/examples/help/doc/src/contextsensitivehelp.qdoc new file mode 100644 index 0000000000000000000000000000000000000000..2e98cafb6965aeb37816657d8f9737611a0a34a5 --- /dev/null +++ b/examples/help/doc/src/contextsensitivehelp.qdoc @@ -0,0 +1,35 @@ +/**************************************************************************** +** +** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/contact-us. +** +** GNU Free Documentation License Usage +** 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. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \example contextsensitivehelp + \ingroup examples-qthelp + \title Context-Sensitive Help Example + + \brief Using the QHelpEngineCore class to implement context-sensitive help + for applications. +*/ diff --git a/examples/help/help.pro b/examples/help/help.pro index c98aad8a99c3c2ff6b4eaf35feb875d6d69592c3..49aae931da3f726e49f357e6c345cad94a89db6a 100644 --- a/examples/help/help.pro +++ b/examples/help/help.pro @@ -1,5 +1,4 @@ TEMPLATE = subdirs CONFIG += ordered -SUBDIRS += contextsensitivehelp \ - remotecontrol +SUBDIRS += contextsensitivehelp diff --git a/examples/uitools/doc/src/multipleinheritance.qdoc b/examples/uitools/doc/src/multipleinheritance.qdoc index aec4da965c5613f9e6006937227f8ee099c26677..ca3ade2db050107fc7e6411ec693eab1b3311ac4 100644 --- a/examples/uitools/doc/src/multipleinheritance.qdoc +++ b/examples/uitools/doc/src/multipleinheritance.qdoc @@ -27,8 +27,11 @@ /*! \example multipleinheritance + \ingroup examples-qtuitools \title Multiple Inheritance Example + \brief Using a form created with Qt Designer in an application. + The Multiple Inheritance Example shows how to use a form created with Qt Designer in an application by subclassing both QWidget and the user interface class, which is \c{Ui::CalculatorForm}. diff --git a/examples/uitools/doc/src/textfinder.qdoc b/examples/uitools/doc/src/textfinder.qdoc index c05e3506998bd74e522d93f024fca822bb123d56..7552b08c8118a6ff450e06506ce45f1e04f48430 100644 --- a/examples/uitools/doc/src/textfinder.qdoc +++ b/examples/uitools/doc/src/textfinder.qdoc @@ -27,10 +27,12 @@ /*! \example textfinder + \ingroup examples-qtuitools \title Text Finder Example - \brief The Text Finder example demonstrates how to dynamically process forms - using the Qt UI Tools module. Dynamic form processing enables a form to + \brief Dynamically processing forms using Qt UI Tools. + + 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/src/assistant/assistant/doc/src/assistant-example.qdoc b/src/assistant/assistant/doc/src/assistant-example.qdoc index 5cc03ef6fdff96d54632b4e717f22f0713fbc3b4..f107202b3f4d21e06bd7098b049345b69ad82804 100644 --- a/src/assistant/assistant/doc/src/assistant-example.qdoc +++ b/src/assistant/assistant/doc/src/assistant-example.qdoc @@ -26,21 +26,25 @@ ****************************************************************************/ /*! - \group examples-qtassistant.html + \group examples-qtassistant \ingroup all-examples \title Qt Assistant Examples - \brief Adding interactive help to your Qt application. + \brief Using Qt Assistant as a help viewer for Qt applications. - \image assistant-examples.png HelpSystem + \image assistant-examples.png - Support for interactive help is provided by the Qt Assistant application. - Developers can take advantages of the facilities it offers to display - specially-prepared documentation to users of their applications. + Qt Assistant provides support for interactive help and enables you to + display customer documentation to users of your Qt applications. + The following examples illustrate how to use Qt Assistant as a help viewer + for applications. + +*/ + +/* \list \li \l{simpletextviewer}{Simple Text Viewer}\raisedaster - \li \l{help/remotecontrol}{Remote Control} - \li \l{help/contextsensitivehelp}{Context-Sensitive Help} + \li \l{remotecontrol}{Remote Control} \endlist Examples marked with an asterisk (*) are fully documented. diff --git a/src/assistant/help/doc/qthelp.qdocconf b/src/assistant/help/doc/qthelp.qdocconf index c8cd0c9e1134d248c3fed6ff12a5450afa46ddaa..2ac84c1378dc6b676d3b9c171417f0b939fab188 100644 --- a/src/assistant/help/doc/qthelp.qdocconf +++ b/src/assistant/help/doc/qthelp.qdocconf @@ -32,7 +32,7 @@ headerdirs += .. sourcedirs = .. -exampledirs = ../../../../../examples/help \ +exampledirs = ../../../../examples/help \ snippets imagedirs = images diff --git a/src/assistant/help/doc/src/qthelp-examples.qdoc b/src/assistant/help/doc/src/qthelp-examples.qdoc new file mode 100644 index 0000000000000000000000000000000000000000..d6f441e3ae0076b48c9c83a76bf85e2db0b41ec4 --- /dev/null +++ b/src/assistant/help/doc/src/qthelp-examples.qdoc @@ -0,0 +1,47 @@ +/**************************************************************************** +** +** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/contact-us. +** +** GNU Free Documentation License Usage +** 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. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \group examples-qthelp + \ingroup all-examples + \title Qt Help Examples + \brief Adding context-sensitive help to Qt applications. + + The Qt help system includes tools for generating and viewing Qt help files. + In addition, it provides classes for accessing help contents programatically + to be able to integrate online help into Qt applications. + + The following example illustrates how to add context-sensitive help to + applications. + +*/ + +/* + \list + \li \l{contextsensitivehelp}{Context-Sensitive Help} + \endlist +*/ diff --git a/src/designer/src/designer/doc/src/designer-examples.qdoc b/src/designer/src/designer/doc/src/designer-examples.qdoc index 0b649b025a1c29c99a6edb608e2cb3cb5de8a455..1dce46e1e1c4a4360d7e69d610b550bb9f0fca47 100644 --- a/src/designer/src/designer/doc/src/designer-examples.qdoc +++ b/src/designer/src/designer/doc/src/designer-examples.qdoc @@ -26,7 +26,7 @@ ****************************************************************************/ /*! - \group examples-designer.html + \group examples-designer \ingroup all-examples \title Qt Designer Examples \brief Using Qt Designer to build your UI. @@ -35,6 +35,11 @@ create and configure forms without writing code. GUIs created with Qt Designer can be compiled into an application or created at run-time. + The following examples illustrate how to create and use Qt Designer forms + and how to create Qt Designer custom widget plugins. +*/ + +/* \list \li \l{arthurplugin}{Arthur Plugin} \li \l{calculatorbuilder}{Calculator Builder}\raisedaster diff --git a/src/designer/src/uitools/doc/src/qtuitools-examples.qdoc b/src/designer/src/uitools/doc/src/qtuitools-examples.qdoc index 1500064c0d81e63d32a580188d95c67ac3a13a85..45044d6bbc9744a9575f3a41445ad99a8cf56083 100644 --- a/src/designer/src/uitools/doc/src/qtuitools-examples.qdoc +++ b/src/designer/src/uitools/doc/src/qtuitools-examples.qdoc @@ -26,18 +26,25 @@ ****************************************************************************/ /*! - \group examples-qtuitools.html + \group examples-qtuitools \ingroup all-examples \title Qt UI Tools Examples \brief Using Qt UI Tools to process UI forms. \image uitools-examples.png UiTools + The \l{Qt UI Tools} module provides classes to handle UI forms created with + Qt Designer. The forms are processed at run-time to dynamically generate + user interfaces. + + The following examples illustrate how to use Qt UI Tools to process UI + forms. +*/ + +/* \list \li \l{Multiple Inheritance Example}\raisedaster \li \l{Text Finder Example}\raisedaster - \li \l{Calculator Builder Example}\raisedaster - \li \l{World Time Clock Builder Example}\raisedaster \endlist Examples marked with an asterisk (*) are fully documented.