1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).

     4 ** All rights reserved.

     5 ** Contact: Nokia Corporation (qt-info@nokia.com)

     6 **

     7 ** This file is part of the documentation of the Qt Toolkit.

     8 **

     9 ** $QT_BEGIN_LICENSE:LGPL$

    10 ** No Commercial Usage

    11 ** This file contains pre-release code and may not be distributed.

    12 ** You may use this file in accordance with the terms and conditions

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    15 **

    16 ** GNU Lesser General Public License Usage

    17 ** Alternatively, this file may be used under the terms of the GNU Lesser

    18 ** General Public License version 2.1 as published by the Free Software

    19 ** Foundation and appearing in the file LICENSE.LGPL included in the

    20 ** packaging of this file.  Please review the following information to

    21 ** ensure the GNU Lesser General Public License version 2.1 requirements

    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

    23 **

    24 ** In addition, as a special exception, Nokia gives you certain additional

    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception

    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

    27 **

    28 ** If you have questions regarding the use of this file, please contact

    29 ** Nokia at qt-info@nokia.com.

    30 **

    31 **

    32 **

    33 **

    34 **

    35 **

    36 **

    37 **

    38 ** $QT_END_LICENSE$

    39 **

    40 ****************************************************************************/

    41 

    42 /*!

    43     \example dialogs/trivialwizard

    44     \title Trivial Wizard Example

    45 

    46     The Trivial Wizard example illustrates how to create a linear three-page

    47     registration wizard using three instances of QWizardPage and one instance

    48     of QWizard.

    49 

    50     \image trivialwizard-example-flow.png

    51 

    52     \section1 Introduction Page

    53 

    54     \image trivialwizard-example-introduction.png

    55 

    56     The introduction page is created with the \c createIntroPage()

    57     function where a QWizardPage is created and its title is set to

    58     "Introduction". A QLabel is used to hold the description of \c page.

    59     A QVBoxLayout is used to hold the \c label. This \c page is returned

    60     when the \c createIntroPage() function is called.

    61 

    62     \snippet examples/dialogs/trivialwizard/trivialwizard.cpp 0

    63 

    64     \section1 Registration Page

    65 

    66     \image trivialwizard-example-registration.png

    67 

    68     The registration page is created with the \c createRegistrationPage()

    69     function. QLineEdit objects are used to allow the user to input a name

    70     and an e-mail address. A QGridLayout is used to hold the QLabel and

    71     QLineEdit objects.

    72 

    73     \snippet examples/dialogs/trivialwizard/trivialwizard.cpp 2

    74 

    75     \section1 Conclusion Page

    76 

    77     \image trivialwizard-example-conclusion.png

    78 

    79     The conclusion page is created in the \c createConclusionPage()

    80     function. This function's content is similar to \c createIntroPage(). A

    81     QLabel is used to inform the user that the registration process has

    82     completed successfully.

    83 

    84     \snippet examples/dialogs/trivialwizard/trivialwizard.cpp 6

    85 

    86     \section1 \c main() Function

    87 

    88     The \c main() function instantiates a QWizard object, \c wizard, and

    89     adds all three QWizardPage objects to it. The \c wizard window title is

    90     set to "Trivial Wizard" and its \c show() function is invoked to display

    91     it.

    92 

    93     \snippet examples/dialogs/trivialwizard/trivialwizard.cpp 10

    94 

    95     \sa QWizard, {Class Wizard Example}, {License Wizard Example}

    96 */