Revision control
Copy as Markdown
// Copyright (C) 2021 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
#ifndef QTESTKEYBOARD_H
#define QTESTKEYBOARD_H
#if 0
// inform syncqt
#pragma qt_no_master_include
#endif
#include <QtTest/qtestassert.h>
#include <QtTest/qttestglobal.h>
#include <QtTest/qtestsystem.h>
#include <QtTest/qtestspontaneevent.h>
#include <QtCore/qpointer.h>
#include <QtGui/qguiapplication.h>
#include <QtGui/qwindow.h>
#include <QtGui/qevent.h>
#if QT_CONFIG(shortcut)
# include <QtGui/qkeysequence.h>
#endif
#ifdef QT_WIDGETS_LIB
#include <QtWidgets/qwidget.h>
#include <QtWidgets/qapplication.h>
#endif
QT_BEGIN_NAMESPACE
Q_GUI_EXPORT void qt_handleKeyEvent(QWindow *w, QEvent::Type t, int k, Qt::KeyboardModifiers mods, const QString & text = QString(), bool autorep = false, ushort count = 1);
Q_GUI_EXPORT bool qt_sendShortcutOverrideEvent(QObject *o, ulong timestamp, int k, Qt::KeyboardModifiers mods, const QString &text = QString(), bool autorep = false, ushort count = 1);
namespace QTest
{
enum KeyAction { Press, Release, Click, Shortcut };
inline void simulateEvent(QWindow *window, bool press, int code,
Qt::KeyboardModifiers modifier, const QString &text,
bool repeat, int delay = -1)
{
QEvent::Type type;
type = press ? QEvent::KeyPress : QEvent::KeyRelease;
qt_handleKeyEvent(window, type, code, modifier, text, repeat, delay);
qApp->processEvents();
}
inline void sendKeyEvent(KeyAction action, QWindow *window, Qt::Key code,
const QString &text, Qt::KeyboardModifiers modifier,
int delay = -1)
{
QTEST_ASSERT(qApp);
if (!window)
window = QGuiApplication::focusWindow();
QTEST_ASSERT(window);
if (action == Click) {
QPointer<QWindow> ptr(window);
sendKeyEvent(Press, window, code, text, modifier, delay);
if (!ptr)
return;
sendKeyEvent(Release, window, code, text, modifier, delay);
return;
}
bool repeat = false;
if (action == Shortcut) {
int timestamp = 0;
qt_sendShortcutOverrideEvent(window, timestamp, code, modifier, text, repeat);
return;
}
if (action == Press) {
if (modifier & Qt::ShiftModifier)
simulateEvent(window, true, Qt::Key_Shift, Qt::KeyboardModifiers(), QString(), false, delay);
if (modifier & Qt::ControlModifier)
simulateEvent(window, true, Qt::Key_Control, modifier & Qt::ShiftModifier, QString(), false, delay);
if (modifier & Qt::AltModifier)
simulateEvent(window, true, Qt::Key_Alt,
modifier & (Qt::ShiftModifier | Qt::ControlModifier), QString(), false, delay);
if (modifier & Qt::MetaModifier)
simulateEvent(window, true, Qt::Key_Meta, modifier & (Qt::ShiftModifier
| Qt::ControlModifier | Qt::AltModifier), QString(), false, delay);
simulateEvent(window, true, code, modifier, text, repeat, delay);
} else if (action == Release) {
simulateEvent(window, false, code, modifier, text, repeat, delay);
if (modifier & Qt::MetaModifier)
simulateEvent(window, false, Qt::Key_Meta, modifier, QString(), false, delay);
if (modifier & Qt::AltModifier)
simulateEvent(window, false, Qt::Key_Alt, modifier &
(Qt::ShiftModifier | Qt::ControlModifier | Qt::AltModifier), QString(), false, delay);
if (modifier & Qt::ControlModifier)
simulateEvent(window, false, Qt::Key_Control,
modifier & (Qt::ShiftModifier | Qt::ControlModifier), QString(), false, delay);
if (modifier & Qt::ShiftModifier)
simulateEvent(window, false, Qt::Key_Shift, modifier & Qt::ShiftModifier, QString(), false, delay);
}
}
// Convenience function
inline void sendKeyEvent(KeyAction action, QWindow *window, Qt::Key code,
char ascii, Qt::KeyboardModifiers modifier, int delay=-1)
{
QString text;
if (ascii)
text = QString(QChar::fromLatin1(ascii));
sendKeyEvent(action, window, code, text, modifier, delay);
}
inline void keyEvent(KeyAction action, QWindow *window, char ascii,
Qt::KeyboardModifiers modifier = Qt::NoModifier, int delay=-1)
{ sendKeyEvent(action, window, asciiToKey(ascii), ascii, modifier, delay); }
inline void keyEvent(KeyAction action, QWindow *window, Qt::Key key,
Qt::KeyboardModifiers modifier = Qt::NoModifier, int delay=-1)
{ sendKeyEvent(action, window, key, keyToAscii(key), modifier, delay); }
[[maybe_unused]] inline void keyClick(QWindow *window, Qt::Key key, Qt::KeyboardModifiers modifier = Qt::NoModifier, int delay=-1)
{ keyEvent(Click, window, key, modifier, delay); }
[[maybe_unused]] inline void keyClick(QWindow *window, char key, Qt::KeyboardModifiers modifier = Qt::NoModifier, int delay=-1)
{ keyEvent(Click, window, key, modifier, delay); }
[[maybe_unused]] inline void keyRelease(QWindow *window, char key, Qt::KeyboardModifiers modifier = Qt::NoModifier, int delay=-1)
{ keyEvent(Release, window, key, modifier, delay); }
[[maybe_unused]] inline void keyRelease(QWindow *window, Qt::Key key, Qt::KeyboardModifiers modifier = Qt::NoModifier, int delay=-1)
{ keyEvent(Release, window, key, modifier, delay); }
[[maybe_unused]] inline void keyPress(QWindow *window, char key, Qt::KeyboardModifiers modifier = Qt::NoModifier, int delay=-1)
{ keyEvent(Press, window, key, modifier, delay); }
[[maybe_unused]] inline void keyPress(QWindow *window, Qt::Key key, Qt::KeyboardModifiers modifier = Qt::NoModifier, int delay=-1)
{ keyEvent(Press, window, key, modifier, delay); }
#if QT_CONFIG(shortcut)
[[maybe_unused]] inline void keySequence(QWindow *window, const QKeySequence &keySequence)
{
for (int i = 0; i < keySequence.count(); ++i) {
const Qt::Key key = keySequence[i].key();
const Qt::KeyboardModifiers modifiers = keySequence[i].keyboardModifiers();
keyClick(window, key, modifiers);
}
}
#endif
#ifdef QT_WIDGETS_LIB
inline void simulateEvent(QWidget *widget, bool press, int code,
Qt::KeyboardModifiers modifier, const QString &text,
bool repeat, int delay = -1)
{
QTEST_ASSERT(widget);
extern int Q_TESTLIB_EXPORT defaultKeyDelay();
if (delay == -1 || delay < defaultKeyDelay())
delay = defaultKeyDelay();
if (delay > 0)
QTest::qWait(delay);
QKeyEvent a(press ? QEvent::KeyPress : QEvent::KeyRelease, code, modifier, text, repeat);
QSpontaneKeyEvent::setSpontaneous(&a);
if (press && qt_sendShortcutOverrideEvent(widget, a.timestamp(), code, modifier, text, repeat))
return;
if (!qApp->notify(widget, &a))
qWarning("Keyboard event not accepted by receiving widget");
}
inline void sendKeyEvent(KeyAction action, QWidget *widget, Qt::Key code,
const QString &text, Qt::KeyboardModifiers modifier,
int delay = -1)
{
QTEST_ASSERT(qApp);
if (!widget)
widget = QWidget::keyboardGrabber();
if (!widget) {
// Popup widgets stealthily steal the keyboard grab
if (QWidget *apw = QApplication::activePopupWidget())
widget = apw->focusWidget() ? apw->focusWidget() : apw;
}
if (!widget) {
QWindow *window = QGuiApplication::focusWindow();
if (window) {
sendKeyEvent(action, window, code, text, modifier, delay);
return;
}
}
if (!widget)
widget = QApplication::focusWidget();
if (!widget)
widget = QApplication::activeWindow();
QTEST_ASSERT(widget);
if (action == Click) {
QPointer<QWidget> ptr(widget);
sendKeyEvent(Press, widget, code, text, modifier, delay);
if (!ptr) {
// if we send key-events to embedded widgets, they might be destroyed
// when the user presses Return
return;
}
sendKeyEvent(Release, widget, code, text, modifier, delay);
return;
}
bool repeat = false;
if (action == Press) {
if (modifier & Qt::ShiftModifier)
simulateEvent(widget, true, Qt::Key_Shift, Qt::KeyboardModifiers(), QString(), false, delay);
if (modifier & Qt::ControlModifier)
simulateEvent(widget, true, Qt::Key_Control, modifier & Qt::ShiftModifier, QString(), false, delay);
if (modifier & Qt::AltModifier)
simulateEvent(widget, true, Qt::Key_Alt,
modifier & (Qt::ShiftModifier | Qt::ControlModifier), QString(), false, delay);
if (modifier & Qt::MetaModifier)
simulateEvent(widget, true, Qt::Key_Meta, modifier & (Qt::ShiftModifier
| Qt::ControlModifier | Qt::AltModifier), QString(), false, delay);
simulateEvent(widget, true, code, modifier, text, repeat, delay);
} else if (action == Release) {
simulateEvent(widget, false, code, modifier, text, repeat, delay);
if (modifier & Qt::MetaModifier)
simulateEvent(widget, false, Qt::Key_Meta, modifier, QString(), false, delay);
if (modifier & Qt::AltModifier)
simulateEvent(widget, false, Qt::Key_Alt, modifier &
(Qt::ShiftModifier | Qt::ControlModifier | Qt::AltModifier), QString(), false, delay);
if (modifier & Qt::ControlModifier)
simulateEvent(widget, false, Qt::Key_Control,
modifier & (Qt::ShiftModifier | Qt::ControlModifier), QString(), false, delay);
if (modifier & Qt::ShiftModifier)
simulateEvent(widget, false, Qt::Key_Shift, modifier & Qt::ShiftModifier, QString(), false, delay);
}
}
// Convenience function
inline void sendKeyEvent(KeyAction action, QWidget *widget, Qt::Key code,
char ascii, Qt::KeyboardModifiers modifier, int delay=-1)
{
QString text;
if (ascii)
text = QString(QChar::fromLatin1(ascii));
sendKeyEvent(action, widget, code, text, modifier, delay);
}
inline void keyEvent(KeyAction action, QWidget *widget, char ascii,
Qt::KeyboardModifiers modifier = Qt::NoModifier, int delay=-1)
{ sendKeyEvent(action, widget, asciiToKey(ascii), ascii, modifier, delay); }
inline void keyEvent(KeyAction action, QWidget *widget, Qt::Key key,
Qt::KeyboardModifiers modifier = Qt::NoModifier, int delay=-1)
{ sendKeyEvent(action, widget, key, keyToAscii(key), modifier, delay); }
inline void keyClicks(QWidget *widget, const QString &sequence,
Qt::KeyboardModifiers modifier = Qt::NoModifier, int delay=-1)
{
for (int i=0; i < sequence.size(); i++)
keyEvent(Click, widget, sequence.at(i).toLatin1(), modifier, delay);
}
inline void keyPress(QWidget *widget, char key, Qt::KeyboardModifiers modifier = Qt::NoModifier, int delay=-1)
{ keyEvent(Press, widget, key, modifier, delay); }
inline void keyRelease(QWidget *widget, char key, Qt::KeyboardModifiers modifier = Qt::NoModifier, int delay=-1)
{ keyEvent(Release, widget, key, modifier, delay); }
inline void keyClick(QWidget *widget, char key, Qt::KeyboardModifiers modifier = Qt::NoModifier, int delay=-1)
{ keyEvent(Click, widget, key, modifier, delay); }
inline void keyPress(QWidget *widget, Qt::Key key, Qt::KeyboardModifiers modifier = Qt::NoModifier, int delay=-1)
{ keyEvent(Press, widget, key, modifier, delay); }
inline void keyRelease(QWidget *widget, Qt::Key key, Qt::KeyboardModifiers modifier = Qt::NoModifier, int delay=-1)
{ keyEvent(Release, widget, key, modifier, delay); }
inline void keyClick(QWidget *widget, Qt::Key key, Qt::KeyboardModifiers modifier = Qt::NoModifier, int delay=-1)
{ keyEvent(Click, widget, key, modifier, delay); }
#if QT_CONFIG(shortcut)
inline void keySequence(QWidget *widget, const QKeySequence &keySequence)
{
for (int i = 0; i < keySequence.count(); ++i) {
const Qt::Key key = keySequence[i].key();
const Qt::KeyboardModifiers modifiers = keySequence[i].keyboardModifiers();
keyClick(widget, key, modifiers);
}
}
#endif
#endif // QT_WIDGETS_LIB
}
QT_END_NAMESPACE
#endif // QTESTKEYBOARD_H