From 5f29cb8190dbee6bb10b4eb904c8c39750de352d Mon Sep 17 00:00:00 2001
From: mitchell <70453897+667e-11@users.noreply.github.com>
Date: Tue, 23 Nov 2010 19:09:21 -0500
Subject: Code cleanup. Also modified the editing module's enclose() and
 select_enclosed() functions.

---
 core/.find.luadoc | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

(limited to 'core/.find.luadoc')

diff --git a/core/.find.luadoc b/core/.find.luadoc
index e47eafd9..038d3943 100644
--- a/core/.find.luadoc
+++ b/core/.find.luadoc
@@ -47,6 +47,23 @@ module('gui.find')
 -- names of `textadept-find-entry` and `textadept-replace-entry` respectively.
 --
 -- [gtkrc]: http://library.gnome.org/devel/gtk/unstable/gtk-Resource-Files.html.
+--
+-- ## Events
+--
+-- The following is a list of all find events generated in
+-- `event_name(arguments)` format:
+--
+-- * **find** (text, next)<br />
+--   Called when attempting to finding text via the Find dialog box.
+--       - text: the text to search for.
+--       - next: flat indicating whether or not the search direction is forward.
+-- * **replace** (text)<br />
+--   Called when the found text is selected and asked to be replaced.
+--       - text: the text to replace the selected text with.
+-- * **replace\_all** (find\_text, repl\_text)<br />
+--   Called when all occurances of found text are to be replaced.
+--       - find\_text: the text to search for.
+--       - repl\_text: the text to replace found text with.
 
 --- Displays and focuses the find/replace dialog.
 function focus() end
-- 
cgit v1.2.3