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

     2 **

     3 ** Copyright (C) 2009 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/eventtransitions

    44     \title Event Transitions Example

    45 

    46     The Event Transitions example shows how to use event transitions, a

    47     feature of \l{The State Machine Framework}.

    48 

    49     \snippet examples/statemachine/eventtransitions/main.cpp 0

    50 

    51     The \c Window class's constructors begins by creating a button.

    52 

    53     \snippet examples/statemachine/eventtransitions/main.cpp 1

    54 

    55     Two states, \c s1 and \c s2, are created; upon entry they will assign

    56     "Outside" and "Inside" to the button's text, respectively.

    57 

    58     \snippet examples/statemachine/eventtransitions/main.cpp 2

    59 

    60     When the button receives an event of type QEvent::Enter and the state

    61     machine is in state \c s1, the machine will transition to state \c s2.

    62 

    63     \snippet examples/statemachine/eventtransitions/main.cpp 3

    64 

    65     When the button receives an event of type QEvent::Leave and the state

    66     machine is in state \c s2, the machine will transition back to state \c

    67     s1.

    68 

    69     \snippet examples/statemachine/eventtransitions/main.cpp 4

    70 

    71     Next, the state \c s3 is created. \c s3 will be entered when the button

    72     receives an event of type QEvent::MouseButtonPress and the state machine

    73     is in state \c s2. When the button receives an event of type

    74     QEvent::MouseButtonRelease and the state machine is in state \c s3, the

    75     machine will transition back to state \c s2.

    76 

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

    78 

    79     Finally, the states are added to the machine as top-level states, the

    80     initial state is set to be \c s1 ("Outside"), and the machine is started.

    81 

    82     \snippet examples/statemachine/eventtransitions/main.cpp 6

    83 

    84     The main() function constructs a Window object and shows it.

    85 

    86 */