wez/wezterm
1
1
Fork 0
mirror of https://github.com/wez/wezterm.git synced 2024-12-27 23:46:31 +03:00
Code Issues Projects Releases Wiki Activity
e70f97903b
wezterm/docs/config/lua/window-events/bell.md

30 lines
877 B
Markdown
Raw Normal View History

gui: new bell event for running lua when the bell is rung This commit adjusts the the window event routing/queuing so that a queued event can capture a pane_id other than the focused pane. Since we only allow one queued instance of a given named event in a window, a consequence of this is that multiple bell events coming from different panes at the same time may race and the loser's event will be dropped. We log a warning in that case. refs: #3
2021-09-23 18:21:15 +03:00
# `bell`
docs: update nightly refs to new release tag
2021-12-04 18:32:21 +03:00
*Since: 20211204-082213-a66c61ee9*
gui: new bell event for running lua when the bell is rung This commit adjusts the the window event routing/queuing so that a queued event can capture a pane_id other than the focused pane. Since we only allow one queued instance of a given named event in a window, a consequence of this is that multiple bell events coming from different panes at the same time may race and the loser's event will be dropped. We log a warning in that case. refs: #3
2021-09-23 18:21:15 +03:00
The `bell` event is emitted when the ASCII BEL sequence is emitted to
a pane in the window.
Defining an event handler doesn't alter wezterm's handling of the bell;
the event supplements it and allows you to take additional action over
the configured behavior.
The first event parameter is a [`window` object](../window/index.md) that
represents the gui window.
The second event parameter is a [`pane` object](../pane/index.md) that
represents the pane in which the bell was rung, which may not be active
pane--it could be in an unfocused pane or tab..
```lua
docs: apply stylua formatting refs: https://github.com/wez/wezterm/pull/2273 refs: https://github.com/wez/wezterm/issues/2253
2022-07-19 17:54:31 +03:00
local wezterm = require 'wezterm'
gui: new bell event for running lua when the bell is rung This commit adjusts the the window event routing/queuing so that a queued event can capture a pane_id other than the focused pane. Since we only allow one queued instance of a given named event in a window, a consequence of this is that multiple bell events coming from different panes at the same time may race and the loser's event will be dropped. We log a warning in that case. refs: #3
2021-09-23 18:21:15 +03:00
docs: apply stylua formatting refs: https://github.com/wez/wezterm/pull/2273 refs: https://github.com/wez/wezterm/issues/2253
2022-07-19 17:54:31 +03:00
wezterm.on('bell', function(window, pane)
wezterm.log_info('the bell was rung in pane ' .. pane:pane_id() .. '!')
gui: new bell event for running lua when the bell is rung This commit adjusts the the window event routing/queuing so that a queued event can capture a pane_id other than the focused pane. Since we only allow one queued instance of a given named event in a window, a consequence of this is that multiple bell events coming from different panes at the same time may race and the loser's event will be dropped. We log a warning in that case. refs: #3
2021-09-23 18:21:15 +03:00
end)
return {}
```
docs: cross link the bell related configs refs: #3
2021-09-27 05:01:58 +03:00
See also [audible_bell](../config/audible_bell.md) and [visual_bell](../config/visual_bell.md).
Reference in New Issue Copy Permalink