diff options
Diffstat (limited to 'elpa/evil-1.15.0/doc/source/hooks.rst')
| -rw-r--r-- | elpa/evil-1.15.0/doc/source/hooks.rst | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/elpa/evil-1.15.0/doc/source/hooks.rst b/elpa/evil-1.15.0/doc/source/hooks.rst new file mode 100644 index 0000000..28ade72 --- /dev/null +++ b/elpa/evil-1.15.0/doc/source/hooks.rst @@ -0,0 +1,16 @@ +Hooks +===== + +A *hook* is a list of functions that are executed when certain events +happen. Hooks are modified with the Emacs function ``add-hook``. +Evil provides entry and exit hooks for all its states. For example, +when switching from normal state to insert state, all functions in +``evil-normal-state-exit-hook`` and ``evil-insert-state-entry-hook`` +are executed. + +It is guaranteed that the exit hook will be executed before the entry +hook on all state switches. + +During the hook execution, the variables ``evil-next-state`` and +``evil-previous-state`` contain information about the states being +switched to and from, respectively. |