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

notcurses_selector.3: document that n cannot be standard plane

Browse Source
This commit is contained in:
nick black 2021-11-16 23:28:31 -05:00
parent 12988bb556
commit 76f2a3d374
No known key found for this signature in database
GPG Key ID: 5F43400C21CBFACC
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/man/man3/notcurses_selector.3.md
View File

@ -62,11 +62,12 @@ typedef struct ncselector_options {
# NOTES
The **ncplane** **n** provided to **ncselector_create** must not be **NULL**.
It will be freely resized by the new **ncselector**. **ncselector_selected**
returns the currently-selected option. **ncselector_additem** and
**ncselector_delitem** allow items to be added and deleted on the fly
(a static set of items can all be provided in the **ncselector_create**
call). The backing plane will be resized as necessary for item changes.
It will be freely resized by the new **ncselector**, and thus cannot be
the standard plane. **ncselector_selected** returns the currently-selected
option. **ncselector_additem** and **ncselector_delitem** allow items to be
added and deleted on the fly (a static set of items can all be provided in the
**ncselector_create** call). The backing plane will be resized as necessary for
item changes.
**ncselector_nextitem** and **ncselector_previtem** select the next (down) or
previous (up) option, scrolling if necessary. It is safe to call these
@ -100,5 +101,6 @@ items, they return **NULL**.
**notcurses(3)**,
**notcurses_input(3)**,
**notcurses_multiselector(3)**
**notcurses_plane(3)**
**notcurses_multiselector(3)**,
**notcurses_plane(3)**,
**notcurses_stdplane(3)**