Skip to content

Commit fb0c65f

Browse files
committed
Update README.md
1 parent 3c40d30 commit fb0c65f

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,6 @@ A global shortcut/hotkey for Desktop Qt-Applications.
33

44
The QHotkey is a class that can be used to create hotkeys/global shortcuts, aka shortcuts that work everywhere, independent of the application state. This means your application can be active, inactive, minimized or not visible at all and still receive the shortcuts.
55

6-
## Status
7-
**Still in development!!!** - But almost done. There are only some small details and documentation left. It's ready to be used.
8-
96
## Features
107
- Works on Windows, Mac and X11
118
- Easy to use, can use `QKeySequence` for easy shortcut input
@@ -62,6 +59,11 @@ However, this singleton instance only runs on the main thread. (One reason is th
6259

6360
For you this means: QHotkey instances on other threads than the main thread may take a little longer to register/unregister/translate hotkeys, because they have to wait for the main thread to do this for them. **Important:** there is however, one additional limitation that comes with that feature: QHotkey instances on other threads but the main thread *must* be unregistered or destroyed *before* the main eventloop ends. Otherwise, your application will hangup on destruction of the hotkey. This limitation does not apply for instances on the main thread. Furthermore, the same happens if you change the shortcut or register/unregister before the loop started, until it actually starts.
6461

62+
## Documentation
63+
The documentation is available within the releases and on [github pages](https://skycoder42.github.io/QHotkey/).
64+
65+
The documentation was created using [doxygen](http://www.doxygen.org). It includes an HTML-documentation and Qt-Help files that can be included into QtCreator (QtAssistant) to show F1-Help (See [Adding External Documentation](https://doc.qt.io/qtcreator/creator-help.html#adding-external-documentation) for more details).
66+
6567
## Technical
6668
### Requirements
6769
- I built it with Qt 5.5.1, but may work with earlier versions, too

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy