aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMarc André Tanner <mat@brain-dump.org>2016-11-22 00:15:32 +0100
committerMarc André Tanner <mat@brain-dump.org>2016-11-22 14:59:05 +0100
commit0791cac97ee689195e593cfca89c0b63fb721479 (patch)
tree57166b070b0f7a23ea2a8a1d223136801c0e99c8 /README.md
parentf555c00e0b0be14cd553c7c803d6136b86f2012b (diff)
downloadvis-0791cac97ee689195e593cfca89c0b63fb721479.tar.gz
vis-0791cac97ee689195e593cfca89c0b63fb721479.tar.xz
vis-lua: introduce pre-save hook
The first argument is the file object while the second argument denotes the full path to which it will be written. Path might be `nil` if the file is going to be written to stdout. The Lua function is expected to return a boolean value indicating whether the write operation should proceed or be aborted.
Diffstat (limited to 'README.md')
-rw-r--r--README.md1
1 files changed, 1 insertions, 0 deletions
diff --git a/README.md b/README.md
index 608e1c5..f8d7a99 100644
--- a/README.md
+++ b/README.md
@@ -590,6 +590,7 @@ At this time there exists no API stability guarantees.
- `start()`
- `quit()`
- `file_open(file)`
+ - `file_save_pre(file, path)` triggered *before* an attempted write to `path` boolean return value determines whether write will be proceeded
- `file_save_post(file, path)` triggered *after* a successfull write to `path`
- `file_close(file)`
- `win_open(win)`