From 9220e9ac8ce16dd735fa0f863e3686e85979e69b Mon Sep 17 00:00:00 2001 From: smolck <46855713+smolck@users.noreply.github.com> Date: Thu, 9 Sep 2021 00:23:19 -0500 Subject: [PATCH] add docs for UI Events I think we'd need to parse the ui.txt help doc if we wanted to get the documentation from there and use it here, and after testing how it'd look with the grid_line event docs, I'm not even convinced it'd be a good idea anyways to use the docs from ui.txt --- src/NvimClient.API/NvimAPI.generated.cs | 1116 +++++++++++++++++ .../NvimAPIGenerator.cs | 20 +- 2 files changed, 1135 insertions(+), 1 deletion(-) diff --git a/src/NvimClient.API/NvimAPI.generated.cs b/src/NvimClient.API/NvimAPI.generated.cs index dfae524..9c69525 100644 --- a/src/NvimClient.API/NvimAPI.generated.cs +++ b/src/NvimClient.API/NvimAPI.generated.cs @@ -11,67 +11,1183 @@ namespace NvimClient.API { public partial class NvimAPI { + + /// + /// EventHandler for mode_info_set UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `ModeInfoSetEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler ModeInfoSetEvent; + + /// + /// EventHandler for update_menu UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `UpdateMenuEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler UpdateMenuEvent; + + /// + /// EventHandler for busy_start UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `BusyStartEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler BusyStartEvent; + + /// + /// EventHandler for busy_stop UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `BusyStopEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler BusyStopEvent; + + /// + /// EventHandler for mouse_on UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `MouseOnEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler MouseOnEvent; + + /// + /// EventHandler for mouse_off UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `MouseOffEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler MouseOffEvent; + + /// + /// EventHandler for mode_change UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `ModeChangeEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler ModeChangeEvent; + + /// + /// EventHandler for bell UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `BellEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler BellEvent; + + /// + /// EventHandler for visual_bell UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `VisualBellEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler VisualBellEvent; + + /// + /// EventHandler for flush UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `FlushEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler FlushEvent; + + /// + /// EventHandler for suspend UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `SuspendEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler SuspendEvent; + + /// + /// EventHandler for set_title UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `SetTitleEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler SetTitleEvent; + + /// + /// EventHandler for set_icon UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `SetIconEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler SetIconEvent; + + /// + /// EventHandler for screenshot UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `ScreenshotEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler ScreenshotEvent; + + /// + /// EventHandler for option_set UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `OptionSetEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler OptionSetEvent; + + /// + /// EventHandler for update_fg UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `UpdateFgEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler UpdateFgEvent; + + /// + /// EventHandler for update_bg UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `UpdateBgEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler UpdateBgEvent; + + /// + /// EventHandler for update_sp UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `UpdateSpEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler UpdateSpEvent; + + /// + /// EventHandler for resize UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `ResizeEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler ResizeEvent; + + /// + /// EventHandler for clear UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `ClearEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler ClearEvent; + + /// + /// EventHandler for eol_clear UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `EolClearEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler EolClearEvent; + + /// + /// EventHandler for cursor_goto UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `CursorGotoEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler CursorGotoEvent; + + /// + /// EventHandler for highlight_set UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `HighlightSetEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler HighlightSetEvent; + + /// + /// EventHandler for put UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `PutEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler PutEvent; + + /// + /// EventHandler for set_scroll_region UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `SetScrollRegionEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler SetScrollRegionEvent; + + /// + /// EventHandler for scroll UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `ScrollEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler ScrollEvent; + + /// + /// EventHandler for default_colors_set UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `DefaultColorsSetEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler DefaultColorsSetEvent; + + /// + /// EventHandler for hl_attr_define UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `HlAttrDefineEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler HlAttrDefineEvent; + + /// + /// EventHandler for hl_group_set UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `HlGroupSetEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler HlGroupSetEvent; + + /// + /// EventHandler for grid_resize UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `GridResizeEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler GridResizeEvent; + + /// + /// EventHandler for grid_clear UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `GridClearEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler GridClearEvent; + + /// + /// EventHandler for grid_cursor_goto UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `GridCursorGotoEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler GridCursorGotoEvent; + + /// + /// EventHandler for grid_line UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `GridLineEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler GridLineEvent; + + /// + /// EventHandler for grid_scroll UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `GridScrollEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler GridScrollEvent; + + /// + /// EventHandler for grid_destroy UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `GridDestroyEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler GridDestroyEvent; + + /// + /// EventHandler for win_pos UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `WinPosEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler WinPosEvent; + + /// + /// EventHandler for win_float_pos UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `WinFloatPosEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler WinFloatPosEvent; + + /// + /// EventHandler for win_external_pos UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `WinExternalPosEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler WinExternalPosEvent; + + /// + /// EventHandler for win_hide UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `WinHideEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler WinHideEvent; + + /// + /// EventHandler for win_close UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `WinCloseEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler WinCloseEvent; + + /// + /// EventHandler for msg_set_pos UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `MsgSetPosEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler MsgSetPosEvent; + + /// + /// EventHandler for win_viewport UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `WinViewportEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler WinViewportEvent; + + /// + /// EventHandler for popupmenu_show UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `PopupmenuShowEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler PopupmenuShowEvent; + + /// + /// EventHandler for popupmenu_hide UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `PopupmenuHideEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler PopupmenuHideEvent; + + /// + /// EventHandler for popupmenu_select UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `PopupmenuSelectEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler PopupmenuSelectEvent; + + /// + /// EventHandler for tabline_update UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `TablineUpdateEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler TablineUpdateEvent; + + /// + /// EventHandler for cmdline_show UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `CmdlineShowEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler CmdlineShowEvent; + + /// + /// EventHandler for cmdline_pos UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `CmdlinePosEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler CmdlinePosEvent; + + /// + /// EventHandler for cmdline_special_char UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `CmdlineSpecialCharEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler CmdlineSpecialCharEvent; + + /// + /// EventHandler for cmdline_hide UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `CmdlineHideEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler CmdlineHideEvent; + + /// + /// EventHandler for cmdline_block_show UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `CmdlineBlockShowEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler CmdlineBlockShowEvent; + + /// + /// EventHandler for cmdline_block_append UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `CmdlineBlockAppendEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler CmdlineBlockAppendEvent; + + /// + /// EventHandler for cmdline_block_hide UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `CmdlineBlockHideEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler CmdlineBlockHideEvent; + + /// + /// EventHandler for wildmenu_show UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `WildmenuShowEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler WildmenuShowEvent; + + /// + /// EventHandler for wildmenu_select UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `WildmenuSelectEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler WildmenuSelectEvent; + + /// + /// EventHandler for wildmenu_hide UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `WildmenuHideEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler WildmenuHideEvent; + + /// + /// EventHandler for msg_show UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `MsgShowEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler MsgShowEvent; + + /// + /// EventHandler for msg_clear UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `MsgClearEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler MsgClearEvent; + + /// + /// EventHandler for msg_showcmd UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `MsgShowcmdEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler MsgShowcmdEvent; + + /// + /// EventHandler for msg_showmode UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `MsgShowmodeEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler MsgShowmodeEvent; + + /// + /// EventHandler for msg_ruler UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `MsgRulerEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler MsgRulerEvent; + + /// + /// EventHandler for msg_history_show UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.NvimClient.NvimMsgpack.Models.NvimUIEvent += (sender, args) => + /// { + /// // `args` is of type `MsgHistoryShowEventArgs` + /// // Handler code goes here. + /// } + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// public event EventHandler MsgHistoryShowEvent; /// diff --git a/src/NvimClient.APIGenerator/NvimAPIGenerator.cs b/src/NvimClient.APIGenerator/NvimAPIGenerator.cs index 44166e9..d590cad 100644 --- a/src/NvimClient.APIGenerator/NvimAPIGenerator.cs +++ b/src/NvimClient.APIGenerator/NvimAPIGenerator.cs @@ -127,7 +127,25 @@ private static string GenerateNvimUIEvents( var genericTypeParam = uiEvent.Parameters.Any() ? $"<{camelCaseName}EventArgs>" : string.Empty; - return $" public event EventHandler{genericTypeParam} {camelCaseName}Event;"; + return $@" + /// + /// EventHandler for {uiEvent.Name} UI event (see corresponding + /// docs in `:help ui-events` in nvim). + /// + /// + /// + /// var api = new NvimAPI(); + /// api.{uiEvent} += (sender, args) => + /// {{ + /// // `args` is of type `{camelCaseName}EventArgs` + /// // Handler code goes here. + /// }} + /// // Now if this event is emitted after attaching the UI, + /// // the above handler code will be run. + /// + /// + /// + public event EventHandler{genericTypeParam} {camelCaseName}Event;"; })); private static string GenerateNvimUIEventArgs(