summaryrefslogtreecommitdiffstats
path: root/src/corelib/statemachine
diff options
context:
space:
mode:
authorGeir Vattekar <geir.vattekar@trolltech.com>2009-07-17 11:44:44 (GMT)
committerGeir Vattekar <geir.vattekar@trolltech.com>2009-07-17 11:47:47 (GMT)
commit05ae1e2cf1c1d95377b302a6b4599358107c63b1 (patch)
tree66aa04e4ab7cf82c54567d5b4dcc12ec79bce480 /src/corelib/statemachine
parent1aa43fc4af995374c577a951fd2054d696aa3b14 (diff)
downloadQt-05ae1e2cf1c1d95377b302a6b4599358107c63b1.zip
Qt-05ae1e2cf1c1d95377b302a6b4599358107c63b1.tar.gz
Qt-05ae1e2cf1c1d95377b302a6b4599358107c63b1.tar.bz2
Doc: Added info on QWrappedEvent to QAbstractTransition::eventTest()
Reviewed-by: Kent Hansen
Diffstat (limited to 'src/corelib/statemachine')
-rw-r--r--src/corelib/statemachine/qabstracttransition.cpp12
1 files changed, 12 insertions, 0 deletions
diff --git a/src/corelib/statemachine/qabstracttransition.cpp b/src/corelib/statemachine/qabstracttransition.cpp
index 670aa7d..c040c58 100644
--- a/src/corelib/statemachine/qabstracttransition.cpp
+++ b/src/corelib/statemachine/qabstracttransition.cpp
@@ -330,6 +330,18 @@ QList<QAbstractAnimation*> QAbstractTransition::animations() const
This function is called to determine whether the given \a event should cause
this transition to trigger. Reimplement this function and return true if the
event should trigger the transition, otherwise return false.
+
+
+ Note that \a event is a QWrappedEvent, which contains a clone of
+ the event generated by Qt. For instance, if you want to check a
+ key press event, do the following:
+
+ \snippet doc/src/snippets/statemachine/eventtest.cpp 0
+
+ You need to check if \a event is a QWrappedEvent because Qt also
+ uses other events for internal reasons; you don't need to concern
+ yourself with these in any case.
+
*/
/*!