diff options
author | mitchell <70453897+orbitalquark@users.noreply.github.com> | 2021-04-30 18:40:06 -0400 |
---|---|---|
committer | mitchell <70453897+orbitalquark@users.noreply.github.com> | 2021-04-30 18:40:06 -0400 |
commit | 715901363a02634f5336c0d3f18cbd9a9c080b4a (patch) | |
tree | 315146ace595595cefe4e6b4eae01c475a21a85b /docs | |
parent | a775e9fb4188f2638111c15623ea9bd5c804b3e2 (diff) |
Replaced `events.FILE_{BEFORE,AFTER}_RELOAD` with `events.BUFFER_{BEFORE,AFTER}_REPLACE_TEXT`.
This allows more features to save/restore state when buffer contents are replaced (e.g. file
reload, filter through, etc.)
Diffstat (limited to 'docs')
-rw-r--r-- | docs/api.md | 29 | ||||
-rw-r--r-- | docs/changelog.md | 6 | ||||
-rw-r--r-- | docs/manual.md | 6 |
3 files changed, 20 insertions, 21 deletions
diff --git a/docs/api.md b/docs/api.md index 61d61dbe..c73bdf7a 100644 --- a/docs/api.md +++ b/docs/api.md @@ -2933,7 +2933,6 @@ Parameters: #### `buffer.reload`(*buffer*) Reloads the buffer's file contents, discarding any changes. -Emits `FILE_BEFORE_RELOAD` and `FILE_AFTER_RELOAD` events if the buffer is the current one. Parameters: @@ -3711,6 +3710,14 @@ Emitted as items are highlighted in an autocompletion or user list. * _`text`_: The current selection's text. * _`position`_: The position the list was displayed at. +<a id="events.BUFFER_AFTER_REPLACE_TEXT"></a> +#### `events.BUFFER_AFTER_REPLACE_TEXT` (string) + +Emitted after replacing the contents of the current buffer. + Note that it is not guaranteed that [`events.BUFFER_BEFORE_REPLACE_TEXT`](#events.BUFFER_BEFORE_REPLACE_TEXT) was emitted + previously. + The buffer **must not** be modified during this event. + <a id="events.BUFFER_AFTER_SWITCH"></a> #### `events.BUFFER_AFTER_SWITCH` (string) @@ -3718,6 +3725,14 @@ Emitted right after switching to another buffer. The buffer being switched to is `buffer`. Emitted by [`view.goto_buffer()`](#view.goto_buffer). +<a id="events.BUFFER_BEFORE_REPLACE_TEXT"></a> +#### `events.BUFFER_BEFORE_REPLACE_TEXT` (string) + +Emitted before replacing the contents of the current buffer. + Note that it is not guaranteed that [`events.BUFFER_AFTER_REPLACE_TEXT`](#events.BUFFER_AFTER_REPLACE_TEXT) will be emitted + shortly after this event. + The buffer **must not** be modified during this event. + <a id="events.BUFFER_BEFORE_SWITCH"></a> #### `events.BUFFER_BEFORE_SWITCH` (string) @@ -4139,12 +4154,6 @@ Extends Lua's `io` library with Textadept functions for working with files. ### Fields defined by `io` -<a id="events.FILE_AFTER_RELOAD"></a> -#### `events.FILE_AFTER_RELOAD` (string) - -Emitted after reloading the current file. - Emitted by [`buffer:reload()`](#buffer.reload). - <a id="events.FILE_AFTER_SAVE"></a> #### `events.FILE_AFTER_SAVE` (string) @@ -4155,12 +4164,6 @@ Emitted right after saving a file to disk. * _`filename`_: The filename of the file being saved. * _`saved_as`_: Whether or not the file was saved under a different filename. -<a id="events.FILE_BEFORE_RELOAD"></a> -#### `events.FILE_BEFORE_RELOAD` (string) - -Emitted before reloading the current file. - Emitted by [`buffer:reload()`](#buffer.reload). - <a id="events.FILE_BEFORE_SAVE"></a> #### `events.FILE_BEFORE_SAVE` (string) diff --git a/docs/changelog.md b/docs/changelog.md index b533f394..346a487a 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -221,8 +221,8 @@ Changes: * Added support for jq language. * Record directory in "Find in Files" searches. * Added `ui.update()`, mainly for unit tests. -* Added [`events.FILE_BEFORE_RELOAD`][] and [`events.FILE_AFTER_RELOAD`][] events, and - save/restore bookmarks. +* Added `events.FILE_BEFORE_RELOAD` and `events.FILE_AFTER_RELOAD` events, and save/restore + bookmarks. * Added [`events.COMMAND_TEXT_CHANGED`][] for when command entry text changes. * Added `_NOCOMPAT` option to disable temporary key shortcut compatibility checking. * Updated Spanish translation. @@ -240,8 +240,6 @@ Changes: [building with Docker]: manual.html#compiling-using-docker [`events.FIND_RESULT_FOUND`]: api.html#events.FIND_RESULT_FOUND [`ui.find.active`]: api.html#ui.find.active -[`events.FILE_BEFORE_RELOAD`]: api.html#events.FILE_BEFORE_RELOAD -[`events.FILE_AFTER_RELOAD`]: api.html#events.FILE_AFTER_RELOAD [`events.COMMAND_TEXT_CHANGED`]: api.html#events.COMMAND_TEXT_CHANGED [`view.multi_edge_column`]: api.html#view.multi_edge_column [Scintilla]: https://scintilla.org diff --git a/docs/manual.md b/docs/manual.md index 52e8fd6d..8036d184 100644 --- a/docs/manual.md +++ b/docs/manual.md @@ -1718,8 +1718,8 @@ vertical\_centre\_caret | Renamed | vertical\_center\_caret **events**|| AUTO\_C\_CANCELLED | Renamed | AUTO\_C\_CANCELED N/A | Added | [COMMAND_TEXT_CHANGED][] -N/A | Added | [FILE_BEFORE_RELOAD][] -N/A | Added | [FILE_AFTER_RELOAD][] +N/A | Added | FILE_BEFORE_RELOAD +N/A | Added | FILE_AFTER_RELOAD N/A | Added | [FIND_RESULT_FOUND][] N/A | Added | [FIND_TEXT_CHANGED][] N/A | Added | [SESSION_SAVE][] @@ -1784,8 +1784,6 @@ N/A | Added | _buffer functions and fields_<sup>d</sup> [view:set_theme()]: api.html#view.set_theme [name_of_style]: api.html#buffer.name_of_style [COMMAND_TEXT_CHANGED]: api.html#events.COMMAND_TEXT_CHANGED -[FILE_BEFORE_RELOAD]: api.html#events.FILE_BEFORE_RELOAD -[FILE_AFTER_RELOAD]: api.html#events.FILE_AFTER_RELOAD [FIND_RESULT_FOUND]: api.html#events.FIND_RESULT_FOUND [FIND_TEXT_CHANGED]: api.html#events.FIND_TEXT_CHANGED [SESSION_SAVE]: api.html#events.SESSION_SAVE |