xenia/home
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Describe which Win* hooks use a draft context.

Browse Source 
Also, rewrote the description of WinDisplay since it wasn't obvious to me what
"bound" meant in this context.
This commit is contained in:
Tim Allen 2018-09-11 20:56:12 +10:00
parent d57203f41f
commit f7d8f7a9e1
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/pages/hooks.asciidoc
View File

@ -73,19 +73,23 @@ Hooks declared with the `-once` switch are automatically removed after running.
a certain duration has passed since last key was pressed in prompt mode a certain duration has passed since last key was pressed in prompt mode
*WinCreate* `buffer name`:: *WinCreate* `buffer name`::
a window was created a window was created. This hook is executed in draft context, so any a
changes to selections or input state will be discarded.
*WinClose* `buffer name`:: *WinClose* `buffer name`::
a window was destroyed a window was destroyed. This hook is executed in a draft context, so any
changes to selections or input state will be discarded.
*WinResize* `<line>.<column>`:: *WinResize* `<line>.<column>`::
a window was resized a window was resized. This hook is executed in a draft context, so any
changes to selections or input state will be discarded.
*WinDisplay* `buffer name`:: *WinDisplay* `buffer name`::
a window was bound a client a client switched to displaying the given buffer.
*WinSetOption* `<option_name>=<new_value>`:: *WinSetOption* `<option_name>=<new_value>`::
an option was set in a window context an option was set in a window context. This hook is executed in a draft
acontext, so any changes to selections or input state will be discarded.
*GlobalSetOption* `<option_name>=<new_value>`:: *GlobalSetOption* `<option_name>=<new_value>`::
an option was set at the global scope an option was set at the global scope