AtlasGlobalShortcut

AtlasGlobalShortcut asks the desktop (the xdg-desktop-portal GlobalShortcuts interface) for a shortcut that works in every window. The user can change the key in System Settings. It has no visuals.

One portal session is made for the app, when the first shortcut is ready. Every shortcut declared in the same turn of the event loop goes into one BindShortcuts call (KDE activates a shortcut only then); one declared later is bound with another call on the same session. Every D-Bus call is asynchronous and has a timeout, so nothing blocks the interface. Without a session bus or portal the type is unavailable, and errorString says why in plain words. It is not final. When the portal appears after the app started (no portal was ever reached), the shortcuts are bound at once. When it reappears after a failure, a quiet minute gives a fresh start; sooner than that the same backoff applies. After a failed attempt (a timeout, a refusal, an unreadable answer) the session tries again by itself, after 2, 4, 8, 16 and 32 seconds, and then stops after 5 attempts. Once the retries are used up and the portal comes back, there is one late retry after 32 seconds, postponed each time the portal drops and returns. Edits made while a retry is waiting ride on that retry. The count starts again after a session has lived for 60 seconds; a shortcut that is added or changed after the retries stopped makes one new attempt. A session the portal closes within 60 seconds of its creation counts as a failure; one that closes later is made again at once.

Example

import Atlas.Ui

AtlasGlobalShortcut {
    name: "show-window"
    description: qsTr("Show the window")
    preferredTrigger: "Meta+Shift+M"
    onActivated: window.raise()
}

Properties

Signals