menu_win(3X)

📦
version 6.6_p20260516 · 6 versions
, in alpine 3.24, arch rolling, fedora 44

okay bestie, welcome to menu_win(3X) — yes that's the library-calls section of the manual, and yes this whole page is about making and breaking menu window and subwindow associations 🪟✨

🌸 NAME 🌸

menu_win — make and break menu window and subwindow associations

🎀 SYNOPSIS 🎀

#include <menu.h>

int set_menu_win(MENU *menu, WINDOW *win);
WINDOW *menu_win(const MENU *menu);

int set_menu_sub(MENU *menu, WINDOW *sub);
WINDOW *menu_sub(const MENU *menu);

int scale_menu(const MENU *menu, int *rows, int *columns);

✨ DESCRIPTION ✨

so every menu has a little duo of curses windows attached to it, like a main character and their bestie 🫶

  • the menu window shows any title and border that's associated with the window 👑
  • the menu subwindow shows the items of the menu that are currently available for selection 🍓

the first four functions get and set those windows. and no, you do not have to set either one — by default the driver code just uses stdscr for both. lowkey convenient, fr fr 😌

in the set_ functions:

  • a window argument of NULL is treated as though it were stsdcr 👀
  • a MENU argument of NULL is treated as a request to change the system default menu window or subwindow 🌈

and the function scale_menu returns the minimum size required for the subwindow of menu. it's giving "how much room do i need" energy 💖

🔥 RETURN VALUE 🔥

routines that return pointers return NULL on error. routines that return an integer return one of these error codes, no cap:

  • E_OK — the routine succeeded. slay 💅
  • E_SYSTEM_ERROR — system error occurred (see errno(3)). 💀
  • E_BAD_ARGUMENT — routine detected an incorrect or out-of-range argument 🙈
  • E_POSTED — the menu has already been posted 📌
  • E_NOT_CONNECTED — no items are connected to the menu 😭

🌈 PORTABILITY 🌈

these routines emulate the System V menu library. they were not supported on Version 7 or BSD versions — so if you're on one of those, bestie, this is not the vibe 🚫

👑 AUTHORS 👑

Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond.

🦋 SEE ALSO 🦋

curses(3X), curs_variables(3X), menu(3X)

and that's the whole page, periodt 💜 this one came from ncurses 6.6, dated 2024-12-28 — so like, go forth and associate your windows, icon 🎀✨

📦 where this page comes from