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 definitons
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 option_set(String name, Object value)
40  FUNC_API_SINCE(4) FUNC_API_BRIDGE_IMPL;
41 // Stop event is not exported as such, represented by EOF in the msgpack stream.
42 void stop(void)
43  FUNC_API_NOEXPORT;
44 
45 // First revison of the grid protocol, used by default
46 void update_fg(Integer fg)
47  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
48 void update_bg(Integer bg)
49  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
50 void update_sp(Integer sp)
51  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
52 void resize(Integer width, Integer height)
53  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
54 void clear(void)
55  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
56 void eol_clear(void)
57  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
58 void cursor_goto(Integer row, Integer col)
59  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
60 void highlight_set(HlAttrs attrs)
61  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY FUNC_API_REMOTE_IMPL;
62 void put(String str)
63  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
64 void set_scroll_region(Integer top, Integer bot, Integer left, Integer right)
65  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
66 void scroll(Integer count)
67  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
68 
69 // Second revison of the grid protocol, used with ext_linegrid ui option
70 void default_colors_set(Integer rgb_fg, Integer rgb_bg, Integer rgb_sp,
71  Integer cterm_fg, Integer cterm_bg)
72  FUNC_API_SINCE(4) FUNC_API_REMOTE_IMPL;
73 void hl_attr_define(Integer id, HlAttrs rgb_attrs, HlAttrs cterm_attrs,
74  Array info)
75  FUNC_API_SINCE(5) FUNC_API_REMOTE_IMPL FUNC_API_BRIDGE_IMPL;
76 void grid_resize(Integer grid, Integer width, Integer height)
77  FUNC_API_SINCE(5) FUNC_API_REMOTE_IMPL FUNC_API_COMPOSITOR_IMPL;
78 void grid_clear(Integer grid)
79  FUNC_API_SINCE(5) FUNC_API_REMOTE_IMPL;
80 void grid_cursor_goto(Integer grid, Integer row, Integer col)
81  FUNC_API_SINCE(5) FUNC_API_REMOTE_IMPL FUNC_API_COMPOSITOR_IMPL;
82 void grid_line(Integer grid, Integer row, Integer col_start, Array data)
83  FUNC_API_SINCE(5) FUNC_API_REMOTE_ONLY;
84 void grid_scroll(Integer grid, Integer top, Integer bot,
85  Integer left, Integer right, Integer rows, Integer cols)
86  FUNC_API_SINCE(5) FUNC_API_REMOTE_IMPL FUNC_API_COMPOSITOR_IMPL;
87 void grid_destroy(Integer grid)
88  FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
89 
90 // For perfomance and simplicity, we use the dense screen representation
91 // in internal code, such as compositor and TUI. The remote_ui module will
92 // translate this in to the public grid_line format.
93 void raw_line(Integer grid, Integer row, Integer startcol,
94  Integer endcol, Integer clearcol, Integer clearattr,
95  LineFlags flags, const schar_T *chunk, const sattr_T *attrs)
96  FUNC_API_NOEXPORT FUNC_API_COMPOSITOR_IMPL;
97 
98 void event(char *name, Array args, bool *args_consumed)
99  FUNC_API_NOEXPORT;
100 
101 void win_pos(Integer grid, Integer win, Integer startrow,
102  Integer startcol, Integer width, Integer height)
103  FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
104 void win_float_pos(Integer grid, Window win, String anchor, Integer anchor_grid,
105  Float anchor_row, Float anchor_col, Boolean focusable)
106  FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
107 void win_external_pos(Integer grid, Window win)
108  FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
109 void win_hide(Integer grid)
110  FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
111 void win_close(Integer grid)
112  FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
113 void win_scroll_over_start(void)
114  FUNC_API_SINCE(6) FUNC_API_BRIDGE_IMPL FUNC_API_COMPOSITOR_IMPL;
115 void win_scroll_over_reset(void)
116  FUNC_API_SINCE(6) FUNC_API_BRIDGE_IMPL FUNC_API_COMPOSITOR_IMPL;
117 
118 void popupmenu_show(Array items, Integer selected,
119  Integer row, Integer col, Integer grid)
120  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
121 void popupmenu_hide(void)
122  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
123 void popupmenu_select(Integer selected)
124  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
125 
126 void tabline_update(Tabpage current, Array tabs)
127  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
128 
129 void cmdline_show(Array content, Integer pos, String firstc, String prompt,
130  Integer indent, Integer level)
131  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
132 void cmdline_pos(Integer pos, Integer level)
133  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
135  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
137  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
138 void cmdline_block_show(Array lines)
139  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
140 void cmdline_block_append(Array lines)
141  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
142 void cmdline_block_hide(void)
143  FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
144 
145 void wildmenu_show(Array items)
146  FUNC_API_SINCE(3) FUNC_API_REMOTE_IMPL FUNC_API_BRIDGE_IMPL;
147 void wildmenu_select(Integer selected)
148  FUNC_API_SINCE(3) FUNC_API_REMOTE_IMPL FUNC_API_BRIDGE_IMPL;
149 void wildmenu_hide(void)
150  FUNC_API_SINCE(3) FUNC_API_REMOTE_IMPL FUNC_API_BRIDGE_IMPL;
151 
152 void msg_show(String kind, Array content, Boolean replace_last)
153  FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
154 void msg_clear(void)
155  FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
156 void msg_showcmd(Array content)
157  FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
158 void msg_showmode(Array content)
159  FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
160 void msg_ruler(Array content)
161  FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
162 void msg_history_show(Array entries)
163  FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
164 #endif // NVIM_API_UI_EVENTS_IN_H
int16_t sattr_T
Definition: grid_defs.h:14
void resize(Integer width, Integer height) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
void win_pos(Integer grid, Integer win, Integer startrow, Integer startcol, Integer width, Integer height) FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY
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
void msg_clear(void) FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY
double Float
Definition: defs.h:68
void scroll(Integer count) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
void popupmenu_select(Integer selected) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
void cmdline_block_show(Array lines) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
void win_close(Integer grid) FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY
void win_float_pos(Integer grid, Window win, String anchor, Integer anchor_grid, Float anchor_row, Float anchor_col, Boolean focusable) FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY
void event(char *name, Array args, bool *args_consumed) FUNC_API_NOEXPORT
void update_bg(Integer bg) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
char_u schar_T[(MAX_MCO+1)*4+1]
Definition: grid_defs.h:13
void popupmenu_show(Array items, Integer selected, Integer row, Integer col, Integer grid) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
Definition: defs.h:76
void popupmenu_hide(void) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
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
void bell(void) FUNC_API_SINCE(3)
int LineFlags
Definition: ui.h:47
void cmdline_hide(Integer level) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
void win_scroll_over_reset(void) FUNC_API_SINCE(6) FUNC_API_BRIDGE_IMPL FUNC_API_COMPOSITOR_IMPL
void set_title(String title) FUNC_API_SINCE(3)
void win_external_pos(Integer grid, Window win) FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY
bool Boolean
Definition: defs.h:66
void update_sp(Integer sp) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
Definition: highlight_defs.h:24
Definition: defs.h:114
void clear(void) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
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
void msg_history_show(Array entries) FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY
void msg_showcmd(Array content) FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY
void wildmenu_hide(void) FUNC_API_SINCE(3) FUNC_API_REMOTE_IMPL FUNC_API_BRIDGE_IMPL
void win_scroll_over_start(void) FUNC_API_SINCE(6) FUNC_API_BRIDGE_IMPL FUNC_API_COMPOSITOR_IMPL
void mode_info_set(Boolean enabled, Array cursor_styles) FUNC_API_SINCE(3)
void stop(void) FUNC_API_NOEXPORT
void mouse_on(void) FUNC_API_SINCE(3)
static void const char * title
Definition: eval.c:15058
void busy_stop(void) FUNC_API_SINCE(3)
fc level
Definition: eval.c:22208
void mouse_off(void) FUNC_API_SINCE(3)
void update_fg(Integer fg) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
void suspend(void) FUNC_API_SINCE(3) FUNC_API_BRIDGE_IMPL
void option_set(String name, Object value) FUNC_API_SINCE(4) FUNC_API_BRIDGE_IMPL
void tabline_update(Tabpage current, Array tabs) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
void busy_start(void) FUNC_API_SINCE(3)
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
void cmdline_block_append(Array lines) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
va_list args
Definition: log.c:139
Definition: defs.h:87
int64_t Integer
Definition: defs.h:67
void wildmenu_select(Integer selected) FUNC_API_SINCE(3) FUNC_API_REMOTE_IMPL FUNC_API_BRIDGE_IMPL
void grid_resize(Integer grid, Integer width, Integer height) FUNC_API_SINCE(5) FUNC_API_REMOTE_IMPL FUNC_API_COMPOSITOR_IMPL
char * name
Definition: eval.c:1869
void visual_bell(void) FUNC_API_SINCE(3)
void eol_clear(void) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
void update_menu(void) FUNC_API_SINCE(3)
void highlight_set(HlAttrs attrs) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY FUNC_API_REMOTE_IMPL
void set_scroll_region(Integer top, Integer bot, Integer left, Integer right) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
void cmdline_show(Array content, Integer pos, String firstc, String prompt, Integer indent, Integer level) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
void grid_cursor_goto(Integer grid, Integer row, Integer col) FUNC_API_SINCE(5) FUNC_API_REMOTE_IMPL FUNC_API_COMPOSITOR_IMPL
void msg_ruler(Array content) FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY
void wildmenu_show(Array items) FUNC_API_SINCE(3) FUNC_API_REMOTE_IMPL FUNC_API_BRIDGE_IMPL
void cmdline_special_char(String c, Boolean shift, Integer level) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
void cmdline_block_hide(void) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
void mode_change(String mode, Integer mode_idx) FUNC_API_SINCE(3)
void flush(void) FUNC_API_SINCE(3) FUNC_API_REMOTE_IMPL
void grid_clear(Integer grid) FUNC_API_SINCE(5) FUNC_API_REMOTE_IMPL
void cursor_goto(Integer row, Integer col) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
void grid_destroy(Integer grid) FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY
void put(String str) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY
void msg_showmode(Array content) FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY
void win_hide(Integer grid) FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY
void grid_line(Integer grid, Integer row, Integer col_start, Array data) FUNC_API_SINCE(5) FUNC_API_REMOTE_ONLY
void set_icon(String icon) FUNC_API_SINCE(3)
void msg_show(String kind, Array content, Boolean replace_last) FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY
void cmdline_pos(Integer pos, Integer level) FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY