menu_hook(3X)

πŸ“¦ version 15.1, in freebsd 14.5, freebsd 15.1

okay bestie, welcome to the menu_hook(3X) page β€” it's giving automatic hook invocation energy, and honestly? iconic. πŸ’…


✨ NAME ✨

menu_hook β€” set hooks for automatic invocation by applications πŸŽ€

πŸ¦‹ SYNOPSIS πŸ¦‹

#include <menu.h>

int set_item_init(MENU *menu, Menu_Hook func);
Menu_Hook item_init(const MENU *menu);

int set_item_term(MENU *menu, Menu_Hook func);
Menu_Hook item_term(const MENU *menu);

int set_menu_init(MENU *menu, Menu_Hook func);
Menu_Hook menu_init(const MENU *menu);

int set_menu_term(MENU *menu, Menu_Hook func);
Menu_Hook menu_term(const MENU *menu);

πŸ’– DESCRIPTION πŸ’–

okay so these functions let you set hook functions that get called at various points while menu_driver is automatically processing input event codes. no cap, that's the whole vibe. ✨

  • set_item_init sets a hook to be called at menu-post time and each time the selected item changes (after the change). item_init returns the current item init hook, if any (NULL if there is no such hook). 🫢
  • set_item_term sets a hook to be called at menu-unpost time and each time the selected item changes (before the change). item_term returns the current item term hook, if any (NULL if there is no such hook). πŸ¦‹
  • set_menu_init sets a hook to be called at menu-post time and just after the top row on the menu changes once it is posted. menu_init returns the current menu init hook, if any (NULL if there is no such hook). 🌈
  • set_menu_term sets a hook to be called at menu-unpost time and just before the top row on the menu changes once it is posted. menu_term returns the current menu term hook, if any (NULL if there is no such hook). ⭐

πŸ”₯ RETURN VALUE πŸ”₯

Routines that return pointers return NULL on error. The other routines return one of these, bestie:

  • E_OK β€” the routine succeeded. slay. βœ…
  • E_SYSTEM_ERROR β€” a system error occurred (see errno(3)). 😭

🧚 PORTABILITY 🧚

These routines emulate the System V menu library. They were not supported on Version 7 or BSD versions. lowkey important, so don't forget it. πŸ’œ

πŸ‘‘ AUTHORS πŸ‘‘

Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. πŸŽ€

🌸 SEE ALSO 🌸

curses(3X), menu(3X) πŸ’–


and that's the tea, bestie: this is from ncurses 6.5, dated 2024-12-28, and it's the menu_hook(3X) manual page. bye! πŸ’…

πŸ“¦ where this page comes from