| 1 | /**************************************************************************** |
| 2 | ** |
| 3 | ** Copyright (C) 2016 Ford Motor Company |
| 4 | ** Contact: https://www.qt.io/licensing/ |
| 5 | ** |
| 6 | ** This file is part of the QtQml module of the Qt Toolkit. |
| 7 | ** |
| 8 | ** $QT_BEGIN_LICENSE:LGPL$ |
| 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 https://www.qt.io/terms-conditions. For further |
| 15 | ** information use the contact form at https://www.qt.io/contact-us. |
| 16 | ** |
| 17 | ** GNU Lesser General Public License Usage |
| 18 | ** Alternatively, this file may be used under the terms of the GNU Lesser |
| 19 | ** General Public License version 3 as published by the Free Software |
| 20 | ** Foundation and appearing in the file LICENSE.LGPL3 included in the |
| 21 | ** packaging of this file. Please review the following information to |
| 22 | ** ensure the GNU Lesser General Public License version 3 requirements |
| 23 | ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. |
| 24 | ** |
| 25 | ** GNU General Public License Usage |
| 26 | ** Alternatively, this file may be used under the terms of the GNU |
| 27 | ** General Public License version 2.0 or (at your option) the GNU General |
| 28 | ** Public license version 3 or any later version approved by the KDE Free |
| 29 | ** Qt Foundation. The licenses are as published by the Free Software |
| 30 | ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 |
| 31 | ** included in the packaging of this file. Please review the following |
| 32 | ** information to ensure the GNU General Public License requirements will |
| 33 | ** be met: https://www.gnu.org/licenses/gpl-2.0.html and |
| 34 | ** https://www.gnu.org/licenses/gpl-3.0.html. |
| 35 | ** |
| 36 | ** $QT_END_LICENSE$ |
| 37 | ** |
| 38 | ****************************************************************************/ |
| 39 | |
| 40 | #include "timeouttransition.h" |
| 41 | |
| 42 | #include <QQmlInfo> |
| 43 | #include <QTimer> |
| 44 | #include <QState> |
| 45 | |
| 46 | TimeoutTransition::TimeoutTransition(QState* parent) |
| 47 | : QSignalTransition((m_timer = new QTimer), SIGNAL(timeout()), parent) |
| 48 | { |
| 49 | m_timer->setSingleShot(true); |
| 50 | m_timer->setInterval(1000); |
| 51 | } |
| 52 | |
| 53 | TimeoutTransition::~TimeoutTransition() |
| 54 | { |
| 55 | delete m_timer; |
| 56 | } |
| 57 | |
| 58 | int TimeoutTransition::timeout() const |
| 59 | { |
| 60 | return m_timer->interval(); |
| 61 | } |
| 62 | |
| 63 | void TimeoutTransition::setTimeout(int timeout) |
| 64 | { |
| 65 | if (timeout != m_timer->interval()) { |
| 66 | m_timer->setInterval(timeout); |
| 67 | emit timeoutChanged(); |
| 68 | } |
| 69 | } |
| 70 | |
| 71 | void TimeoutTransition::componentComplete() |
| 72 | { |
| 73 | QState *state = qobject_cast<QState*>(object: parent()); |
| 74 | if (!state) { |
| 75 | qmlWarning(me: this) << "Parent needs to be a State" ; |
| 76 | return; |
| 77 | } |
| 78 | |
| 79 | connect(sender: state, SIGNAL(entered()), receiver: m_timer, SLOT(start())); |
| 80 | connect(sender: state, SIGNAL(exited()), receiver: m_timer, SLOT(stop())); |
| 81 | if (state->active()) |
| 82 | m_timer->start(); |
| 83 | } |
| 84 | |
| 85 | /*! |
| 86 | \qmltype TimeoutTransition |
| 87 | \inqmlmodule QtQml.StateMachine |
| 88 | \inherits QSignalTransition |
| 89 | \ingroup statemachine-qmltypes |
| 90 | \since 5.4 |
| 91 | |
| 92 | \brief The TimeoutTransition type provides a transition based on a timer. |
| 93 | |
| 94 | \l{Timer} type can be combined with SignalTransition to enact more complex |
| 95 | timeout based transitions. |
| 96 | |
| 97 | TimeoutTransition is part of \l{The Declarative State Machine Framework}. |
| 98 | |
| 99 | \section1 Example Usage |
| 100 | |
| 101 | \snippet qml/statemachine/timeouttransition.qml document |
| 102 | |
| 103 | \clearfloat |
| 104 | |
| 105 | \sa StateMachine, SignalTransition, FinalState, HistoryState |
| 106 | */ |
| 107 | |
| 108 | /*! |
| 109 | \qmlproperty int TimeoutTransition::timeout |
| 110 | |
| 111 | \brief The timeout interval in milliseconds. |
| 112 | */ |
| 113 | |
| 114 | #include "moc_timeouttransition.cpp" |
| 115 | |