form_hook(3X)

✨ form_hook — bestie, we're setting HOOKS ✨

okay so first of all, the vibe: this page lives in the 3X library calls section of the manual, and it's literally called form_hook. That's the whole name. We're talking hooks that get invoked automatically by your application, no cap. 🪝💖

---

🌸 SYNOPSIS 🌸

#include <form.h>

int set_field_init(FORM *form, Form_Hook func);
Form_Hook field_init(const FORM *form);

int set_field_term(FORM *form, Form_Hook func);
Form_Hook field_term(const FORM *form);

int set_form_init(FORM *form, Form_Hook func);
Form_Hook form_init(const FORM *form);

int set_form_term(FORM *form, Form_Hook func);
Form_Hook form_term(const FORM *form);

---

💅 DESCRIPTION 💅

So basically these functions let you attach hook functions — lil callback besties — that get called at ✨various points✨ during the automatic processing of input event codes by form_driver. It's giving "surprise, you're running now". 🎀

🦋 set_field_init

sets a hook to be called at form-post time and each time the selected field changes (after the change). Not before. After. We're very precise here. 💖

🦋 field_init

returns the current field init hook, if any — and it's NULL if there is no such hook. No hook? No problem, just NULL. 🙈

🦋 set_field_term

sets a hook to be called at form-unpost time and each time the selected field changes (before the change). Yeah, this one's the before twin. Iconic symmetry honestly. ✨

🦋 field_term

returns the current field term hook, if any — NULL if there is no such hook. 🫶

🦋 set_form_init

sets a hook to be called at form-post time and just after a page change once it is posted. Page change girlies, this one's for you. 📄💫

🦋 form_init

returns the current form init hook, if any — NULL if there is no such hook. 💜

🦋 set_form_term

sets a hook to be called at form-unpost time and just before a page change once it is posted. Again with the before/after duality, we love a theme. 🔥

🦋 form_term

returns the current form term hook, if any — NULL if there is no such hook. 🌈

---

👑 RETURN VALUE 👑

The routines that return pointers return NULL on error. Everybody else returns one of these cuties:

• E_OK — the routine succeeded. slay. ✅
• E_SYSTEM_ERROR — a system error occurred (peep errno(3) for the deets). 😭

---

🌍 PORTABILITY 🌍

These routines emulate the System V forms library. They were not supported on Version 7 or BSD versions. So like… if you're on ancient BSD, this is not your moment, bestie. 💀

---

🫶 AUTHORS 🫶

Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. Kings, both of them. 👑

---

🔗 SEE ALSO 🔗

• curses(3X)
• form(3X)

---

and that's the whole page, bestie 💖 this one shipped with ncurses 6.6 and it's dated 2024-12-28 — so go forth, set those hooks, and let form_driver do its lil automatic thing. periodt. ✨🎀