aboutsummaryrefslogtreecommitdiffhomepage
path: root/core/.view.luadoc
diff options
context:
space:
mode:
authorGravatar mitchell <70453897+667e-11@users.noreply.github.com>2020-06-09 14:41:28 -0400
committerGravatar mitchell <70453897+667e-11@users.noreply.github.com>2020-06-09 14:41:28 -0400
commit1702ce40cbcbfe53d9b57f3e9cde8ecfc441800a (patch)
tree98d3045b5e163a3755d9b48e16b3f4b63b1e04e1 /core/.view.luadoc
parentada6a867c87be0ed746cdb94c28ff24f8288280c (diff)
Prefer `view.call_tip_*` instead of `buffer.call_tip_*`.
Diffstat (limited to 'core/.view.luadoc')
-rw-r--r--core/.view.luadoc30
1 files changed, 30 insertions, 0 deletions
diff --git a/core/.view.luadoc b/core/.view.luadoc
index 29c902c2..4d0cceb3 100644
--- a/core/.view.luadoc
+++ b/core/.view.luadoc
@@ -58,6 +58,8 @@
-- longest item.
-- @field call_tip_fore_hlt (number, Write-only)
-- A call tip's highlighted text foreground color, in "0xBBGGRR" format.
+-- @field call_tip_pos_start (number, Write-only)
+-- The position in which backspacing beyond it hides a visible call tip.
-- @field call_tip_position (boolean)
-- Display a call tip above the current line instead of below it.
-- The default value is `false`.
@@ -967,6 +969,23 @@ function brace_highlight(view, pos1, pos2) end
function brace_highlight_indicator(view, use_indicator, indicator) end
---
+-- Returns whether or not a call tip is visible.
+-- @param view A view.
+-- @return bool
+function call_tip_active(view) end
+
+---
+-- Removes a call tip from view.
+-- @param view A view.
+function call_tip_cancel(view) end
+
+---
+-- Returns a call tip's display position.
+-- @param view A view.
+-- @return number
+function call_tip_pos_start(view) end
+
+---
-- Highlights a call tip's text between positions *start_pos* to *end_pos* with
-- the color `view.call_tip_fore_hlt`.
-- @param view A view.
@@ -975,6 +994,17 @@ function brace_highlight_indicator(view, use_indicator, indicator) end
function call_tip_set_hlt(view, start_pos, end_pos) end
---
+-- Displays a call tip at position *pos* with string *text* as the call tip's
+-- contents.
+-- Any "\001" or "\002" bytes in *text* are replaced by clickable up or down
+-- arrow visuals, respectively. These may be used to indicate that a symbol has
+-- more than one call tip, for example.
+-- @param view A view.
+-- @param pos The position in *view*'s buffer to show a call tip at.
+-- @param text The call tip text to show.
+function call_tip_show(view, pos, text) end
+
+---
-- Clears all images registered using `view.register_image()` and
-- `view.register_rgba_image()`.
-- @param view A view.