13 Commits
Author SHA1 Message Date
Orgad Shaneh 4e3a244d87 Raise minimmum cmake version to 3.10 (#108)
Older versions are obsolete.
2025-10-01 01:28:08 +03:00
Orgad Shaneh d7b2589855 README: Fix typo (#107) 2025-10-01 00:58:35 +03:00
Daniel Bermond 6c0e98492c Add compatibility with QT_NO_KEYWORDS macro (#104)
The Qt documentation recommends[1] not using Qt keywords in the
public API of Qt libraries, specially the 'signals' and 'slots'
Qt keywords.

Without this, client applications that are compiled with the
'QT_NO_KEYWORDS'[2] macro (or that are compiled in conjunction
with other libraries that also defines the same Qt keywords)
will fail to build.

The 'QT_NO_SIGNALS_SLOTS_KEYWORDS'[1] macro assures that
the library is not using 'signals' and 'slots' Qt keywords,
since it will fail to build when they are used. Useful for
code sanity and for avoiding future pull requests that may
try to use these Qt keywords.

[1] https://doc.qt.io/qt-6/signalsandslots.html#signals-and-slots-in-qt-based-libraries
[2] https://doc.qt.io/qt-6/qtglobal.html#QT_NO_KEYWORDS
2025-07-06 13:48:54 +03:00
Daniel Bermond 8f90bdf90c Add compatibility with CMake 4.0 (#103)
Starting at CMake 4.0, the minimum required policy version is
3.5.0[1], either specified by 'cmake_minimum_required()' or by
'cmake_policy()'. This also applies to individual policies when
they are set, which must match 3.5.0 or later policies.

[1] https://cmake.org/cmake/help/v4.0/command/cmake_minimum_required.html
2025-07-06 13:48:05 +03:00
Javier O. Cordero Pérez bb63025268 Fix: Prevent crash on Wayland when using Qt 6 (#97) 2024-05-20 22:13:12 +03:00
Javier O. Cordero Pérez b519155479 Bump Qt and CI script versions, fix macOS support, and drop support for qmake (#98) 2024-05-20 16:09:14 +03:00
FredBill1andHennadii Chernyshchyk cd72a01327 Properly emit released signal when pressing multiple hotkeys at the same time on Windows (#86)
Co-authored-by: Hennadii Chernyshchyk <genaloner@gmail.com>
2023-04-18 12:14:52 +03:00
Javier O. Cordero PérezandHennadii Chernyshchyk 34777f2e91 CPack instructions to build Debian package
Co-authored-by: Hennadii Chernyshchyk <genaloner@gmail.com>
2022-07-07 16:01:21 +03:00
Javier O. Cordero 94efd5fb61 Using static_cast as suggested by Shatur. 2022-07-01 10:52:16 +03:00
Javier O. Cordero Pérez 6b1c6f1f4e Made Windows BYTE typedef uppercase in attempt to get QHotkey to compile with MSVC 2019. 2022-07-01 10:52:16 +03:00
luz paz c501fbbada Fix typos
Found via `codespell -q 3`
2022-06-23 10:14:35 +03:00
YueLiang 52e25acf22 Fix bug for get natice keycode failed in mac (#66)
TISCopyCurrentKeyboardInputSource will return null when using Chinese input method.
Use TISCopyCurrentASCIICapableKeyboardLayoutInputSource instead.
2022-02-21 10:01:45 +02:00
waneon 308c96c28f Fix invalid variable name in README.md 2022-02-05 15:02:03 +02:00
15 changed files with 67 additions and 142 deletions
+5 -20
View File
@@ -14,10 +14,10 @@ jobs:
build: build:
strategy: strategy:
matrix: matrix:
qt_version: [5.12.11, 5.15.2, 6.2.0] qt_version: [5.12.12, 5.15.2, 6.2.2]
platform: [ubuntu-20.04, windows-latest, macos-latest] platform: [ubuntu-20.04, windows-latest, macos-latest]
include: include:
- qt_version: 6.2.0 - qt_version: 6.2.2
additional_arguments: -D QT_DEFAULT_MAJOR_VERSION=6 additional_arguments: -D QT_DEFAULT_MAJOR_VERSION=6
- platform: ubuntu-20.04 - platform: ubuntu-20.04
make: make make: make
@@ -41,31 +41,16 @@ jobs:
uses: actions/checkout@v2.3.4 uses: actions/checkout@v2.3.4
- name: Install Qt - name: Install Qt
uses: jurplel/install-qt-action@v2.14.0 uses: jurplel/install-qt-action@v3.3.0
with: with:
version: ${{ matrix.qt_version }} version: ${{ matrix.qt_version }}
- name: Build with CMake as static - name: Build with CMake as static
run: | run: |
cmake . -D QHOTKEY_EXAMPLES=ON ${{ matrix.additional_arguments }} cmake . -D QHOTKEY_EXAMPLES=ON -D CMAKE_OSX_ARCHITECTURES="x86_64" ${{ matrix.additional_arguments }}
cmake --build . cmake --build .
- name: Build with CMake as shared - name: Build with CMake as shared
run: | run: |
cmake . -D BUILD_SHARED_LIBS=ON -D QHOTKEY_EXAMPLES=ON ${{ matrix.additional_arguments }} cmake . -D BUILD_SHARED_LIBS=ON -D QHOTKEY_EXAMPLES=ON -D CMAKE_OSX_ARCHITECTURES="x86_64" ${{ matrix.additional_arguments }}
cmake --build . cmake --build .
- name: Setup MSVC environment for QMake
uses: ilammy/msvc-dev-cmd@v1
- name: Build with QMake as static
working-directory: HotkeyTest
run: |
qmake
${{ matrix.make }}
- name: Build with QMake as shared
working-directory: HotkeyTest
run: |
qmake "DEFINES+=QHOTKEY_SHARED QHOTKEY_LIBRARY"
${{ matrix.make }}
+23 -2
View File
@@ -1,6 +1,10 @@
cmake_minimum_required(VERSION 3.1) cmake_minimum_required(VERSION 3.10)
project(qhotkey VERSION 1.5.0 LANGUAGES CXX) project(qhotkey
VERSION 1.5.0
DESCRIPTION "Global hotkey library for Qt software"
HOMEPAGE_URL "https://skycoder42.github.io/QHotkey/"
LANGUAGES CXX)
option(QHOTKEY_EXAMPLES "Build examples" OFF) option(QHOTKEY_EXAMPLES "Build examples" OFF)
option(QHOTKEY_INSTALL "Enable install rule" ON) option(QHOTKEY_INSTALL "Enable install rule" ON)
@@ -18,10 +22,27 @@ else()
find_package(Qt${QT_DEFAULT_MAJOR_VERSION} COMPONENTS Core Gui REQUIRED) find_package(Qt${QT_DEFAULT_MAJOR_VERSION} COMPONENTS Core Gui REQUIRED)
endif() endif()
# General settings
set(CPACK_PACKAGE_VENDOR "Skycoder42")
set(CPACK_PACKAGE_CONTACT "Shatur")
set(CPACK_RESOURCE_FILE_README "${CMAKE_SOURCE_DIR}/README.md")
# CPACK: DEB Specific Settings
set(CPACK_DEBIAN_PACKAGE_NAME "libqhotkey")
set(CPACK_DEBIAN_PACKAGE_SECTION "Libraries")
# Set dependencies
if(QT_DEFAULT_MAJOR_VERSION EQUAL 6)
set(CPACK_DEBIAN_PACKAGE_DEPENDS "libqt6x11extras6 (>= 6.2.0)")
else()
set(CPACK_DEBIAN_PACKAGE_DEPENDS "libqt5x11extras5 (>= 5.15.2)")
endif()
include(CPack)
add_library(qhotkey QHotkey/qhotkey.cpp) add_library(qhotkey QHotkey/qhotkey.cpp)
add_library(QHotkey::QHotkey ALIAS qhotkey) add_library(QHotkey::QHotkey ALIAS qhotkey)
target_link_libraries(qhotkey PUBLIC Qt${QT_DEFAULT_MAJOR_VERSION}::Core Qt${QT_DEFAULT_MAJOR_VERSION}::Gui) target_link_libraries(qhotkey PUBLIC Qt${QT_DEFAULT_MAJOR_VERSION}::Core Qt${QT_DEFAULT_MAJOR_VERSION}::Gui)
target_compile_definitions(qhotkey PRIVATE QT_NO_SIGNALS_SLOTS_KEYWORDS)
if(BUILD_SHARED_LIBS) if(BUILD_SHARED_LIBS)
target_compile_definitions(qhotkey PRIVATE QHOTKEY_LIBRARY) target_compile_definitions(qhotkey PRIVATE QHOTKEY_LIBRARY)
target_compile_definitions(qhotkey PUBLIC QHOTKEY_SHARED) target_compile_definitions(qhotkey PUBLIC QHOTKEY_SHARED)
-21
View File
@@ -1,21 +0,0 @@
#-------------------------------------------------
#
# Project created by QtCreator 2016-02-05T22:01:03
#
#-------------------------------------------------
QT += core gui
greaterThan(QT_MAJOR_VERSION, 4): QT += widgets
TARGET = HotkeyTest
TEMPLATE = app
include(../qhotkey.pri)
SOURCES += main.cpp\
hottestwidget.cpp
HEADERS += hottestwidget.h
FORMS += hottestwidget.ui
+3 -3
View File
@@ -769,7 +769,7 @@
<item> <item>
<widget class="QLabel" name="label_6"> <widget class="QLabel" name="label_6">
<property name="text"> <property name="text">
<string>&lt;b&gt;Testing:&lt;/b&gt; Please press the combinations listed below to check whether they work properly or not. Everytime a shortcut is triggered, the checkbox will toggle it's value. Set the test active to begin.</string> <string>&lt;b&gt;Testing:&lt;/b&gt; Please press the combinations listed below to check whether they work properly or not. Every time a shortcut is triggered, the checkbox will toggle it's value. Set the test active to begin.</string>
</property> </property>
<property name="wordWrap"> <property name="wordWrap">
<bool>true</bool> <bool>true</bool>
@@ -927,7 +927,7 @@
<item> <item>
<widget class="QLabel" name="label_7"> <widget class="QLabel" name="label_7">
<property name="text"> <property name="text">
<string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;This test was designed to try out multi-threaded shortcuts. The QHotkey class is completly &lt;span style=&quot; font-weight:600;&quot;&gt;threadsafe&lt;/span&gt;, but this test can help to see if it acutally works (It does).&lt;/p&gt;&lt;p&gt;If activated, &lt;span style=&quot; font-style:italic;&quot;&gt;Hotkey 4 and Hotkey 5 &lt;/span&gt;of the Playground will each run on their own thread. This means:&lt;/p&gt;&lt;ul style=&quot;margin-top: 0px; margin-bottom: 0px; margin-left: 0px; margin-right: 0px; -qt-list-indent: 1;&quot;&gt;&lt;li style=&quot; margin-top:12px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;span style=&quot; text-decoration: underline;&quot;&gt;Mainthread:&lt;/span&gt; Hotkey 1, 2, 3&lt;/li&gt;&lt;li style=&quot; margin-top:12px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;span style=&quot; text-decoration: underline;&quot;&gt;Second thread:&lt;/span&gt; Hotkey 4&lt;/li&gt;&lt;li style=&quot; margin-top:12px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;span style=&quot; text-decoration: underline;&quot;&gt;Third thread:&lt;/span&gt; Hotkey 5&lt;/li&gt;&lt;/ul&gt;&lt;p&gt;&lt;span style=&quot; font-weight:600;&quot;&gt;Note:&lt;/span&gt; The two hotkeys will be moved to the threads. For simplicity-reasons, you can't move them back in this test (But its possible, just not done here). Restart the test to get them back.&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string> <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;This test was designed to try out multi-threaded shortcuts. The QHotkey class is completely &lt;span style=&quot; font-weight:600;&quot;&gt;threadsafe&lt;/span&gt;, but this test can help to see if it actually works (It does).&lt;/p&gt;&lt;p&gt;If activated, &lt;span style=&quot; font-style:italic;&quot;&gt;Hotkey 4 and Hotkey 5 &lt;/span&gt;of the Playground will each run on their own thread. This means:&lt;/p&gt;&lt;ul style=&quot;margin-top: 0px; margin-bottom: 0px; margin-left: 0px; margin-right: 0px; -qt-list-indent: 1;&quot;&gt;&lt;li style=&quot; margin-top:12px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;span style=&quot; text-decoration: underline;&quot;&gt;Mainthread:&lt;/span&gt; Hotkey 1, 2, 3&lt;/li&gt;&lt;li style=&quot; margin-top:12px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;span style=&quot; text-decoration: underline;&quot;&gt;Second thread:&lt;/span&gt; Hotkey 4&lt;/li&gt;&lt;li style=&quot; margin-top:12px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;span style=&quot; text-decoration: underline;&quot;&gt;Third thread:&lt;/span&gt; Hotkey 5&lt;/li&gt;&lt;/ul&gt;&lt;p&gt;&lt;span style=&quot; font-weight:600;&quot;&gt;Note:&lt;/span&gt; The two hotkeys will be moved to the threads. For simplicity-reasons, you can't move them back in this test (But its possible, just not done here). Restart the test to get them back.&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
</property> </property>
<property name="textFormat"> <property name="textFormat">
<enum>Qt::RichText</enum> <enum>Qt::RichText</enum>
@@ -973,7 +973,7 @@
<item> <item>
<widget class="QLabel" name="label_8"> <widget class="QLabel" name="label_8">
<property name="text"> <property name="text">
<string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;QHotkey allows you to set native shortcuts explicitly. These, of course, only work on the platform they were choosen for. All platform use special constants for their key codes and modifiers, which makes it pretty simple to use them from code. If you want to test them out here, google for the tables.&lt;/p&gt;&lt;p&gt;In most cases, you will not need to specify native shortcuts directly. However, as explaind on previos tabs, some shotcuts may not be creatable from Qt's key (e.g. Numblock numbers). In that case, you can set the directly.&lt;/p&gt;&lt;p&gt;&lt;span style=&quot; text-decoration: underline;&quot;&gt;Example: Ctrl+A&lt;/span&gt;&lt;/p&gt;&lt;ul style=&quot;margin-top: 0px; margin-bottom: 0px; margin-left: 0px; margin-right: 0px; -qt-list-indent: 1;&quot;&gt;&lt;li style=&quot; margin-top:12px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;span style=&quot; font-weight:600;&quot;&gt;Windows:&lt;/span&gt; Key: &lt;span style=&quot; font-style:italic;&quot;&gt;0x0041&lt;/span&gt;, Modifier: &lt;span style=&quot; font-style:italic;&quot;&gt;0x0002&lt;/span&gt;&lt;/li&gt;&lt;li style=&quot; margin-top:12px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;span style=&quot; font-weight:600;&quot;&gt;X11:&lt;/span&gt; Key: &lt;span style=&quot; font-style:italic;&quot;&gt;0x0026&lt;/span&gt;, Modifier: &lt;span style=&quot; font-style:italic;&quot;&gt;0x0004&lt;/span&gt;&lt;/li&gt;&lt;li style=&quot; margin-top:12px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;span style=&quot; font-weight:600;&quot;&gt;OsX:&lt;/span&gt; Key: &lt;span style=&quot; font-style:italic;&quot;&gt;0x0000&lt;/span&gt;, Modifier: &lt;span style=&quot; font-style:italic;&quot;&gt;0x0100&lt;/span&gt;&lt;span style=&quot; text-decoration: underline;&quot;&gt;&lt;br/&gt;&lt;/span&gt;&lt;/li&gt;&lt;/ul&gt;&lt;/body&gt;&lt;/html&gt;</string> <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;QHotkey allows you to set native shortcuts explicitly. These, of course, only work on the platform they were chosen for. All platform use special constants for their key codes and modifiers, which makes it pretty simple to use them from code. If you want to test them out here, google for the tables.&lt;/p&gt;&lt;p&gt;In most cases, you will not need to specify native shortcuts directly. However, as explained on previous tabs, some shortcuts may not be creatable from Qt's key (e.g. Numblock numbers). In that case, you can set the directly.&lt;/p&gt;&lt;p&gt;&lt;span style=&quot; text-decoration: underline;&quot;&gt;Example: Ctrl+A&lt;/span&gt;&lt;/p&gt;&lt;ul style=&quot;margin-top: 0px; margin-bottom: 0px; margin-left: 0px; margin-right: 0px; -qt-list-indent: 1;&quot;&gt;&lt;li style=&quot; margin-top:12px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;span style=&quot; font-weight:600;&quot;&gt;Windows:&lt;/span&gt; Key: &lt;span style=&quot; font-style:italic;&quot;&gt;0x0041&lt;/span&gt;, Modifier: &lt;span style=&quot; font-style:italic;&quot;&gt;0x0002&lt;/span&gt;&lt;/li&gt;&lt;li style=&quot; margin-top:12px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;span style=&quot; font-weight:600;&quot;&gt;X11:&lt;/span&gt; Key: &lt;span style=&quot; font-style:italic;&quot;&gt;0x0026&lt;/span&gt;, Modifier: &lt;span style=&quot; font-style:italic;&quot;&gt;0x0004&lt;/span&gt;&lt;/li&gt;&lt;li style=&quot; margin-top:12px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;span style=&quot; font-weight:600;&quot;&gt;OsX:&lt;/span&gt; Key: &lt;span style=&quot; font-style:italic;&quot;&gt;0x0000&lt;/span&gt;, Modifier: &lt;span style=&quot; font-style:italic;&quot;&gt;0x0100&lt;/span&gt;&lt;span style=&quot; text-decoration: underline;&quot;&gt;&lt;br/&gt;&lt;/span&gt;&lt;/li&gt;&lt;/ul&gt;&lt;/body&gt;&lt;/html&gt;</string>
</property> </property>
<property name="wordWrap"> <property name="wordWrap">
<bool>true</bool> <bool>true</bool>
-10
View File
@@ -1,10 +0,0 @@
TEMPLATE = subdirs
SUBDIRS += \
HotkeyTest \
QHotkey
DISTFILES += README.md \
LICENSE \
doc/qhotkey.doxy \
doc/qhotkey.dox
-16
View File
@@ -1,16 +0,0 @@
TEMPLATE = lib
win32: CONFIG += dll
TARGET = QHotkey
VERSION = 1.5.0
include(../qhotkey.pri)
DEFINES += QHOTKEY_SHARED QHOTKEY_LIBRARY
# use INSTALL_ROOT to modify the install location
headers.files = $$PUBLIC_HEADERS
headers.path = $$[QT_INSTALL_HEADERS]
target.path = $$[QT_INSTALL_LIBS]
INSTALLS += target headers
+2 -2
View File
@@ -88,7 +88,7 @@ public:
//! Get the current native shortcut //! Get the current native shortcut
NativeShortcut currentNativeShortcut() const; NativeShortcut currentNativeShortcut() const;
public slots: public Q_SLOTS:
//! @writeAcFn{QHotkey::registered} //! @writeAcFn{QHotkey::registered}
bool setRegistered(bool registered); bool setRegistered(bool registered);
@@ -102,7 +102,7 @@ public slots:
//! Set this hotkey to a native shortcut //! Set this hotkey to a native shortcut
bool setNativeShortcut(QHotkey::NativeShortcut nativeShortcut, bool autoRegister = false); bool setNativeShortcut(QHotkey::NativeShortcut nativeShortcut, bool autoRegister = false);
signals: Q_SIGNALS:
//! Will be emitted if the shortcut is pressed //! Will be emitted if the shortcut is pressed
void activated(QPrivateSignal); void activated(QPrivateSignal);
-1
View File
@@ -1 +0,0 @@
message(The pri file has been moved one directory up! use that one instead)
+1 -1
View File
@@ -134,7 +134,7 @@ quint32 QHotkeyPrivateMac::nativeKeycode(Qt::Key keycode, bool &ok)
UTF16Char ch = keycode; UTF16Char ch = keycode;
CFDataRef currentLayoutData; CFDataRef currentLayoutData;
TISInputSourceRef currentKeyboard = TISCopyCurrentKeyboardInputSource(); TISInputSourceRef currentKeyboard = TISCopyCurrentASCIICapableKeyboardLayoutInputSource();
if (currentKeyboard == NULL) if (currentKeyboard == NULL)
return 0; return 0;
+14 -7
View File
@@ -1,7 +1,9 @@
#include "qhotkey.h" #include "qhotkey.h"
#include "qhotkey_p.h" #include "qhotkey_p.h"
#include <qt_windows.h> #include <qt_windows.h>
#include <algorithm>
#include <QDebug> #include <QDebug>
#include <QList>
#include <QTimer> #include <QTimer>
#define HKEY_ID(nativeShortcut) (((nativeShortcut.key ^ (nativeShortcut.modifier << 8)) & 0x0FFF) | 0x7000) #define HKEY_ID(nativeShortcut) (((nativeShortcut.key ^ (nativeShortcut.modifier << 8)) & 0x0FFF) | 0x7000)
@@ -28,7 +30,7 @@ protected:
private: private:
static QString formatWinError(DWORD winError); static QString formatWinError(DWORD winError);
QTimer pollTimer; QTimer pollTimer;
QHotkey::NativeShortcut polledShortcut; QList<QHotkey::NativeShortcut> polledShortcuts;
}; };
NATIVE_INSTANCE(QHotkeyPrivateWin) NATIVE_INSTANCE(QHotkeyPrivateWin)
@@ -51,8 +53,9 @@ bool QHotkeyPrivateWin::nativeEventFilter(const QByteArray &eventType, void *mes
if(msg->message == WM_HOTKEY) { if(msg->message == WM_HOTKEY) {
QHotkey::NativeShortcut shortcut = {HIWORD(msg->lParam), LOWORD(msg->lParam)}; QHotkey::NativeShortcut shortcut = {HIWORD(msg->lParam), LOWORD(msg->lParam)};
this->activateShortcut(shortcut); this->activateShortcut(shortcut);
this->polledShortcut = shortcut; if (this->polledShortcuts.empty())
this->pollTimer.start(); this->pollTimer.start();
this->polledShortcuts.append(shortcut);
} }
return false; return false;
@@ -60,11 +63,15 @@ bool QHotkeyPrivateWin::nativeEventFilter(const QByteArray &eventType, void *mes
void QHotkeyPrivateWin::pollForHotkeyRelease() void QHotkeyPrivateWin::pollForHotkeyRelease()
{ {
bool pressed = (GetAsyncKeyState(this->polledShortcut.key) & (1 << 15)) != 0; auto it = std::remove_if(this->polledShortcuts.begin(), this->polledShortcuts.end(), [this](const QHotkey::NativeShortcut &shortcut) {
if(!pressed) { bool pressed = (GetAsyncKeyState(shortcut.key) & (1 << 15)) != 0;
if (!pressed)
this->releaseShortcut(shortcut);
return !pressed;
});
this->polledShortcuts.erase(it, this->polledShortcuts.end());
if (this->polledShortcuts.empty())
this->pollTimer.stop(); this->pollTimer.stop();
this->releaseShortcut(this->polledShortcut);
}
} }
quint32 QHotkeyPrivateWin::nativeKeycode(Qt::Key keycode, bool &ok) quint32 QHotkeyPrivateWin::nativeKeycode(Qt::Key keycode, bool &ok)
@@ -235,7 +242,7 @@ quint32 QHotkeyPrivateWin::nativeKeycode(Qt::Key keycode, bool &ok)
default: default:
if(keycode <= 0xFFFF) if(keycode <= 0xFFFF)
return (byte)keycode; return static_cast<BYTE>(keycode);
else { else {
ok = false; ok = false;
return 0; return 0;
+6 -3
View File
@@ -13,7 +13,7 @@
#include <X11/Xlib.h> #include <X11/Xlib.h>
#include <xcb/xcb.h> #include <xcb/xcb.h>
//compability to pre Qt 5.8 //compatibility to pre Qt 5.8
#ifndef Q_FALLTHROUGH #ifndef Q_FALLTHROUGH
#define Q_FALLTHROUGH() (void)0 #define Q_FALLTHROUGH() (void)0
#endif #endif
@@ -132,13 +132,16 @@ quint32 QHotkeyPrivateX11::nativeKeycode(Qt::Key keycode, bool &ok)
#if QT_VERSION >= QT_VERSION_CHECK(6, 2, 0) #if QT_VERSION >= QT_VERSION_CHECK(6, 2, 0)
const QNativeInterface::QX11Application *x11Interface = qGuiApp->nativeInterface<QNativeInterface::QX11Application>(); const QNativeInterface::QX11Application *x11Interface = qGuiApp->nativeInterface<QNativeInterface::QX11Application>();
Display *display = x11Interface->display();
#else #else
const bool x11Interface = QX11Info::isPlatformX11(); const bool x11Interface = QX11Info::isPlatformX11();
Display *display = QX11Info::display();
#endif #endif
if(x11Interface) { if(x11Interface) {
#if QT_VERSION >= QT_VERSION_CHECK(6, 2, 0)
Display *display = x11Interface->display();
#else
Display *display = QX11Info::display();
#endif
auto res = XKeysymToKeycode(display, keysym); auto res = XKeysymToKeycode(display, keysym);
if(res != 0) if(res != 0)
ok = true; ok = true;
+9 -20
View File
@@ -16,30 +16,19 @@ The QHotkey is a class that can be used to create hotkeys/global shortcuts, aka
## Building ## Building
QHotkey supports both Qt6 and Qt5. When using Qt6, version 6.2.0 or later required. It can be built by either the CMake or qmake building systems. QHotkey supports both Qt6 and Qt5. When using Qt6, version 6.2.0 or later required. It can be built using the CMake building system.
### CMake ### CMake
The CMake `QT_MAJOR` variable controls which major version of Qt is used for building, and defaults to `5`. For example, use the CMake command line option `-DQT_MAJOR=6` for building with Qt6. To build the testing application `QHotkeyTest`, specify `-DQHOTKEY_EXAMPLES=ON`. CMake example usage: The CMake `QT_DEFAULT_MAJOR_VERSION` variable controls which major version of Qt is used for building, and defaults to `5`. For example, use the CMake command line option `-DQT_DEFAULT_MAJOR_VERSION=6` for building with Qt6. To build the testing application `QHotkeyTest`, specify `-DQHOTKEY_EXAMPLES=ON`. CMake example usage:
``` ```
$ cd QHotkey $ cd QHotkey
$ cmake -B build -S . -DQT_MAJOR=6 $ cmake -B build -S . -DQT_DEFAULT_MAJOR_VERSION=6
$ cmake --build build $ cmake --build build
# cmake --install build # cmake --install build
``` ```
### qmake
The major version of Qt is chosen by the qmake invokation itself, as the qmake executable is tied to a specific Qt version. The executable name can vary between operating systems. qmake example usage:
```
$ cd QHotkey
$ qmake
$ make
# make install
```
## Installation ## Installation
The package is providet as qpm package, [`de.skycoder42.qhotkey`](https://www.qpm.io/packages/de.skycoder42.qhotkey/index.html). You can install it either via qpmx (preferred) or directly via qpm. The package is providet as qpm package, [`de.skycoder42.qhotkey`](https://www.qpm.io/packages/de.skycoder42.qhotkey/index.html). You can install it either via qpmx (preferred) or directly via qpm.
@@ -77,7 +66,7 @@ int main(int argc, char *argv[])
QApplication app(argc, argv); QApplication app(argc, argv);
QHotkey hotkey(QKeySequence("Ctrl+Alt+Q"), true, &app); //The hotkey will be automatically registered QHotkey hotkey(QKeySequence("Ctrl+Alt+Q"), true, &app); //The hotkey will be automatically registered
qDebug() << "Is segistered:" << hotkey.isRegistered(); qDebug() << "Is registered:" << hotkey.isRegistered();
QObject::connect(&hotkey, &QHotkey::activated, qApp, [&](){ QObject::connect(&hotkey, &QHotkey::activated, qApp, [&](){
qDebug() << "Hotkey Activated - the application will quit now"; qDebug() << "Hotkey Activated - the application will quit now";
@@ -94,18 +83,18 @@ int main(int argc, char *argv[])
By running the example in `./HotkeyTest` you can test out the QHotkey class. There are 4 sections: By running the example in `./HotkeyTest` you can test out the QHotkey class. There are 4 sections:
- **Playground:** You can enter some sequences here and try it out with different key combinations. - **Playground:** You can enter some sequences here and try it out with different key combinations.
- **Testings:** A list of selected hotkeys. Activate it and try out which ones work for you (*Hint:* Depending on OS and keyboard layout, it's very possible that a few don't work). - **Testings:** A list of selected hotkeys. Activate it and try out which ones work for you (*Hint:* Depending on OS and keyboard layout, it's very possible that a few don't work).
- **Threading:** Activate the checkbox to move 2 Hotkeys of the playground to seperate threads. It should work without a difference. - **Threading:** Activate the checkbox to move 2 Hotkeys of the playground to separate threads. It should work without a difference.
- **Native Shortcut**: Allows you to try out the direct usage of native shortcuts - **Native Shortcut**: Allows you to try out the direct usage of native shortcuts
### Logging ### Logging
By default, QHotkey prints some warning messages if something goes wrong (For example, a key that cannot be translated). All messages of QHotkey are grouped into the [QLoggingCategory](https://doc.qt.io/qt-5/qloggingcategory.html) `"QHotkey"`. If you want to simply disable the logging, call the folling function somewhere in your code: By default, QHotkey prints some warning messages if something goes wrong (For example, a key that cannot be translated). All messages of QHotkey are grouped into the [QLoggingCategory](https://doc.qt.io/qt-5/qloggingcategory.html) `"QHotkey"`. If you want to simply disable the logging, call the following function somewhere in your code:
```cpp ```cpp
QLoggingCategory::setFilterRules(QStringLiteral("QHotkey.warning=false")); QLoggingCategory::setFilterRules(QStringLiteral("QHotkey.warning=false"));
``` ```
This will turn all warnings of QHotkey of (It only uses warnings for now, thats why this is enough). For more information about all the things you can do with the logging categories, check the Qt-Documentation This will turn all warnings of QHotkey of (It only uses warnings for now, that's why this is enough). For more information about all the things you can do with the logging categories, check the Qt-Documentation
## Thread saftey ## Thread safety
The QHotkey class itself is reentrant - wich means you can create as many instances as required on any thread. This allows you to use the QHotkey on all threads. **But** you should never use the QHotkey instance on a thread that is different from the one the instance belongs to! Internally the system uses a singleton instance that handles the hotkey events and distributes them to the QHotkey instances. This internal class is completley threadsafe. The QHotkey class itself is reentrant - which means you can create as many instances as required on any thread. This allows you to use the QHotkey on all threads. **But** you should never use the QHotkey instance on a thread that is different from the one the instance belongs to! Internally the system uses a singleton instance that handles the hotkey events and distributes them to the QHotkey instances. This internal class is completely threadsafe.
However, this singleton instance only runs on the main thread. (One reason is that some of the OS-Functions are not thread safe). To make threaded hotkeys possible, the critical functions (registering/unregistering hotkeys and keytranslation) are all run on the mainthread too. The QHotkey instances on other threads use `QMetaObject::invokeMethod` with a `Qt::BlockingQueuedConnection`. However, this singleton instance only runs on the main thread. (One reason is that some of the OS-Functions are not thread safe). To make threaded hotkeys possible, the critical functions (registering/unregistering hotkeys and keytranslation) are all run on the mainthread too. The QHotkey instances on other threads use `QMetaObject::invokeMethod` with a `Qt::BlockingQueuedConnection`.
+3 -3
View File
@@ -38,7 +38,7 @@ In addition to the normal accessors, a modification of the QHotkey::shortcut pro
@default{`QKeySequence()` (`Qt::Key_unknown` + `Qt::NoModifier`)} @default{`QKeySequence()` (`Qt::Key_unknown` + `Qt::NoModifier`)}
Holds the shortcut this hotkey will be registered on. It can be used as QKeySequence or as a combination of Holds the shortcut this hotkey will be registered on. It can be used as QKeySequence or as a combination of
a Qt::Key and Qt::KeyboardModifiers. All write-accessors specifiy an additional parameter to immediatly register a Qt::Key and Qt::KeyboardModifiers. All write-accessors specify an additional parameter to immediately register
the hotkey. the hotkey.
@note Since the operating systems do not support hotkeys that consist of multiple key-combinations in a sequence, @note Since the operating systems do not support hotkeys that consist of multiple key-combinations in a sequence,
@@ -107,7 +107,7 @@ it does. This does not happen if used from the main thread.
If the hotkey is still registered on destruction, it will automatically unregister itself. If the hotkey is still registered on destruction, it will automatically unregister itself.
@warning If using a hotkey on a thread other than the main thread, make shure the QApplication is still running it's eventloop. @warning If using a hotkey on a thread other than the main thread, make sure the QApplication is still running it's eventloop.
Otherwise your application will hang up. Otherwise your application will hang up.
@sa QHotkey::registered @sa QHotkey::registered
@@ -144,7 +144,7 @@ from the thread this instance lives on.
This method can be used to remap specific hotkey to a different native representation than the This method can be used to remap specific hotkey to a different native representation than the
one that would be used by default. This can be useful if specific key combinations work fine one that would be used by default. This can be useful if specific key combinations work fine
on allmost all platforms, but on one you need a different keycode for the same effect. See on almost all platforms, but on one you need a different keycode for the same effect. See
[Issue #15](https://github.com/Skycoder42/QHotkey/issues/15) for an example where this is the [Issue #15](https://github.com/Skycoder42/QHotkey/issues/15) for an example where this is the
case. case.
-15
View File
@@ -1,15 +0,0 @@
mac: LIBS += -framework Carbon
else:win32: LIBS += -luser32
else:unix {
equals(QT_MAJOR_VERSION, 6) {
lessThan(QT_VERSION, 6.2.0) {
error("Qt 6.2.0 or greater is required when using Qt6")
}
}
else {
lessThan(QT_MAJOR_VERSION, 6) {
QT += x11extras
}
}
LIBS += -lX11
}
-17
View File
@@ -1,17 +0,0 @@
CONFIG += C++11
PUBLIC_HEADERS += $$PWD/QHotkey/qhotkey.h \
$$PWD/QHotkey/QHotkey
HEADERS += $$PUBLIC_HEADERS \
$$PWD/QHotkey/qhotkey_p.h
SOURCES += $$PWD/QHotkey/qhotkey.cpp
mac: SOURCES += $$PWD/QHotkey/qhotkey_mac.cpp
else:win32: SOURCES += $$PWD/QHotkey/qhotkey_win.cpp
else:unix: SOURCES += $$PWD/QHotkey/qhotkey_x11.cpp
INCLUDEPATH += $$PWD/QHotkey
include($$PWD/qhotkey.prc)