summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPatrick Totzke <patricktotzke@gmail.com>2013-02-17 22:38:07 +0000
committerPatrick Totzke <patricktotzke@gmail.com>2013-02-19 18:50:05 +0000
commit99a793e2d015c5cd890e40263522d0ec42a54e3a (patch)
treec54676882d72e79661825df9b47cd7b8bb21c2d0 /docs
parent4cafce43e910c676bed6cf829fd0dc9cb9bfd14c (diff)
document new hooks
Diffstat (limited to 'docs')
-rw-r--r--docs/source/configuration/hooks.rst45
1 files changed, 45 insertions, 0 deletions
diff --git a/docs/source/configuration/hooks.rst b/docs/source/configuration/hooks.rst
index 40b46271..90b4fc30 100644
--- a/docs/source/configuration/hooks.rst
+++ b/docs/source/configuration/hooks.rst
@@ -123,3 +123,48 @@ Apart from command pre- and posthooks, the following hooks will be interpreted:
:type subject: str
:rtype: str
+.. py:function:: pre_buffer_open(ui= None, dbm=None, buf=buf)
+
+ run before a new buffer is opened
+
+ :param buf: buffer to open
+ :type buf: alot.buffer.Buffer
+
+.. py:function:: post_buffer_open(ui=None, dbm=None, buf=buf)
+
+ run after a new buffer is opened
+
+ :param buf: buffer to open
+ :type buf: alot.buffer.Buffer
+
+.. py:function:: pre_buffer_close(ui=None, dbm=None, buf=buf)
+
+ run before a buffer is closed
+
+ :param buf: buffer to open
+ :type buf: alot.buffer.Buffer
+
+.. py:function:: post_buffer_close(ui=None, dbm=None, buf=buf, success=success)
+
+ run after a buffer is closed
+
+ :param buf: buffer to open
+ :type buf: alot.buffer.Buffer
+ :param success: true if successfully closed buffer
+ :type success: boolean
+
+.. py:function:: pre_buffer_focus(ui=None, dbm=None, buf=buf)
+
+ run before a buffer is focused
+
+ :param buf: buffer to open
+ :type buf: alot.buffer.Buffer
+
+.. py:function:: post_buffer_focus(ui=None, dbm=None, buf=buf, success=success)
+
+ run after a buffer is focused
+
+ :param buf: buffer to open
+ :type buf: alot.buffer.Buffer
+ :param success: true if successfully focused buffer
+ :type success: boolean