diff options
author | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2012-12-10 17:05:31 +0100 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2012-12-10 19:19:23 +0100 |
commit | f46226f6aa2b97cf402bebbec1cbac49fb7c4095 (patch) | |
tree | fc4f00bd66498414ba69f04ac88c08c466169904 | |
parent | 70d40bf7bdb32f548136b0ce5659aa87e0e15d22 (diff) |
Doc: Modularize Qt UI Tools documentation
Move the Qt UI Tools examples and example docs to qttools.
Create index, module, and example pages and a qdocconf file.
Fix links to module documentation (index page). Fix links to
snippets and examples. Add the command to build docs to the
project file.
Change-Id: I156dbf0a071137e1e6f3ba99cc390aa88c80b836
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
16 files changed, 624 insertions, 5 deletions
diff --git a/src/designer/src/designer/doc/src/designer-custom-widgets.qdoc b/src/designer/src/designer/doc/src/designer-custom-widgets.qdoc index d319e575a..72cd06a13 100644 --- a/src/designer/src/designer/doc/src/designer-custom-widgets.qdoc +++ b/src/designer/src/designer/doc/src/designer-custom-widgets.qdoc @@ -127,5 +127,5 @@ For a complete example using QUiLoader, see the \l {calculatorbuilder}{Calculator Builder example}. - \sa {Qt Designer Manual}, {QtUiTools Module} + \sa {Qt Designer Manual}, {Qt UI Tools} */ diff --git a/src/designer/src/uitools/doc/qtuitools.qdocconf b/src/designer/src/uitools/doc/qtuitools.qdocconf new file mode 100644 index 000000000..f2b544e09 --- /dev/null +++ b/src/designer/src/uitools/doc/qtuitools.qdocconf @@ -0,0 +1,40 @@ +include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) + +project = QtUiTools +description = Qt UI Tools Reference Documentation +url = http://qt-project.org/doc/qtuitools +version = 5.0.0 + +examplesinstallpath = uitools + +qhp.projects = QtUiTools + +qhp.QtUiTools.file = qtuitools.qhp +qhp.QtUiTools.namespace = org.qt-project.qtuitools.500 +qhp.QtUiTools.virtualFolder = qtuitools +qhp.QtUiTools.indexTitle = Qt UI Tools +qhp.QtHelp.indexRoot = + +qhp.QtUiTools.filterAttributes = qtuitools 5.0.0 tools designer qtrefdoc +qhp.QtUiTools.customFilters.QtUiTools.name = QtUiTools 5.0.0 +qhp.QtUiTools.customFilters.QtUiTools.filterAttributes = qtuitools 5.0.0 +qhp.QtUiTools.subprojects = classes +qhp.QtUiTools.subprojects.classes.title = C++ Classes +qhp.QtUiTools.subprojects.classes.indexTitle = Qt Help C++ Classes +qhp.QtUiTools.subprojects.classes.selectors = class fake:headerfile +qhp.QtUiTools.subprojects.classes.sortPages = true + +language = Cpp + +headerdirs += .. + +sourcedirs = .. + +exampledirs = ../../../../../examples/uitools \ + snippets + +imagedirs = images + +outputdir = $QT_INSTALL_DOCS/qtuitools + +depends += qtdoc qtbase qtdesigner qtcore qtwidgets diff --git a/src/designer/src/uitools/doc/snippets/quiloader/doc_src_qtuiloader.cpp b/src/designer/src/uitools/doc/snippets/quiloader/doc_src_qtuiloader.cpp new file mode 100644 index 000000000..208ff7f0a --- /dev/null +++ b/src/designer/src/uitools/doc/snippets/quiloader/doc_src_qtuiloader.cpp @@ -0,0 +1,43 @@ +/**************************************************************************** +** +** 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:BSD$ +** You may use this file under the terms of the BSD license as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names +** of its contributors may be used to endorse or promote products derived +** from this software without specific prior written permission. +** +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +//! [1] +#include <QtUiTools> +//! [1] diff --git a/src/designer/src/uitools/doc/snippets/quiloader/doc_src_qtuiloader.pro b/src/designer/src/uitools/doc/snippets/quiloader/doc_src_qtuiloader.pro new file mode 100644 index 000000000..c99db38db --- /dev/null +++ b/src/designer/src/uitools/doc/snippets/quiloader/doc_src_qtuiloader.pro @@ -0,0 +1,43 @@ +/**************************************************************************** +** +** 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:BSD$ +** You may use this file under the terms of the BSD license as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names +** of its contributors may be used to endorse or promote products derived +** from this software without specific prior written permission. +** +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#! [0] +QT += uitools +#! [0] diff --git a/src/designer/src/uitools/doc/snippets/quiloader/main.cpp b/src/designer/src/uitools/doc/snippets/quiloader/main.cpp new file mode 100644 index 000000000..fee999940 --- /dev/null +++ b/src/designer/src/uitools/doc/snippets/quiloader/main.cpp @@ -0,0 +1,70 @@ +/**************************************************************************** +** +** 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:BSD$ +** You may use this file under the terms of the BSD license as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names +** of its contributors may be used to endorse or promote products derived +** from this software without specific prior written permission. +** +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include <QtGui> +#include <QtUiTools> + +#include "mywidget.h" + +//! [0] +QWidget *loadCustomWidget(QWidget *parent) +{ + QUiLoader loader; + QWidget *myWidget; + + QStringList availableWidgets = loader.availableWidgets(); + + if (availableWidgets.contains("AnalogClock")) + myWidget = loader.createWidget("AnalogClock", parent); + + return myWidget; +} +//! [0] + +int main(int argc, char *argv[]) +{ + QApplication app(argc, argv); + MyWidget widget; + widget.show(); + + QWidget *customWidget = loadCustomWidget(0); + customWidget->show(); + return app.exec(); +} diff --git a/src/designer/src/uitools/doc/snippets/quiloader/myform.ui b/src/designer/src/uitools/doc/snippets/quiloader/myform.ui new file mode 100644 index 000000000..00702e860 --- /dev/null +++ b/src/designer/src/uitools/doc/snippets/quiloader/myform.ui @@ -0,0 +1,130 @@ +<ui version="4.0" > + <author></author> + <comment></comment> + <exportmacro></exportmacro> + <class>Form</class> + <widget class="QWidget" name="Form" > + <property name="geometry" > + <rect> + <x>0</x> + <y>0</y> + <width>258</width> + <height>224</height> + </rect> + </property> + <property name="windowTitle" > + <string>Export Document</string> + </property> + <layout class="QVBoxLayout" > + <property name="margin" > + <number>8</number> + </property> + <property name="spacing" > + <number>6</number> + </property> + <item> + <widget class="QGroupBox" name="groupBox" > + <property name="title" > + <string>Export Options</string> + </property> + <layout class="QGridLayout" > + <property name="margin" > + <number>8</number> + </property> + <property name="spacing" > + <number>6</number> + </property> + <item row="1" column="0" > + <widget class="QRadioButton" name="radioButton_2" > + <property name="text" > + <string>&DocBook</string> + </property> + </widget> + </item> + <item row="0" column="0" > + <widget class="QRadioButton" name="radioButton" > + <property name="text" > + <string>&LaTeX</string> + </property> + <property name="checked" > + <bool>true</bool> + </property> + </widget> + </item> + <item row="1" column="1" > + <widget class="QCheckBox" name="checkBox_2" > + <property name="text" > + <string>Include p&ictures</string> + </property> + <property name="checked" > + <bool>true</bool> + </property> + </widget> + </item> + <item row="5" column="0" > + <spacer> + <property name="orientation" > + <enum>Qt::Vertical</enum> + </property> + <property name="sizeHint" > + <size> + <width>20</width> + <height>40</height> + </size> + </property> + </spacer> + </item> + <item row="0" column="1" > + <widget class="QCheckBox" name="checkBox" > + <property name="text" > + <string>&Compress</string> + </property> + </widget> + </item> + <item row="2" column="0" > + <widget class="QRadioButton" name="radioButton_2_2" > + <property name="text" > + <string>&HTML</string> + </property> + </widget> + </item> + <item row="3" column="0" > + <widget class="QRadioButton" name="radioButton_3" > + <property name="text" > + <string>&PostScript</string> + </property> + </widget> + </item> + <item row="4" column="0" > + <widget class="QRadioButton" name="radioButton_4" > + <property name="text" > + <string>PD&F</string> + </property> + </widget> + </item> + <item row="2" column="1" > + <widget class="QCheckBox" name="checkBox_3" > + <property name="text" > + <string>Include &metadata</string> + </property> + </widget> + </item> + <item row="3" column="1" > + <widget class="QCheckBox" name="checkBox_4" > + <property name="text" > + <string>Create inde&x</string> + </property> + <property name="checked" > + <bool>true</bool> + </property> + </widget> + </item> + </layout> + </widget> + </item> + </layout> + </widget> + <pixmapfunction></pixmapfunction> + <resources/> + <connections/> +</ui> diff --git a/src/designer/src/uitools/doc/snippets/quiloader/mywidget.cpp b/src/designer/src/uitools/doc/snippets/quiloader/mywidget.cpp new file mode 100644 index 000000000..930c735f9 --- /dev/null +++ b/src/designer/src/uitools/doc/snippets/quiloader/mywidget.cpp @@ -0,0 +1,60 @@ +/**************************************************************************** +** +** 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:BSD$ +** You may use this file under the terms of the BSD license as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names +** of its contributors may be used to endorse or promote products derived +** from this software without specific prior written permission. +** +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include <QtGui> +#include <QtUiTools> + +#include "mywidget.h" + +//! [0] +MyWidget::MyWidget(QWidget *parent) + : QWidget(parent) +{ + QUiLoader loader; + QFile file(":/forms/myform.ui"); + file.open(QFile::ReadOnly); + QWidget *myWidget = loader.load(&file, this); + file.close(); + + QVBoxLayout *layout = new QVBoxLayout; + layout->addWidget(myWidget); + setLayout(layout); +} +//! [0] diff --git a/src/designer/src/uitools/doc/snippets/quiloader/mywidget.h b/src/designer/src/uitools/doc/snippets/quiloader/mywidget.h new file mode 100644 index 000000000..b92c6e5a6 --- /dev/null +++ b/src/designer/src/uitools/doc/snippets/quiloader/mywidget.h @@ -0,0 +1,52 @@ +/**************************************************************************** +** +** 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:BSD$ +** You may use this file under the terms of the BSD license as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names +** of its contributors may be used to endorse or promote products derived +** from this software without specific prior written permission. +** +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#ifndef MYWIDGET_H +#define MYWIDGET_H + +#include <QWidget> + +class MyWidget : public QWidget +{ +public: + MyWidget(QWidget *parent = 0); +}; + +#endif diff --git a/src/designer/src/uitools/doc/snippets/quiloader/mywidget.qrc b/src/designer/src/uitools/doc/snippets/quiloader/mywidget.qrc new file mode 100644 index 000000000..47684d68b --- /dev/null +++ b/src/designer/src/uitools/doc/snippets/quiloader/mywidget.qrc @@ -0,0 +1,5 @@ +<!DOCTYPE RCC><RCC version="1.0"> +<qresource prefix="/forms"> +<file>myform.ui</file> +</qresource> +</RCC> diff --git a/src/designer/src/uitools/doc/snippets/quiloader/quiloader.pro b/src/designer/src/uitools/doc/snippets/quiloader/quiloader.pro new file mode 100644 index 000000000..31ddf3256 --- /dev/null +++ b/src/designer/src/uitools/doc/snippets/quiloader/quiloader.pro @@ -0,0 +1,4 @@ +HEADERS = mywidget.h +SOURCES = main.cpp mywidget.cpp +RESOURCES = mywidget.qrc +QT += uitools diff --git a/src/designer/src/uitools/doc/snippets/textfinder/doc_src_examples_textfinder.pro b/src/designer/src/uitools/doc/snippets/textfinder/doc_src_examples_textfinder.pro new file mode 100644 index 000000000..4446e8eb7 --- /dev/null +++ b/src/designer/src/uitools/doc/snippets/textfinder/doc_src_examples_textfinder.pro @@ -0,0 +1,6 @@ +#! [0] +QT += uitools +HEADERS = textfinder.h +RESOURCES = textfinder.qrc +SOURCES = textfinder.cpp main.cpp +#! [0] diff --git a/src/designer/src/uitools/doc/src/qtuitools-examples.qdoc b/src/designer/src/uitools/doc/src/qtuitools-examples.qdoc new file mode 100644 index 000000000..1500064c0 --- /dev/null +++ b/src/designer/src/uitools/doc/src/qtuitools-examples.qdoc @@ -0,0 +1,44 @@ +/**************************************************************************** +** +** 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-qtuitools.html + \ingroup all-examples + \title Qt UI Tools Examples + \brief Using Qt UI Tools to process UI forms. + + \image uitools-examples.png UiTools + + \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. +*/ diff --git a/src/designer/src/uitools/doc/src/qtuitools-index.qdoc b/src/designer/src/uitools/doc/src/qtuitools-index.qdoc new file mode 100644 index 000000000..83966e554 --- /dev/null +++ b/src/designer/src/uitools/doc/src/qtuitools-index.qdoc @@ -0,0 +1,62 @@ +/**************************************************************************** +** +** 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$ +** +****************************************************************************/ + +/*! + \page qtuiools-index.html + \title Qt UI Tools + + \brief Provides classes to handle forms created with Qt Designer. + + \section1 Getting Started + + Qt Designer forms are processed at run-time to produce dynamically-generated + user interfaces. In order to generate a form at run-time, a resource + file containing a UI file is needed. Applications that use the + form handling classes need to be configured to be built against the + Qt UI Tools module. This is done by including the following declaration + in a \c qmake project file to ensure that the application is compiled + and linked appropriately. + + \snippet quiloader/doc_src_qtuiloader.pro 0 + + A form loader object, provided by the QUiLoader class, is used to construct + the user interface. This user interface can be retrieved from any QIODevice. + For example, a QFile object can be used to obtain a form stored in a + project's resources. The QUiLoader::load() function takes the user interface + description contained in the file and constructs the form widget. + + To include the definitions of the module's classes, use the following + directive: + + \snippet quiloader/doc_src_qtuiloader.cpp 1 + + \section1 API Reference + These are links to the API reference materials. + \list + \li \l{Qt UI Tools C++ Classes}{C++ Classes} + \endlist +*/ diff --git a/src/designer/src/uitools/doc/src/qtuitools-module.qdoc b/src/designer/src/uitools/doc/src/qtuitools-module.qdoc new file mode 100644 index 000000000..15914c314 --- /dev/null +++ b/src/designer/src/uitools/doc/src/qtuitools-module.qdoc @@ -0,0 +1,58 @@ +/**************************************************************************** +** +** 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$ +** +****************************************************************************/ + +/*! + \module QtUiTools + \title Qt UI Tools C++ Classes + \since 4.1 + \ingroup modules + + \brief Provides classes to handle forms created with Qt Designer. + + These forms are processed at run-time to produce dynamically-generated + user interfaces. In order to generate a form at run-time, a resource + file containing a UI file is needed. Applications that use the + form handling classes need to be configured to be built against the + QtUiTools module. This is done by including the following declaration + in a \c qmake project file to ensure that the application is compiled + and linked appropriately. + + \snippet quiloader/doc_src_qtuiloader.pro 0 + + A form loader object, provided by the QUiLoader class, is used to + construct the user interface. This user interface can + be retrieved from any QIODevice; for example, a QFile object can be + used to obtain a form stored in a project's resources. The + QUiLoader::load() function takes the user interface description + contained in the file and constructs the form widget. + + To include the definitions of the module's classes, use the following + directive: + + \snippet quiloader/doc_src_qtuiloader.cpp 1 + +*/ diff --git a/src/designer/src/uitools/quiloader.cpp b/src/designer/src/uitools/quiloader.cpp index 6db458e7c..2a07afe22 100644 --- a/src/designer/src/uitools/quiloader.cpp +++ b/src/designer/src/uitools/quiloader.cpp @@ -583,18 +583,18 @@ void QUiLoaderPrivate::setupWidgetMap() const contents of a UI file can be retrieved using the load() function. For example: - \snippet doc/src/snippets/quiloader/mywidget.cpp 0 + \snippet quiloader/mywidget.cpp 0 By including the user interface in the form's resources (\c myform.qrc), we ensure that it will be present at run-time: - \quotefile doc/src/snippets/quiloader/mywidget.qrc + \quotefile quiloader/mywidget.qrc The availableWidgets() function returns a QStringList with the class names of the widgets available in the specified plugin paths. To create these widgets, simply use the createWidget() function. For example: - \snippet doc/src/snippets/quiloader/main.cpp 0 + \snippet quiloader/main.cpp 0 To make a custom widget available to the loader, you can use the addPluginPath() function; to remove all available widgets, you can call @@ -611,7 +611,7 @@ void QUiLoaderPrivate::setupWidgetMap() const For a complete example using the QUiLoader class, see the \l{Calculator Builder Example}. - \sa QtUiTools, QFormBuilder + \sa {Qt UI Tools}, QFormBuilder */ /*! diff --git a/src/designer/src/uitools/uitools.pro b/src/designer/src/uitools/uitools.pro index 69d6393db..e526aa54a 100644 --- a/src/designer/src/uitools/uitools.pro +++ b/src/designer/src/uitools/uitools.pro @@ -2,6 +2,8 @@ TARGET = QtUiTools CONFIG += static QT = core +QMAKE_DOCS = $$PWD/doc/qtuitools.qdocconf + load(qt_module) HEADERS += quiloader.h |