mirrors/kitty
1
0
Fork 0
mirror of https://github.com/kovidgoyal/kitty synced 2026-06-08 14:18:26 +02:00
Code Issues Packages Projects Releases Wiki Activity

Clarify the semantics of close notification responses

Browse Source 
Also, simplify the escape code, not requiring an extra p value.
Default to not responding.
This commit is contained in:
Kovid Goyal
2024-07-24 06:39:28 +05:30
parent a4a9d13ee0
commit 81e99f46f1
1 changed files with 17 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/desktop-notifications.rst
View File

@@ -103,17 +103,26 @@ To close a previous notification, send::
<OSC> i=<notification id> : p=close ; <terminator> <OSC> i=<notification id> : p=close ; <terminator>
This will close a previous notification with the specified id. If closing This will close a previous notification with the specified id. If you want a
succeeds, or the notification was already closed, notification when closing succeeds, send the following instead::
the terminal will send an escape code of the form::
<OSC> i=<notification id> : p=close ; notify <terminator>
Then, the terminal will respond with::
<OSC> i=<notification id> : p=close ; <terminator> <OSC> i=<notification id> : p=close ; <terminator>
Closing is done on a best effort basis so applications must not rely on the This escape code is sent by the terminal if the notification is closed
delivery of the closed escape code. If you do not want to receive an escape or was already closed when the close request arrives, or a notification
code notifying you of closure, use:: with the specified identifier does not exist. If the notification is activated,
before it can be closed, then the close response is sent only if the there is no
activation response. In other words, if you close a response and request
notification, you will get either of the following two responses::
<OSC> i=<notification id> : p=close ; <terminator> # closed
<OSC> i=<notification id> ; <terminator> # activated
<OSC> i=<notification id> : p=close_simple ; <terminator>
Querying for support Querying for support
------------------------- -------------------------
@@ -190,8 +199,7 @@ Key Value Default Description
``p`` One of ``title``, ``title`` Whether the payload is the notification title or body or query. If a ``p`` One of ``title``, ``title`` Whether the payload is the notification title or body or query. If a
``body``, notification has no title, the body will be used as title. Terminal ``body``, notification has no title, the body will be used as title. Terminal
``close``, emulators should ignore payloads of unknown type to allow for future ``close``, emulators should ignore payloads of unknown type to allow for future
``close_simple``, expansion of this protocol. ``?`` expansion of this protocol.
``?``
``o`` One of ``always``, ``always`` When to honor the notification request. ``unfocused`` means when the window ``o`` One of ``always``, ``always`` When to honor the notification request. ``unfocused`` means when the window