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 statemachine/twowaybutton

    44     \title Two-way Button Example

    45 

    46     The Two-way button example shows how to use \l{The State Machine

    47     Framework} to implement a simple state machine that toggles the current

    48     state when a button is clicked.

    49 

    50     \snippet examples/statemachine/twowaybutton/main.cpp 0

    51 

    52     The application's main() function begins by constructing the application

    53     object, a button and a state machine.

    54 

    55     \snippet examples/statemachine/twowaybutton/main.cpp 1

    56 

    57     The state machine has two states; \c on and \c off. When either state is

    58     entered, the text of the button will be set accordingly.

    59 

    60     \snippet examples/statemachine/twowaybutton/main.cpp 2

    61 

    62     When the state machine is in the \c off state and the button is clicked,

    63     it will transition to the \c on state; when the state machine is in the \c

    64     on state and the button is clicked, it will transition to the \c off

    65     state.

    66 

    67     \snippet examples/statemachine/twowaybutton/main.cpp 3

    68 

    69     The states are added to the state machine; they become top-level (sibling)

    70     states.

    71 

    72     \snippet examples/statemachine/twowaybutton/main.cpp 4

    73 

    74     The initial state is \c off; this is the state the state machine will

    75     immediately transition to once the state machine is started.

    76 

    77     \snippet examples/statemachine/twowaybutton/main.cpp 5

    78 

    79     Finally, the button is resized and made visible, and the application event

    80     loop is entered.

    81 

    82 */