mitem_current(3X)

okay bestie, welcome to mitem_current(3X) — this one lives in the Library calls section, and it’s literally all about setting and getting the current menu item. 🎀

🎀 NAME 🎀

mitem_current — set and get current_menu_item 💖

---

✨ SYNOPSIS ✨

#include <menu.h>

int set_current_item(MENU *menu, ITEM *item);
ITEM *current_item(const MENU *menu);

int set_top_row(MENU *menu, int row);
int top_row(const MENU *menu);

int item_index(const ITEM *item);

---

💅 DESCRIPTION 💅

okay so bestie, here’s the tea: set_current_item sets the current item — aka the item on which the menu cursor is positioned. current_item returns a pointer to the current item in the given menu. main character behavior, no cap. 🌟

set_top_row sets the top row of the menu to show the given row. The top row is initially 0, and it is reset to this value whenever the O_ROWMAJOR option is toggled. The item leftmost on the given row becomes current. top_row returns the number of the top menu row being displayed. slay. 🦋

item_index returns the (zero-origin) index of item in the menu’s item pointer list. iykyk. 🔥

---

🔮 RETURN VALUE 🔮

current_item returns a pointer (which may be NULL). It does not set errno. ngl, that part matters. 🙈

top_row and item_index return ERR (the general curses error value) if their menu parameter is NULL. yes, fr fr. 💀

set_current_item and set_top_row return one of the following:

• E_OK — the routine succeeded. periodt. ✨
• E_BAD_ARGUMENT — routine detected an incorrect or out-of-range argument. not the vibe. 😭
• E_BAD_STATE — routine was called from an initialization or termination function. wrong moment, bestie. 🫠
• E_NOT_CONNECTED — no items are connected to the menu. it’s giving empty group chat. 💀
• E_SYSTEM_ERROR — system error occurred (see errno(3)). go check errno(3), bestie. 🔍

---

🌈 PORTABILITY 🌈

These routines emulate the System V menu library. They were not supported on Version 7 or BSD versions. history lesson, but make it menu. 📜

The SVr4 menu library documentation specifies the top_row and index_item error value as -1 (which is the value of ERR). yes, it says index_item there — we’re keeping it exactly as the page says. 👀

---

👑 AUTHORS 👑

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

---

🌸 SEE ALSO 🌸

curses(3X), menu(3X) — go read those too, bestie. 💖

---

and that’s a wrap, bestie! 🫶 this page is from ncurses 6.5, dated 2024-12-28 — mitem_current(3X) forever. periodt 💅✨