ui_events.in.h
Go to the documentation of this file.
1 #ifndef NVIM_API_UI_EVENTS_IN_H
2 #define NVIM_API_UI_EVENTS_IN_H
3 
4 // This file is not compiled, just parsed for definitions
5 #ifdef INCLUDE_GENERATED_DECLARATIONS
6 # error "don't include this file, include nvim/ui.h"
7 #endif
8 
10 #include "nvim/func_attr.h"
11 #include "nvim/ui.h"
12 
13 void mode_info_set(Boolean enabled, Array cursor_styles)
14  FUNC_API_SINCE(3);
15 void update_menu(void)
16  FUNC_API_SINCE(3);
17 void busy_start(void)
18  FUNC_API_SINCE(3);
19 void busy_stop(void)
20  FUNC_API_SINCE(3);
21 void mouse_on(void)
22  FUNC_API_SINCE(3);
23 void mouse_off(void)
24  FUNC_API_SINCE(3);
25 void mode_change(String mode, Integer mode_idx)
26  FUNC_API_SINCE(3);
27 void bell(void)
28  FUNC_API_SINCE(3);
29 void visual_bell(void)
30  FUNC_API_SINCE(3);
31 void flush(void)
32  FUNC_API_SINCE(3) FUNC_API_REMOTE_IMPL;
33 void suspend(void)
34  FUNC_API_SINCE(3) FUNC_API_BRIDGE_IMPL;
36  FUNC_API_SINCE(3);
37 void set_icon(String icon)
38  FUNC_API_SINCE(3);
39 void screenshot(String path)
40  FUNC_API_SINCE(7) FUNC_API_REMOTE_IMPL;
41 void option_set(String name, Object value)
42  FUNC_API_SINCE(4) FUNC_API_BRIDGE_IMPL;
43 // Stop event is not exported as such, represented by EOF in the msgpack stream.
44 void stop(void)
45  FUNC_API_NOEXPORT;
46 
47 // First revision of the grid protocol, used by default
48 void update_fg(Integer fg)
49  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
50 void update_bg(Integer bg)
51  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
52 void update_sp(Integer sp)
53  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
54 void resize(Integer width, Integer height)
55  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
56 void clear(void)
57  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
58 void eol_clear(void)
59  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
60 void cursor_goto(Integer row, Integer col)
61  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
62 void highlight_set(HlAttrs attrs)
63  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY FUNC_API_REMOTE_IMPL;
64 void put(String str)
65  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
66 void set_scroll_region(Integer top, Integer bot, Integer left, Integer right)
67  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
68 void scroll(Integer count)
69  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
70 
71 // Second revision of the grid protocol, used with ext_linegrid ui option
72 void default_colors_set(Integer rgb_fg, Integer rgb_bg, Integer rgb_sp,
73  Integer cterm_fg, Integer cterm_bg)
74  FUNC_API_SINCE(4) FUNC_API_REMOTE_IMPL;
75 void hl_attr_define(Integer id, HlAttrs rgb_attrs, HlAttrs cterm_attrs,
76  Array info)
77  FUNC_API_SINCE(5) FUNC_API_REMOTE_IMPL FUNC_API_BRIDGE_IMPL;
79  FUNC_API_SINCE(6) FUNC_API_BRIDGE_IMPL;
80 void grid_resize(Integer grid, Integer width, Integer height)
81  FUNC_API_SINCE(5) FUNC_API_REMOTE_IMPL FUNC_API_COMPOSITOR_IMPL;
82 void grid_clear(Integer grid)
83  FUNC_API_SINCE(5) FUNC_API_REMOTE_IMPL;
85  FUNC_API_SINCE(5) FUNC_API_REMOTE_IMPL FUNC_API_COMPOSITOR_IMPL;
86 void grid_line(Integer grid, Integer row, Integer col_start, Array data)
87  FUNC_API_SINCE(5) FUNC_API_REMOTE_ONLY;
88 void grid_scroll(Integer grid, Integer top, Integer bot,
89  Integer left, Integer right, Integer rows, Integer cols)
90  FUNC_API_SINCE(5) FUNC_API_REMOTE_IMPL FUNC_API_COMPOSITOR_IMPL;
91 void grid_destroy(Integer grid)
92  FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
93 
94 // For performance and simplicity, we use the dense screen representation
95 // in internal code, such as compositor and TUI. The remote_ui module will
96 // translate this in to the public grid_line format.
97 void raw_line(Integer grid, Integer row, Integer startcol,
98  Integer endcol, Integer clearcol, Integer clearattr,
99  LineFlags flags, const schar_T *chunk, const sattr_T *attrs)
100  FUNC_API_NOEXPORT FUNC_API_COMPOSITOR_IMPL;
101 
102 void event(char *name, Array args, bool *args_consumed)
103  FUNC_API_NOEXPORT;
104 
105 void win_pos(Integer grid, Window win, Integer startrow,
106  Integer startcol, Integer width, Integer height)
107  FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
108 void win_float_pos(Integer grid, Window win, String anchor, Integer anchor_grid,
109  Float anchor_row, Float anchor_col, Boolean focusable,
110  Integer zindex)
111  FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
112 void win_external_pos(Integer grid, Window win)
113  FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
114 void win_hide(Integer grid)
115  FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
116 void win_close(Integer grid)
117  FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
118 void msg_set_pos(Integer grid, Integer row, Boolean scrolled, String sep_char)
119  FUNC_API_SINCE(6) FUNC_API_BRIDGE_IMPL FUNC_API_COMPOSITOR_IMPL;
120 
121 void win_viewport(Integer grid, Window win, Integer topline,
122  Integer botline, Integer curline, Integer curcol,
123  Integer line_count)
124  FUNC_API_SINCE(7) FUNC_API_REMOTE_ONLY;
125 
126 void popupmenu_show(Array items, Integer selected,
127  Integer row, Integer col, Integer grid)
128  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
129 void popupmenu_hide(void)
130  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
131 void popupmenu_select(Integer selected)
132  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
133 
134 void tabline_update(Tabpage current, Array tabs,
135  Buffer current_buffer, Array buffers)
136  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
137 
138 void cmdline_show(Array content, Integer pos, String firstc, String prompt,
139  Integer indent, Integer level)
140  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
142  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
144  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
146  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
147 void cmdline_block_show(Array lines)
148  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
149 void cmdline_block_append(Array lines)
150  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
151 void cmdline_block_hide(void)
152  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
153 
154 void wildmenu_show(Array items)
155  FUNC_API_SINCE(3) FUNC_API_REMOTE_IMPL FUNC_API_BRIDGE_IMPL;
156 void wildmenu_select(Integer selected)
157  FUNC_API_SINCE(3) FUNC_API_REMOTE_IMPL FUNC_API_BRIDGE_IMPL;
158 void wildmenu_hide(void)
159  FUNC_API_SINCE(3) FUNC_API_REMOTE_IMPL FUNC_API_BRIDGE_IMPL;
160 
161 void msg_show(String kind, Array content, Boolean replace_last)
162  FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
163 void msg_clear(void)
164  FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
165 void msg_showcmd(Array content)
166  FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
167 void msg_showmode(Array content)
168  FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
169 void msg_ruler(Array content)
170  FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
171 void msg_history_show(Array entries)
172  FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
173 #endif // NVIM_API_UI_EVENTS_IN_H
scroll
void scroll(Integer count) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
update_fg
void update_fg(Integer fg) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
ui.h
put
void put(String str) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
object
Definition: defs.h:115
attr_entry
Definition: highlight_defs.h:31
grid_resize
void grid_resize(Integer grid, Integer width, Integer height) FUNC_API_SINCE(5) FUNC_API_REMOTE_IMPL FUNC_API_COMPOSITOR_IMPL
option_set
void option_set(String name, Object value) FUNC_API_SINCE(4) FUNC_API_BRIDGE_IMPL
stop
void stop(void) FUNC_API_NOEXPORT
cursor_goto
void cursor_goto(Integer row, Integer col) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
col
col
Definition: normal.c:3247
resize
void resize(Integer width, Integer height) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
highlight_set
void highlight_set(HlAttrs attrs) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY FUNC_API_REMOTE_IMPL
raw_line
void raw_line(Integer grid, Integer row, Integer startcol, Integer endcol, Integer clearcol, Integer clearattr, LineFlags flags, const schar_T *chunk, const sattr_T *attrs) FUNC_API_NOEXPORT FUNC_API_COMPOSITOR_IMPL
cmdline_special_char
void cmdline_special_char(String c, Boolean shift, Integer level) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
update_bg
void update_bg(Integer bg) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
Boolean
bool Boolean
Definition: defs.h:67
level
fc level
Definition: userfunc.c:853
win_external_pos
void win_external_pos(Integer grid, Window win) FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY
set_scroll_region
void set_scroll_region(Integer top, Integer bot, Integer left, Integer right) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
cmdline_block_show
void cmdline_block_show(Array lines) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
Float
double Float
Definition: defs.h:69
msg_ruler
void msg_ruler(Array content) FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY
hl_group_set
void hl_group_set(String name, Integer id) FUNC_API_SINCE(6) FUNC_API_BRIDGE_IMPL
cmdline_block_append
void cmdline_block_append(Array lines) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
update_sp
void update_sp(Integer sp) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
visual_bell
void visual_bell(void) FUNC_API_SINCE(3)
msg_showcmd
void msg_showcmd(Array content) FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY
Array
Definition: defs.h:88
sattr_T
int sattr_T
Definition: grid_defs.h:14
popupmenu_hide
void popupmenu_hide(void) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
defs.h
clear
void clear(void) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
pos
pos_T pos
Definition: funcs.c:8557
msg_history_show
void msg_history_show(Array entries) FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY
mode_change
void mode_change(String mode, Integer mode_idx) FUNC_API_SINCE(3)
suspend
void suspend(void) FUNC_API_SINCE(3) FUNC_API_BRIDGE_IMPL
grid_scroll
void grid_scroll(Integer grid, Integer top, Integer bot, Integer left, Integer right, Integer rows, Integer cols) FUNC_API_SINCE(5) FUNC_API_REMOTE_IMPL FUNC_API_COMPOSITOR_IMPL
msg_show
void msg_show(String kind, Array content, Boolean replace_last) FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY
update_menu
void update_menu(void) FUNC_API_SINCE(3)
Integer
int64_t Integer
Definition: defs.h:68
screenshot
void screenshot(String path) FUNC_API_SINCE(7) FUNC_API_REMOTE_IMPL
startcol
startcol
Definition: normal.c:3246
busy_start
void busy_start(void) FUNC_API_SINCE(3)
set_title
void set_title(String title) FUNC_API_SINCE(3)
count
int count
Definition: regexp_nfa.c:4366
cmdline_pos
void cmdline_pos(Integer pos, Integer level) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
win_hide
void win_hide(Integer grid) FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY
mouse_on
void mouse_on(void) FUNC_API_SINCE(3)
wildmenu_hide
void wildmenu_hide(void) FUNC_API_SINCE(3) FUNC_API_REMOTE_IMPL FUNC_API_BRIDGE_IMPL
String
Definition: defs.h:77
wildmenu_select
void wildmenu_select(Integer selected) FUNC_API_SINCE(3) FUNC_API_REMOTE_IMPL FUNC_API_BRIDGE_IMPL
cmdline_show
void cmdline_show(Array content, Integer pos, String firstc, String prompt, Integer indent, Integer level) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
grid_line
void grid_line(Integer grid, Integer row, Integer col_start, Array data) FUNC_API_SINCE(5) FUNC_API_REMOTE_ONLY
schar_T
char_u schar_T[(MAX_MCO+1) *4+1]
Definition: grid_defs.h:13
LineFlags
int LineFlags
Definition: ui.h:47
msg_clear
void msg_clear(void) FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY
popupmenu_show
void popupmenu_show(Array items, Integer selected, Integer row, Integer col, Integer grid) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
mouse_off
void mouse_off(void) FUNC_API_SINCE(3)
busy_stop
void busy_stop(void) FUNC_API_SINCE(3)
eol_clear
void eol_clear(void) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
win_close
void win_close(Integer grid) FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY
cmdline_hide
void cmdline_hide(Integer level) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
bell
void bell(void) FUNC_API_SINCE(3)
grid_clear
void grid_clear(Integer grid) FUNC_API_SINCE(5) FUNC_API_REMOTE_IMPL
tabline_update
void tabline_update(Tabpage current, Array tabs, Buffer current_buffer, Array buffers) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
name
char_u * name
Definition: userfunc.c:821
title
static void const char * title
Definition: funcs.c:8985
win_pos
void win_pos(Integer grid, Window win, Integer startrow, Integer startcol, Integer width, Integer height) FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY
popupmenu_select
void popupmenu_select(Integer selected) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
flush
void flush(void) FUNC_API_SINCE(3) FUNC_API_REMOTE_IMPL
event
void event(char *name, Array args, bool *args_consumed) FUNC_API_NOEXPORT
set_icon
void set_icon(String icon) FUNC_API_SINCE(3)
grid_destroy
void grid_destroy(Integer grid) FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY
cmdline_block_hide
void cmdline_block_hide(void) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
default_colors_set
void default_colors_set(Integer rgb_fg, Integer rgb_bg, Integer rgb_sp, Integer cterm_fg, Integer cterm_bg) FUNC_API_SINCE(4) FUNC_API_REMOTE_IMPL
grid_cursor_goto
void grid_cursor_goto(Integer grid, Integer row, Integer col) FUNC_API_SINCE(5) FUNC_API_REMOTE_IMPL FUNC_API_COMPOSITOR_IMPL
func_attr.h
msg_showmode
void msg_showmode(Array content) FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY
hl_attr_define
void hl_attr_define(Integer id, HlAttrs rgb_attrs, HlAttrs cterm_attrs, Array info) FUNC_API_SINCE(5) FUNC_API_REMOTE_IMPL FUNC_API_BRIDGE_IMPL
win_float_pos
void win_float_pos(Integer grid, Window win, String anchor, Integer anchor_grid, Float anchor_row, Float anchor_col, Boolean focusable, Integer zindex) FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY
args
va_list args
Definition: log.c:149
msg_set_pos
void msg_set_pos(Integer grid, Integer row, Boolean scrolled, String sep_char) FUNC_API_SINCE(6) FUNC_API_BRIDGE_IMPL FUNC_API_COMPOSITOR_IMPL
mode_info_set
void mode_info_set(Boolean enabled, Array cursor_styles) FUNC_API_SINCE(3)
wildmenu_show
void wildmenu_show(Array items) FUNC_API_SINCE(3) FUNC_API_REMOTE_IMPL FUNC_API_BRIDGE_IMPL
win_viewport
void win_viewport(Integer grid, Window win, Integer topline, Integer botline, Integer curline, Integer curcol, Integer line_count) FUNC_API_SINCE(7) FUNC_API_REMOTE_ONLY