page(3FORM)

✨ page(3FORM) — form_page ✨

okay bestie, gather round, because today we're talking about form_page — the whole set and get form page number situation 💖 this is a library call from the curses forms world and she is lowkey iconic.

---

🎀 NAME 🎀

form_page — set and get form page number 🦋

---

💅 SYNOPSIS 💅

#include <form.h>

int set_current_field(FORM *form, FIELD *field);
FIELD *current_field(const FORM *form);

int unfocus_current_field(FORM *form);

int set_form_page(FORM *form, int n);
int form_page(const FORM *form);

int field_index(const FIELD *field);

---

🌸 DESCRIPTION 🌸

okay so first up, set_current_field sets the current field of the given form, and current_field hands you back the current field of the given form. classic get/set duo, no notes 💅

then there's unfocus_current_field — she removes the focus from the current field of the form. and in that state? inquiries via current_field shall return a NULL pointer. so like, nobody's home, the field is unbothered, the vibes are empty 😭

set_form_page sets the form's page number — literally goes to page n of the form. main character behavior, turning the page 📖✨

form_page returns the form's current page number. that's it, that's the function, she's simple and she serves 🫶

and field_index returns the index of the field in the field array of the form it is connected to. > but bestie, heads up: it returns ERR if the argument is the null pointer or if the field is not connected 💀 no field, no index, periodt.

---

⭐ RETURN VALUE ⭐

except for form_page, every one of these routines returns one of the following:

• E_OK — the routine succeeded. slay ✅
• E_BAD_ARGUMENT — routine detected an incorrect or out-of-range argument. the argument was giving... wrong 🙈
• E_BAD_STATE — routine was called from an initialization or termination function. wrong time, wrong place, read the room 💀
• E_INVALID_FIELD — contents of a field are not valid. not valid, not cute, not on my watch ✋
• E_REQUEST_DENIED — the form driver could not process the request. she said no 💅
• E_SYSTEM_ERROR — system error occurred (see errno(3)). the system is going through something 😭

---

🌈 PORTABILITY 🌈

these routines emulate the System V forms library. they were not supported on Version 7 or BSD versions. so if you're time-traveling backwards, don't expect her there 🕰️

also! unfocus_current_field is an ncurses extension — she's special, she's extra, she's ours 👑

---

💜 AUTHORS 💜

Juergen Pfeifer. manual pages and adaptation for new curses by Eric S. Raymond. absolute legends, we stan 🫶

---

🔥 SEE ALSO 🔥

• ncurses(3NCURSES)
• form(3FORM)

---

and that's the whole page, bestie!! go forth and page-turn responsibly 🌸

this has been ncurses 6.6, dated 2024-12-28, signing off with a little page(3FORM) energy ✨🎀🦋💖