summaryrefslogtreecommitdiffstats
path: root/src/corelib/statemachine/qeventtransition.cpp
blob: 65f00752e0a55a5e27c911aec161e4a2e557d556 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** Contact: Qt Software Information (qt-info@nokia.com)
**
** This file is part of the $MODULE$ of the Qt Toolkit.
**
** $TROLLTECH_DUAL_LICENSE$
**
****************************************************************************/

#include "qeventtransition.h"
#include "qeventtransition_p.h"
#include "qboundevent_p.h"
#include "qstate.h"
#include "qstate_p.h"
#include "qstatemachine.h"
#include "qstatemachine_p.h"
#include <qdebug.h>

QT_BEGIN_NAMESPACE

/*!
  \class QEventTransition

  \brief The QEventTransition class provides a QObject-specific transition for Qt events.

  \ingroup statemachine

  A QEventTransition object binds an event or transition to a particular
  QObject.  QEventTransition is part of \l{The State Machine Framework}.

  Example:

  \code
  QPushButton *button = ...;
  QState *s1 = ...;
  QState *s2 = ...;
  // If in s1 and the button receives an Enter event, transition to s2
  QEventTransition *enterTransition = new QEventTransition(button, QEvent::Enter);
  enterTransition->setTargetState(s2);
  s1->addTransition(enterTransition);
  // If in s2 and the button receives an Exit event, transition back to s1
  QEventTransition *leaveTransition = new QEventTransition(button, QEvent::Leave);
  leaveTransition->setTargetState(s1);
  s2->addTransition(leaveTransition);
  \endcode

  \section1 Subclassing

  Many event classes have attributes in addition to the event type itself.
  The testEventCondition() function can be reimplemented to check attributes
  of an event instance in order to determine whether the transition should be
  triggered or not.

  \sa QState::addTransition()
*/

/*!
    \property QEventTransition::object

    \brief the event source that this event transition is associated with
*/

QEventTransitionPrivate::QEventTransitionPrivate()
{
    object = 0;
    eventType = QEvent::None;
    registered = false;
}

QEventTransitionPrivate *QEventTransitionPrivate::get(QEventTransition *q)
{
    return q->d_func();
}

void QEventTransitionPrivate::invalidate()
{
    Q_Q(QEventTransition);
    if (registered) {
        QState *source = sourceState();
        QStatePrivate *source_d = QStatePrivate::get(source);
        QStateMachinePrivate *mach = QStateMachinePrivate::get(source_d->machine());
        if (mach) {
            mach->unregisterEventTransition(q);
            if (mach->configuration.contains(source))
                mach->registerEventTransition(q);
        }
    }
}

/*!
  Constructs a new QEventTransition object with the given \a sourceState.
*/
QEventTransition::QEventTransition(QState *sourceState)
    : QTransition(*new QEventTransitionPrivate, sourceState)
{
}

/*!
  Constructs a new QEventTransition object associated with events of the given
  \a type for the given \a object, and with the given \a sourceState.
*/
QEventTransition::QEventTransition(QObject *object, QEvent::Type type,
                                   QState *sourceState)
    : QTransition(*new QEventTransitionPrivate, sourceState)
{
    Q_D(QEventTransition);
    d->registered = false;
    d->object = object;
    d->eventType = type;
}

/*!
  Constructs a new QEventTransition object associated with events of the given
  \a type for the given \a object. The transition has the given \a targets and
  \a sourceState.
*/
QEventTransition::QEventTransition(QObject *object, QEvent::Type type,
                                   const QList<QAbstractState*> &targets,
                                   QState *sourceState)
    : QTransition(*new QEventTransitionPrivate, targets, sourceState)
{
    Q_D(QEventTransition);
    d->registered = false;
    d->object = object;
    d->eventType = type;
}

/*!
  \internal
*/
QEventTransition::QEventTransition(QEventTransitionPrivate &dd, QState *parent)
    : QTransition(dd, parent)
{
}

/*!
  \internal
*/
QEventTransition::QEventTransition(QEventTransitionPrivate &dd, QObject *object,
                                   QEvent::Type type, QState *parent)
    : QTransition(dd, parent)
{
    Q_D(QEventTransition);
    d->registered = false;
    d->object = object;
    d->eventType = type;
}

/*!
  \internal
*/
QEventTransition::QEventTransition(QEventTransitionPrivate &dd, QObject *object,
                                   QEvent::Type type, const QList<QAbstractState*> &targets,
                                   QState *parent)
    : QTransition(dd, targets, parent)
{
    Q_D(QEventTransition);
    d->registered = false;
    d->object = object;
    d->eventType = type;
}

/*!
  Destroys this QObject event transition.
*/
QEventTransition::~QEventTransition()
{
}

/*!
  Returns the event type that this event transition is associated with.
*/
QEvent::Type QEventTransition::eventType() const
{
    Q_D(const QEventTransition);
    return d->eventType;
}

/*!
  Sets the event \a type that this event transition is associated with.
*/
void QEventTransition::setEventType(QEvent::Type type)
{
    Q_D(QEventTransition);
    if (d->eventType == type)
        return;
    d->eventType = type;
    d->invalidate();
}

/*!
  Returns the event source associated with this event transition.
*/
QObject *QEventTransition::eventSource() const
{
    Q_D(const QEventTransition);
    return d->object;
}

/*!
  Sets the event source associated with this event transition to be the given
  \a object.
*/
void QEventTransition::setEventSource(QObject *object)
{
    Q_D(QEventTransition);
    if (d->object == object)
        return;
    d->object = object;
    d->invalidate();
}

/*!
  \reimp
*/
bool QEventTransition::eventTest(QEvent *event) const
{
    Q_D(const QEventTransition);
#ifdef QT_STATEMACHINE_SOLUTION
    if (event->type() == QEvent::Type(QEvent::User-3)) {
#else
    if (event->type() == QEvent::Bound) {
#endif
        QBoundEvent *oe = static_cast<QBoundEvent*>(event);
        return (oe->object() == d->object)
            && (oe->event()->type() == d->eventType)
            && testEventCondition(oe->event());
    }
    return false;
}

/*!
  Tests an instance of an event associated with this event transition and
  returns true if the transition should be taken, otherwise returns false.
  The type of the given \a event will be eventType().

  Reimplement this function if you have custom conditions associated with
  the transition. The default implementation always returns true.
*/
bool QEventTransition::testEventCondition(QEvent *event) const
{
    Q_UNUSED(event);
    return true;
}

/*!
  \reimp
*/
void QEventTransition::onTransition()
{
}

/*!
  \reimp
*/
bool QEventTransition::event(QEvent *e)
{
    return QTransition::event(e);
}

QT_END_NAMESPACE