diff options
Diffstat (limited to 'core/.find.lua')
| -rw-r--r-- | core/.find.lua | 61 |
1 files changed, 30 insertions, 31 deletions
diff --git a/core/.find.lua b/core/.find.lua index a773f603..cf64a1e5 100644 --- a/core/.find.lua +++ b/core/.find.lua @@ -4,14 +4,30 @@ --- -- Textadept's integrated find/replace dialog. --- [Dummy file] module('textadept.find') --- Usage: +-- Markdown: +-- ## Fields +-- +-- * `find_entry_text`: The text in the find entry. +-- * `replace_entry_text`: The text in the replace entry. +-- * `match_case`: Flag indicating whether or not case-sensitive search is +-- performed. +-- * `whole_word`: Flag indicating whether or not only whole-word matches are +-- allowed in searches. +-- * `lua`: Flag indicating whether or not the text to find in a search is a Lua +-- pattern. +-- * `in_files`: Flag indicating whether or not to search for the text in a list +-- of files. +-- +-- ## Overview +-- -- In addition to offering standard find and replace, Textadept allows you to --- find with Lua patterns and replace with Lua captures and even Lua code! Lua --- captures (%n) are available for a Lua pattern search and embedded Lua code --- enclosed in %() is always available. +-- find with [Lua patterns][lua_patterns] and replace with Lua captures and even +-- Lua code! Lua captures (`%n`) are only available from a Lua pattern search, +-- but embedded Lua code enclosed in `%()` is always available. +-- +-- [lua_patterns]: http://www.lua.org/manual/5.1/manual.html#5.4.1 -- -- If any block of text is selected for 'Replace All', only matches found in -- that block are replaced. @@ -22,32 +38,15 @@ module('textadept.find') -- Files first, and then 'Replace All' for each file a result is found in. -- The 'Match Case', 'Whole Word', and 'Lua pattern' flags still apply. -- --- Customizing look and feel: --- Like the project manager, there are no function calls to make that --- customize the look and feel of the find dialog. Instead you can manipulate --- it via GTK rc files. The find and replace entries widget names of --- 'textadept-find-entry' and 'textadept-replace-entry' respectively. --- Resource file documentation can be found at --- http://library.gnome.org/devel/gtk/unstable/gtk-Resource-Files.html. - ---- --- Textadept's find table. --- @class table --- @name find --- @field find_entry_text The text in the find entry. --- @field replace_entry_text The text in the replace entry. --- @field match_case Flag indicating whether or not case-sensitive search is --- performed. --- @field whole_word Flag indicating whether or not only whole-word matches are --- allowed in searches. --- @field lua Flag indicating whether or not the text to find in a search is a --- Lua pattern. --- @field in_files Flag indicating whether or not to search for the text in a --- list of files. -find = { - find_entry_text = nil, replace_entry_text = nil, - match_case = nil, whole_word = nil, lua = nil, in_files = nil -} +-- Incremental search uses the Command Entry. +-- +-- ## Customizing Look and Feel +-- +-- There is no way to theme the dialog from within Textadept. Instead you can +-- use [GTK Resource files][gtkrc]. The find and replace entries have widget +-- names of `textadept-find-entry` and `textadept-replace-entry` respectively. +-- +-- [gtkrc]: http://library.gnome.org/devel/gtk/unstable/gtk-Resource-Files.html. --- Displays and focuses the find/replace dialog. function focus() end |