Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
notcurses_multiselector(3)			    notcurses_multiselector(3)

NAME
       notcurses_multiselector - high level widget for selecting from a	set

SYNOPSIS
       #include	<notcurses/notcurses.h>

	      struct ncinput;
	      struct ncplane;
	      struct notcurses;
	      struct ncmultiselector;

	      struct ncmselector_item {
		char* option;
		char* desc;
		bool selected;
	      };

	      typedef struct ncmultiselector_options {
		char* title; //	title may be NULL, inhibiting riser
		char* secondary; // secondary may be NULL
		char* footer; // footer	may be NULL
		struct ncmselector_item* items;	// initial items, statuses
		// 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
		unsigned flags;	       // bitfield over	NCMULTISELECTOR_OPTION_*
	      }	ncmultiselector_options;

       struct  ncmultiselector*	 ncmultiselector_create(struct ncplane*	n, int
       y, int x, const ncmultiselector_options*	opts);

       int ncmultiselector_selected(bool* selected, unsigned n);

       struct ncplane* ncmultiselector_plane(struct ncmultiselector* n);

       bool  ncmultiselector_offer_input(struct	 ncmultiselector*   n,	 const
       struct ncinput* nc);

       void ncmultiselector_destroy(struct ncmultiselector* n);

DESCRIPTION
NOTES
       Currently, the ncplane n	provided to ncmultiselector_create must	not be
       NULL, though the	ncmultiselector	will always get	 its  own  plane,  and
       this plane will not (currently) be bound	to n.

RETURN VALUES
SEE ALSO
       notcurses(3),  notcurses_input(3),  notcurses_plane(3) notcurses_selec-
       tor(3)

AUTHORS
       nick black <nickblack@linux.com>.

				    v1.6.11	    notcurses_multiselector(3)

NAME | SYNOPSIS | DESCRIPTION | NOTES | RETURN VALUES | SEE ALSO | AUTHORS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=notcurses_multiselector&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help