summaryrefslogtreecommitdiffstats
path: root/doc/src/examples/worldtimeclockbuilder.qdoc
blob: a70cbe70250235baff62a35ab303c0a779302072 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
/****************************************************************************
**
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial Usage
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in a
** written agreement between you and Nokia.
**
** GNU Free Documentation License
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** 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.
*/