Cdk(3)

✨ NAME ✨

cdk — the Curses Development Kit 🎀

---

🌈 SYNOPSIS 🌈

cc [ flag ... ] file ...  -lcdk [ library ... ]

#include <cdk.h>

okay so here's the deal, bestie 💅 Cdk hands you functions for a whole pile of pre-made curses widgets. To actually use them you gotta pull in the header file, cdk.h, into your source. No header, no widgets, no vibes. 🙈

The widgets you get from Cdk are listed below:

• Alphalist → cdk_alphalist(3)
• Button → cdk_button(3)
• Buttonbox → cdk_buttonbox(3)
• Calendar → cdk_calendar(3)
• Dialog → cdk_dialog(3)
• DoubleFloat Scale → cdk_dscale(3)
• Entry Field → cdk_entry(3)
• File Selector → cdk_fselect(3)
• File Viewer → cdk_viewer(3)
• Floating Scale → cdk_fscale(3)
• Floating Slider → cdk_fslider(3)
• Graph → cdk_graph(3)
• Histogram → cdk_histogram(3)
• Integer Scale → cdk_scale(3)
• Integer Slider → cdk_slider(3)
• Item List → cdk_itemlist(3)
• Label → cdk_label(3)
• Marquee → cdk_marquee(3)
• Matrix → cdk_matrix(3)
• Multiple Line Entry Field → cdk_mentry(3)
• Pulldown Menu → cdk_menu(3)
• Radio List → cdk_radio(3)
• Scrolling List → cdk_scroll(3)
• Scrolling Selection List → cdk_selection(3)
• Scrolling Window → cdk_swindow(3)
• Template → cdk_template(3)
• Unsigned Scale → cdk_uscale(3)
• Unsigned Slider → cdk_uslider(3)

and the rest of the manual pages? they're all about the supporting functions 🫶

• cdk_binding(3) — lays out how you create user definable key bindings ✨
• cdk_display(3) — shows you how to drop special display attributes, colors, and justification into a widget 💖
• cdk_draw(3) — the rundown on the functions used for drawing text and lines ✏️
• cdk_screen(3) — demonstrates using screens inside Cdk 🖥️
• cdk_misc(3) — the miscellaneous functions that ship with the Cdk library 🎁
• cdk_process(3) — demonstrates the pre- and post-process function class, iykyk 🔁

---

💜 DESCRIPTION 💜

Cdk is a library of functions that lets a programmer spin up a full screen interactive program, fast and with ease. Fr fr, it's giving convenience. The Cdk widgets come with the following features:

• Ncurses library. Instead of the standard curses library, Cdk can take full advantage of the colors Ncurses brings to the table 🌈. Wanna learn how to flex Cdk's color capabilities? Go see cdk_display(3).
• Key Bindings. Individual keys can be overridden with a callback. You set that callback up with the bindCDKObject function 🔑. More on this in cdk_binding(3).
• Pre and Post Processing. Certain widgets let the user trap a character before and after that character gets applied to the widget. That's how programmers "filter" character input 🧚. More on this in cdk_process(3).
• Self Test Widgets. Using the inject function class plus the activate function, programmers can make widgets test themselves 🤖. That means you can run automated tests on a final program. obsessed.
• Special Display Formats There are special character format commands you can insert into any string in Cdk, and the contents get mapped to a chtype (peep the curses manual page) with character attributes ✨. So if you want, you can put format types on each individual character. yes, each one.
• The Ability To Build Predefined Screens Widgets can be associated with any given screen. If more than one screen is defined, Cdk can "flip" from one screen to another with ease 🦋. The cdk_screen manual page has the details.

---

👑 STANDARD WIDGET BEHAVIOR 👑

Every single widget has a member of the structure called exitType. This member tells you how the widget exited. The page says there are three values to check for… and then serves five, and honestly? we love a generous queen 💅. Anyway, here they all are:

• vNORMAL — the widget exited normally. This value gets set when the widget is handed the characters TAB or RETURN.
• vEARLY_EXIT — the widget exited early. This value gets set when characters like TAB or RETURN are injected into the widget via the injectCDKXXX function and the character that got injected does not exit the widget.
• vERROR — this one means an error came back from curses, e.g., if the terminal got disconnected 😭.
• vESCAPE_HIT — the user hit ESCAPE to leave the widget.
• vNEVER_ACTIVATED — this is the initial state of the value. It means the widget hasn't been activated yet 💀.

---

🌸 NOTES 🌸

The header file <cdk.h> automatically includes the header files <curses.h>, <stdlib.h>, <string.h>, <ctype.h>, <unistd.h>, <dirent.h>, <time.h>, <errno.h>, <pwd.h>, <grp.h>, <sys/stat.h>, and <sys/types.h>. and the <curses.h> header file includes <stdio.h> and <unctrl.h>. one header to rule them all, no cap 🎀

---

🔥 SEE ALSO 🔥

cdk_binding(3), cdk_display(3), cdk_draw(3), cdk_misc(3), cdk_process(3), cdk_screen(3)

---

and that's the whole page, bestie 💖 this one's from Cdk(3), the Library calls section, dated 2025-01-14. go build something iconic with it, you've got this 🫶✨