Function: system-taskbar--attention

system-taskbar--attention is a byte-compiled function defined in system-taskbar.el.gz.

Signature

(system-taskbar--attention &optional URGENCY TIMEOUT)

Documentation

Flash the system taskbar icon and/or frame to alert the user.

URGENCY can be one of the symbols informational, or critical. If URGENCY is nil, clear the attention indicator.

The attention indicator is cleared by the earliest of bringing the Emacs GUI into focus, or after TIMEOUT seconds. If TIMEOUT is nil, the system GUI behavior has priority.

On some back ends, critical has the same effect as informational.

On some back ends, attention will be displayed only if Emacs is not the currently focused application.

Implementations

(system-taskbar--attention (&OPTIONAL ((&context . system-taskbar--back-end) eql 'w32)) URGENCY TIMEOUT) in `system-taskbar.el'.

Request URGENCY user attention on the system taskbar icon. Indicate the icon associated with the selected frame. If URGENCY is the symbol `informational', flash the taskbar icon. If URGENCY is the symbol `critical', flash the taskbar icon and the MS-Windows window frame. Clear attention indicator after TIMEOUT seconds. If TIMEOUT is nil, default to MS-Windows default behavior.

(system-taskbar--attention (&OPTIONAL ((&context . system-taskbar--back-end) eql 'ns)) URGENCY TIMEOUT) in `system-taskbar.el'.

Request URGENCY user attention on the Dock. The attention indicator will be cleared after TIMEOUT seconds.

(system-taskbar--attention (&OPTIONAL ((&context . system-taskbar--back-end) eql 'dbus)) URGENCY TIMEOUT) in `system-taskbar.el'.

Request URGENCY user attention on the system taskbar Emacs icon. The request will time out within the TIMEOUT seconds interval. The Unity D-Bus protocol does not support differentiated urgency levels.

Source Code

;; Defined in /usr/src/emacs/lisp/system-taskbar.el.gz
(cl-defgeneric system-taskbar--attention (&optional urgency timeout)
  "Flash the system taskbar icon and/or frame to alert the user.
URGENCY can be one of the symbols `informational', or `critical'.
If URGENCY is nil, clear the attention indicator.

The attention indicator is cleared by the earliest of bringing the Emacs
GUI into focus, or after TIMEOUT seconds.  If TIMEOUT is nil, the system
GUI behavior has priority.

On some back ends, `critical' has the same effect as `informational'.

On some back ends, attention will be displayed only if Emacs is not the
currently focused application.")