blackbeard420/notcurses
1
0
Fork 0
mirror of https://github.com/dankamongmen/notcurses synced 2025-03-09 17:19:03 -04:00
Code Issues Projects Releases Wiki Activity

complete ncplane_cursor_move_yx() documentation

Browse Source
This commit is contained in:
nick black 2021-07-05 23:42:51 -04:00
parent aa7b46f659
commit 00e28cc569
No known key found for this signature in database
GPG Key ID: 5F43400C21CBFACC
3 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
USAGE.md
View File

@ -1103,8 +1103,8 @@ memory.
```c
// Move the cursor to the specified position (the cursor needn't be visible).
// Returns -1 on error, including negative parameters, or ones exceeding the
// plane's dimensions.
// Pass -1 as either coordinate to hold that axis constant. Returns -1 if the
// move would place the cursor outside the plane.
int ncplane_cursor_move_yx(struct ncplane* n, int y, int x);
// Get the current position of the cursor within n. y and/or x may be NULL.

2
doc/man/man3/notcurses_plane.3.md
View File

@ -286,7 +286,7 @@ it will not be visible following rasterization; it can also be partially
off-screen.
A plane has a virtual cursor; move it with **ncplane_cursor_move_yx**.
Specifying -1 as one or both coordinates will hold that axis constant. Unless
Specifying -1 as either coordinate will hold that axis constant. Unless
coordinates are specified for a call, action takes place at the plane's
virtual cursor, which automatically moves along with output. The current
virtual cursor location can be acquired with **ncplane_cursor_yx**.

4
include/notcurses/notcurses.h
View File

@ -1639,8 +1639,8 @@ ncplane_valign(const struct ncplane* n, ncalign_e align, int r){
}
// Move the cursor to the specified position (the cursor needn't be visible).
// Returns -1 on error, including negative parameters, or ones exceeding the
// plane's dimensions.
// Pass -1 as either coordinate to hold that axis constant. Returns -1 if the
// move would place the cursor outside the plane.
API int ncplane_cursor_move_yx(struct ncplane* n, int y, int x);
// Move the cursor to 0, 0. Can't fail.