doc/src/examples/worldtimeclockbuilder.qdoc
changeset 0 1918ee327afb
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/src/examples/worldtimeclockbuilder.qdoc	Mon Jan 11 14:00:40 2010 +0000
@@ -0,0 +1,111 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE: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 Technology Preview License Agreement accompanying
+** this package.
+**
+** 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.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+  \example designer/worldtimeclockbuilder
+  \title World Time Clock Builder Example
+
+  The World Time Clock Builder example shows how forms created with Qt
+  Designer that contain custom widgets can be dynamically generated at
+  run-time.
+
+  \image worldtimeclockbuilder-example.png
+
+  This example uses a form containing the custom widget plugin described in the
+  \l{designer/worldtimeclockplugin}{World Time Clock Plugin} example, and
+  dynamically generates a user interface using the QUiLoader class, part of
+  the QtUiTools module.
+
+  \section1 Preparation
+
+  As with the \l{designer/calculatorbuilder}{Calculator Builder} example, the
+  project file for this example needs to include the appropriate definitions
+  to ensure that it is built against the required Qt modules.
+
+  \snippet examples/designer/worldtimeclockbuilder/worldtimeclockbuilder.pro 0
+
+  By appending \c form to the \c CONFIG declaration, we instruct \c qmake to
+  generate a dependency on the \c libQtUiTools library containing the QtUiTools
+  classes.
+
+  Note that we do not inform \c qmake about any UI files, and so none will
+  be processed and built into the application. The resource file contains
+  an entry for the particular form that we wish to use:
+
+  \quotefile examples/designer/worldtimeclockbuilder/worldtimeclockbuilder.qrc
+
+  Forms do not need to be included with the application in this way. We only
+  include a form in the application's resources for convenience, and to keep
+  the example short.
+
+  \section1 Loading and Building the Form
+
+  Since this example only loads and displays a pre-prepared form, all of the
+  work can be done in the main() function. We are using a class from the
+  QtUiTools library so, in addition to any other Qt classes that are normally
+  required to write an application, we must include the appropriate header
+  file:
+
+  \snippet examples/designer/worldtimeclockbuilder/main.cpp 0
+
+  The main function initializes the resource system with the Q_INIT_RESOURCE()
+  macro and constructs an QApplication instance in the usual way:
+
+  \snippet examples/designer/worldtimeclockbuilder/main.cpp 1
+
+  We construct a QUiLoader object to handle the form we want to use.
+
+  The form itself is obtained from the resource file system using the path
+  defined in the resource file. We use the form loader to load and construct
+  the form:
+
+  \snippet examples/designer/worldtimeclockbuilder/main.cpp 2
+
+  Once the form has been loaded, the resource file can be closed and the
+  widget is shown.
+
+  \snippet examples/designer/worldtimeclockbuilder/main.cpp 3
+
+  The form loader ensures that all the signal and slot connections between
+  objects in the form are set up correctly when the form is loaded. As a
+  result, the time is updated by the World Time Clock widget, and the time
+  zone spin box can be used to change the position of the hour hand.
+*/