doc/src/examples/eventtransitions.qdoc

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2015 The Qt Company Ltd.
   4 ** Contact: http://www.qt.io/licensing/
   5 **
   6 ** This file is part of the documentation of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:FDL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and The Qt Company. For licensing terms
  14 ** and conditions see http://www.qt.io/terms-conditions. For further
  15 ** information use the contact form at http://www.qt.io/contact-us.
  16 **
  17 ** GNU Free Documentation License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Free
  19 ** Documentation License version 1.3 as published by the Free Software
  20 ** Foundation and appearing in the file included in the packaging of
  21 ** this file.  Please review the following information to ensure
  22 ** the GNU Free Documentation License version 1.3 requirements
  23 ** will be met: http://www.gnu.org/copyleft/fdl.html.
  24 ** $QT_END_LICENSE$
  25 **
  26 ****************************************************************************/
  27
  28 /*!
  29     \example statemachine/eventtransitions
  30     \title Event Transitions Example
  31
  32     \brief The Event Transitions example shows how to use event transitions, a
  33     feature of \l{The State Machine Framework}.
  34
  35     \snippet examples/statemachine/eventtransitions/main.cpp 0
  36
  37     The \c Window class's constructors begins by creating a button.
  38
  39     \snippet examples/statemachine/eventtransitions/main.cpp 1
  40
  41     Two states, \c s1 and \c s2, are created; upon entry they will assign
  42     "Outside" and "Inside" to the button's text, respectively.
  43
  44     \snippet examples/statemachine/eventtransitions/main.cpp 2
  45
  46     When the button receives an event of type QEvent::Enter and the state
  47     machine is in state \c s1, the machine will transition to state \c s2.
  48
  49     \snippet examples/statemachine/eventtransitions/main.cpp 3
  50
  51     When the button receives an event of type QEvent::Leave and the state
  52     machine is in state \c s2, the machine will transition back to state \c
  53     s1.
  54
  55     \snippet examples/statemachine/eventtransitions/main.cpp 4
  56
  57     Next, the state \c s3 is created. \c s3 will be entered when the button
  58     receives an event of type QEvent::MouseButtonPress and the state machine
  59     is in state \c s2. When the button receives an event of type
  60     QEvent::MouseButtonRelease and the state machine is in state \c s3, the
  61     machine will transition back to state \c s2.
  62
  63     \snippet examples/statemachine/eventtransitions/main.cpp 5
  64
  65     Finally, the states are added to the machine as top-level states, the
  66     initial state is set to be \c s1 ("Outside"), and the machine is started.
  67
  68     \snippet examples/statemachine/eventtransitions/main.cpp 6
  69
  70     The main() function constructs a Window object and shows it.
  71
  72 */