multiselector man page

doc/man/index.html

@@ -39,7 +39,8 @@ <h2>C library (section 3)</h2>
   <a href="notcurses_palette.3.html">notcurses_palette</a>—operations on notcurses palettes<br/>
   <a href="notcurses_render.3.html">notcurses_render</a>—sync the physical display<br/>
   <a href="notcurses_resize.3.html">notcurses_resize</a>—resize the standard plane based off screen size<br/>
-  <a href="notcurses_selector.3.html">notcurses_selector</a>—high-level widget for selecting from a set<br/>
+  <a href="notcurses_selector.3.html">notcurses_selector</a>—high-level widget for selecting one item from a set<br/>
+  <a href="notcurses_multiselector.3.html">notcurses_multiselector</a>—high-level widget for selecting items from a set<br/>
   <a href="notcurses_stats.3.html">notcurses_stats</a>—notcurses runtime statistics<br/>
   <a href="notcurses_stdplane.3.html">notcurses_stdplane</a>—acquire the standard <tt>ncplane</tt><br/>
   <a href="notcurses_stop.3.html">notcurses_stop</a>—collapse the context<br/>

doc/man/man3/notcurses_multiselector.3.md

@@ -0,0 +1,64 @@
+% notcurses_multiselector(3)
+% nick black <nickblack@linux.com>
+% v1.2.3
+
+# NAME
+
+notcurses_multiselector - high level widget for selecting from a set
+
+# SYNOPSIS
+
+**#include <notcurses.h>**
+
+```c
+**struct ncinput;**
+**struct ncplane;**
+**struct notcurses;**
+**struct ncmultiselector;**
+
+struct mselector_item {
+  char* option;
+  char* desc;
+  bool selected;
+};
+
+typedef struct multiselector_options {
+  char* title; // title may be NULL, inhibiting riser
+  char* secondary; // secondary may be NULL
+  char* footer; // footer may be NULL
+  struct mselector_item* items; // initial items, statuses
+  unsigned itemcount; // number of initial items
+  // default item (selected at start)
+  unsigned defidx;
+  // maximum number of options to display at once
+  unsigned maxdisplay;
+  // exhaustive styling options
+  uint64_t opchannels;   // option channels
+  uint64_t descchannels; // description channels
+  uint64_t titlechannels;// title channels
+  uint64_t footchannels; // secondary and footer channels
+  uint64_t boxchannels;  // border channels
+  uint64_t bgchannels;   // background channels for body
+} multiselector_options;
+```
+
+**struct ncmultiselector* ncmultiselector_create(struct ncplane* n, int y, int x, const multiselector_options* opts);**
+
+**struct ncplane* ncmultiselector_plane(struct ncmultiselector* n);**
+
+**bool ncmultiselector_offer_input(struct ncmultiselector* n, const struct ncinput* nc);**
+
+**void ncmultiselector_destroy(struct ncmultiselector* n, char** item);**
+
+# DESCRIPTION
+
+# NOTES
+
+# RETURN VALUES
+
+# SEE ALSO
+
+**notcurses(3)**,
+**notcurses_input(3)**,
+**notcurses_ncplane(3)**
+**notcurses_selector(3)**

doc/man/man3/notcurses_selector.3.md

@@ -69,4 +69,5 @@ typedef struct selector_options {
 
 **notcurses(3)**,
 **notcurses_input(3)**,
+**notcurses_multiselector(3)**
 **notcurses_ncplane(3)**