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

ncmenu man page #179

Browse Source
This commit is contained in:
nick black 2020-02-02 06:57:10 -05:00 committed by Nick Black
parent db53b36d94
commit 2ced7357ce
1 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/man/man3/notcurses_menu.3.md
View File

@ -23,9 +23,9 @@ struct ncmenu_section {
};
typedef struct ncmenu_options {
bool bottom; // on the bottom row, as opposed to top row
bool hiding; // hide the menu when not being used
struct ncmenu_section* sections; // array of 'sectioncount' menu_sections
bool bottom; // on the bottom row, as opposed to top row
bool hiding; // hide the menu when not being used
struct ncmenu_section* sections; // 'sectioncount' menu_sections
int sectioncount; // must be positive
uint64_t headerchannels; // styling for header
uint64_t sectionchannels; // styling for sections
@ -42,9 +42,21 @@ typedef struct ncmenu_options {
# DESCRIPTION
A notcurses instance supports up to two menu bars, with one on the top and/or
bottom rows of the true screen. They are logically above other ncplanes on the
z-axis. Attempting to create a menu where one already exists is an error.
A menu is composed of sections, which are in turn composed of items. Either no
sections are visible, and the menu is *rolled up*, or exactly one section is
*unrolled*. **ncmenu_rollup** places an ncmenu in the rolled up state.
**ncmenu_unroll** rolls up any unrolled section, and unrolls the specified one.
**ncmenu_destroy** removes a menu bar, and frees all associated resources.
# RETURN VALUES
**ncmenu_create** returns NULL on error, or a pointer to a valid new ncmenu.
Other functions return non-zero on error, or zero on success. Almost all errors
are due to invalid parameters.
# SEE ALSO