Changes between Version 6 and Version 7 of PluginAPI/Padre_Hooks

Timestamp:

03/20/11 14:49:04 (2 years ago)

Author:

Sewi

Comment:

--

PluginAPI/Padre_Hooks

@@ -18 +18 @@
 Note2: The usage samples should give you a hint how a hook could be used. They may not be useful for other cases (like svn auto-commit).
 
+== before_delete ==
+
+|| Arguments || Padre::File object being deleted ||
+|| Return value || undef or text ||
+|| Called || before any file is removed from disk ||
+|| Usage Example || protect important files from deletion ||
+
+This hook should return undef if everything is ok. Any returned text is treated as an error message and shown to the user. The deletion process is stopped on the first hook returning an error message.
+Return an empty, but defined string will about delete but not show any error, use this only to override Padre's internal delete!
+
+== after_delete ==
+
+|| Arguments || Deleted Padre::File object ||
+|| Return value || ignored ||
+|| Called || after any file has been removed from disk ||
+|| Usage Example || svn delete ||
+
+Notice: The file is already gone! The Padre::File object given as argument may do unusual things like returning a caches size even if the file doesn't exist any longer.
+
 == before_save ==