aboutsummaryrefslogtreecommitdiff
path: root/src/nvim/api/ui.c
diff options
context:
space:
mode:
authorUtkarsh Maheshwari <utkarshme96@gmail.com>2018-06-28 15:35:19 +0530
committerBjörn Linse <bjorn.linse@gmail.com>2018-12-31 12:44:22 +0100
commit47c053cc39c9b3aa78eb4f64ec98c574506729ae (patch)
treef249008b930a1b9fc944d88fd84d5176e0455121 /src/nvim/api/ui.c
parentdb14d78e4f90a0dab64beb569efe0a7d314db4a7 (diff)
downloadrneovim-47c053cc39c9b3aa78eb4f64ec98c574506729ae.tar.gz
rneovim-47c053cc39c9b3aa78eb4f64ec98c574506729ae.tar.bz2
rneovim-47c053cc39c9b3aa78eb4f64ec98c574506729ae.zip
multigrid: Add multigrid documentation
Diffstat (limited to 'src/nvim/api/ui.c')
-rw-r--r--src/nvim/api/ui.c11
1 files changed, 9 insertions, 2 deletions
diff --git a/src/nvim/api/ui.c b/src/nvim/api/ui.c
index 48a4708dbf..c374bede99 100644
--- a/src/nvim/api/ui.c
+++ b/src/nvim/api/ui.c
@@ -245,8 +245,15 @@ static void ui_set_option(UI *ui, bool init, String name, Object value,
name.data);
}
-/// Sets the inner "width" and "height" of the window grid identified by
-/// "grid" handle. If the grid does not exist, set error.
+/// Tell nvim to resize a grid. Nvim sends grid_resize event with the
+/// requested grid size is within size limits and with maximum allowed size
+/// otherwise.
+///
+/// On invalid grid handle, fails with error.
+///
+/// @param grid The handle of the grid to be changed.
+/// @param width The new requested width.
+/// @param height The new requested height.
void nvim_ui_try_resize_grid(uint64_t channel_id, Integer grid, Integer width,
Integer height, Error *error)
FUNC_API_SINCE(5) FUNC_API_REMOTE_ONLY