qabstractnativeeventfilter.cpp

Jenkins

Absolute File Name:

/home/qt/qt5_coco/qt5/qtbase/src/corelib/kernel/qabstractnativeeventfilter.cpp

Line

Source

Count

/****************************************************************************

** Contact: https://www.qt.io/licensing/

** This file is part of the QtCore module of the Qt Toolkit.

** $QT_BEGIN_LICENSE:LGPL$

** Commercial License Usage

** Licensees holding valid commercial Qt licenses may use this file in

** accordance with the commercial license agreement provided with the

** Software or, alternatively, in accordance with the terms contained in

** a written agreement between you and The Qt Company. For licensing terms

** and conditions see https://www.qt.io/terms-conditions. For further

** information use the contact form at https://www.qt.io/contact-us.

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 3 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL3 included in the

** packaging of this file. Please review the following information to

** ensure the GNU Lesser General Public License version 3 requirements

** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.

** GNU General Public License Usage

** Alternatively, this file may be used under the terms of the GNU

** General Public License version 2.0 or (at your option) the GNU General

** Public license version 3 or any later version approved by the KDE Free

** Qt Foundation. The licenses are as published by the Free Software

** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3

** included in the packaging of this file. Please review the following

** information to ensure the GNU General Public License requirements will

** be met: https://www.gnu.org/licenses/gpl-2.0.html and

** https://www.gnu.org/licenses/gpl-3.0.html.

** $QT_END_LICENSE$

****************************************************************************/

#include "qabstractnativeeventfilter.h"

#include "qabstracteventdispatcher.h"

QT_BEGIN_NAMESPACE

/*!

\class QAbstractNativeEventFilter

\inmodule QtCore

\since 5.0

\brief The QAbstractNativeEventFilter class provides an interface for receiving native

events, such as MSG or XCB event structs.

/*!

Creates a native event filter.

By default this doesn't do anything. Remember to install it on the application

object.

QAbstractNativeEventFilter::QAbstractNativeEventFilter()

{

Q_UNUSED(d);

}

executed 74 times by 2 tests: end of block

Executed by:

tst_QWidget
tst_selftests - unknown status

/*!

Destroys the native event filter.

This automatically removes it from the application.

QAbstractNativeEventFilter::~QAbstractNativeEventFilter()

{

QAbstractEventDispatcher *eventDispatcher = QAbstractEventDispatcher::instance();

if (eventDispatcher)

eventDispatcher	Description
TRUE	evaluated 74 times by 2 tests Evaluated by: tst_QWidget tst_selftests - unknown status
FALSE	never evaluated

0-74

eventDispatcher->removeNativeEventFilter(this);

executed 74 times by 2 tests: eventDispatcher->removeNativeEventFilter(this);

Executed by:

tst_QWidget
tst_selftests - unknown status

}

executed 74 times by 2 tests: end of block

Executed by:

tst_QWidget
tst_selftests - unknown status

/*!

\fn bool QAbstractNativeEventFilter::nativeEventFilter(const QByteArray &eventType, void *message, long *result)

This method is called for every native event.

\note The filter function here receives native messages,

for example, MSG or XCB event structs.

It is called by the QPA platform plugin. On Windows, it is called by

the event dispatcher.

The type of event \a eventType is specific to the platform plugin chosen at run-time,

and can be used to cast \a message to the right type.

On X11, \a eventType is set to "xcb_generic_event_t", and the \a message can be casted

to a xcb_generic_event_t pointer.

On Windows, \a eventType is set to "windows_generic_MSG" for messages sent to toplevel windows,

and "windows_dispatcher_MSG" for system-wide messages such as messages from a registered hot key.

In both cases, the \a message can be casted to a MSG pointer.

The \a result pointer is only used on Windows, and corresponds to the LRESULT pointer.

On macOS, \a eventType is set to "mac_generic_NSEvent", and the \a message can be casted to an NSEvent pointer.

100

101

In your reimplementation of this function, if you want to filter

102

the \a message out, i.e. stop it being handled further, return

103

true; otherwise return false.

104

105

\b {Linux example}

106

\snippet code/src_corelib_kernel_qabstractnativeeventfilter.cpp 0

\b {macOS example}

mycocoaeventfilter.h:

111

\snippet code/src_corelib_kernel_qabstractnativeeventfilter.h 0

112

113

mycocoaeventfilter.mm:

114

\snippet code/src_corelib_kernel_qabstractnativeeventfilter.mm 0

115

116

myapp.pro:

117

\snippet code/src_corelib_kernel_qabstractnativeeventfilter.pro 0

118

119

120

QT_END_NAMESPACE

Generated by Squish Coco Non-Commercial 4.3.0-BETA-master-30-08-2018-4cb69e9