blackbeard420/notcurses
1
0
Fork 0
mirror of https://github.com/dankamongmen/notcurses synced 2025-03-10 01:29:05 -04:00
Code Issues Projects Releases Wiki Activity

bulk up notcurses_selector.3 man page #862

Browse Source
This commit is contained in:
nick black 2020-08-16 05:54:58 -04:00
parent 02fb9b078f
commit cdec910d7e
No known key found for this signature in database
GPG Key ID: 5F43400C21CBFACC
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -65,7 +65,20 @@ typedef struct ncselector_options {
Currently, the **ncplane** **n** provided to **ncselector_create** must not be
**NULL**, though the **ncselector** will always get its own plane, and this
plane will not (currently) be bound to **n**.
plane will not (currently) be bound to **n**. **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).
**ncselector_plane** will return the **ncplane** on which the widget is
drawn.
While the **ncselector** can be driven entirely by client code, input can
be run through **ncselector_offer_input** to take advantage of common
controls. It will handle the up and down arrows, along with PageUp and
PageDown. If the mouse is enabled, the mouse scrollwheel and mouse clicks
on the scroll arrows will be handled.
# RETURN VALUES