Global Shortcuts¶

Description¶

Properties¶

org.freedesktop.impl.portal.GlobalShortcuts:version¶

version readable u

Methods¶

org.freedesktop.impl.portal.GlobalShortcuts.CreateSession¶

CreateSession (
  IN handle o,
  IN session_handle o,
  IN app_id s,
  IN options a{sv},
  OUT response u,
  OUT results a{sv}
)

Create a global shortcuts session.

The following results get returned in the results vardict:

session_id (s)

The session id. A string representing the created global shortcuts session.

handle: Object path for the Request object representing this call
session_handle: Object path for the ref:org.freedesktop.impl.portal.Session object representing the session being created
app_id: App id of the application
options: Vardict with optional further information. See org.freedesktop.portal.GlobalShortcuts.CreateSession
response: Numeric Request response
results: Vardict with the results of the call

org.freedesktop.impl.portal.GlobalShortcuts.BindShortcuts¶

BindShortcuts (
  IN handle o,
  IN session_handle o,
  IN shortcuts a(sa{sv}),
  IN parent_window s,
  IN options a{sv},
  OUT response u,
  OUT results a{sv}
)

Bind the shortcuts of this session. This will typically result the portal presenting a dialog letting the user configure shortcut triggers.

The results get returned via the org.freedesktop.portal.Request::Response signal. See org.freedesktop.portal.GlobalShortcuts.BindShortcuts for the list of supported properties of shortcuts.

handle: Object path for the Request object representing this call
session_handle: Object path for the Session object representing the session
shortcuts: The identifier of the shortcuts we intend to register, empty for all shortcuts
parent_window: Identifier for the application window, see Window Identifiers

options

response

results: Vardict with the results of the call

org.freedesktop.impl.portal.GlobalShortcuts.ListShortcuts¶

ListShortcuts (
  IN handle o,
  IN session_handle o,
  OUT response u,
  OUT results a{sv}
)

List shortcuts registered in the global shortcuts session.

The following results get returned in the results vardict:

shortcuts (a(sa{sv}))

A list of shortcuts.

See the org.freedesktop.portal.Request::Response signal of the org.freedesktop.portal.GlobalShortcuts.BindShortcuts method for the list of supported properties of shortcuts.

handle: Object path for the Request object representing this call
session_handle: Object path for the Session object representing the session

response

results: Vardict with the results of the call

Signals¶

org.freedesktop.impl.portal.GlobalShortcuts::Activated¶

Activated (
  session_handle o,
  shortcut_id s,
  timestamp t,
  options a{sv}
)

Emitted when a shortcut is activated.

session_handle: Session that requested the shortcut
shortcut_id: the application-provided ID for the notification
timestamp: the time of activation with millisecond granularity, with an undefined base.
options: Vardict with optional further information

org.freedesktop.impl.portal.GlobalShortcuts::Deactivated¶

Deactivated (
  session_handle o,
  shortcut_id s,
  timestamp t,
  options a{sv}
)

Emitted when a shortcut is deactivated.

session_handle: Session that requested the shortcut
shortcut_id: the application-provided ID for the notification
timestamp: the time of deactivation with millisecond granularity, with an undefined base.
options: Vardict with optional further information

org.freedesktop.impl.portal.GlobalShortcuts::ShortcutsChanged¶

ShortcutsChanged (
  session_handle o,
  shortcuts a(sa{sv})
)

Emitted when shortcuts are changed.

The results get returned via the org.freedesktop.portal.Request::Response signal. See org.freedesktop.portal.GlobalShortcuts.BindShortcuts for the list of supported properties of shortcuts.

session_handle: Session that requested the shortcut
shortcuts: The list of changed shortcuts