summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Faure <faure@kde.org>2012-07-24 09:55:09 +0200
committerQt by Nokia <qt-info@nokia.com>2012-07-24 12:45:02 +0200
commit95232af3effab1f722c31e136c59fdd4ae3967b1 (patch)
treeb553c9e5e36ad76f93fe3a0850782d319fa1da8a
parent1a470256e1e35fb48e4b984f01a1f2db340cd588 (diff)
QAbstractNativeEventFilter: document return value
(paragraph taken "as is" from the QObject::eventFilter documentation) Change-Id: I1b7e92736103042d7105f1b26ba4784cbcc43dc2 Reviewed-by: Thomas McGuire <thomas.mcguire@kdab.com> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@nokia.com> Reviewed-by: Stephen Kelly <stephen.kelly@kdab.com>
-rw-r--r--src/corelib/kernel/qabstractnativeeventfilter.cpp4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/corelib/kernel/qabstractnativeeventfilter.cpp b/src/corelib/kernel/qabstractnativeeventfilter.cpp
index eceeb06297..62648440ce 100644
--- a/src/corelib/kernel/qabstractnativeeventfilter.cpp
+++ b/src/corelib/kernel/qabstractnativeeventfilter.cpp
@@ -101,6 +101,10 @@ QAbstractNativeEventFilter::~QAbstractNativeEventFilter()
On Blackberry (not plain QNX) \a eventType is set to "bps_event_t", and the \a message can be casted
to a bps_event_t pointer.
+ In your reimplementation of this function, if you want to filter
+ the \a message out, i.e. stop it being handled further, return
+ true; otherwise return false.
+
Example:
\snippet code/src_corelib_kernel_qabstractnativeeventfilter.cpp 0
*/