cdk_swindow(3)

📦
version 5.0.20260119 · 4 versions
, in debian trixie, fedora 43, fedora 44, nixos 26.05, nixpkgs unstable, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 cdk_swindow(3) — Library calls 💖

okay bestie, sit DOWN, because we're about to talk about the scrolling window widget and honestly? it's giving main character energy. this is a <pink>library call</pink> from the Cdk crew, so grab your cc and let's go ✨

🌸 NAME 🌸

cdk_swindow — the Cdk scrolling window widget, aka the little box that just keeps scrolling and never misses 💅

✨ SYNOPSIS ✨

lowkey the whole vibe is: you compile with the flag, you include the header, you call the functions. iconic. no cap.

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

#include <cdk.h>

void activateCDKSwindow (
               CDKSWINDOW *swindow,
               chtype * actions);

void addCDKSwindow (
               CDKSWINDOW *swindow,
               const char *info,
               int insertPosition);

void cleanCDKSwindow (
               CDKSWINDOW *swindow);

int execCDKSwindow (
               CDKSWINDOW *swindow,
               const char * command,
               int insertPosition);

void destroyCDKSwindow (
               CDKSWINDOW *swindow);

void drawCDKSwindow (
               CDKSWINDOW *swindow,
               boolean box);

void dumpCDKSwindow (
               CDKSWINDOW *swindow,
               const char *filename);

void eraseCDKSwindow (
               CDKSWINDOW *swindow);
               void execCDKSwindow (
               CDKSWINDOW *swindow,
               char *command,
               int insertPosition);
               boolean getCDKSwindowBox (
               CDKSWINDOW *swindow);

chtype **getCDKSwindowContents (
               CDKSWINDOW *swindow);

int injectCDKSwindow (
               CDKSWINDOW *swindow,
               chtype input);

void jumpToLineCDKSwindow (
               CDKSWINDOW *swindow,
               int line);

void loadCDKSwindowInformation (
               CDKSWINDOW *swindow);

void moveCDKSwindow (
               CDKSWINDOW *swindow,
               int xpos,
               int ypos,
               boolean relative,
               boolean refresh);

CDKSWINDOW *newCDKSwindow (
               CDKSCREEN *cdkscreen,
               int xpos,
               int ypos,
               int height,
               int width,
               const char *title,
               int saveLines,
               boolean box,
               boolean shadow);

void positionCDKSwindow (
               CDKSWINDOW *swindow);

void saveCDKSwindowInformation (
               CDKSWINDOW *swindow);

void setCDKSwindow (
               CDKSWINDOW *swindow,
               CDK_CONST char **info,
               int lines,
               boolean box);

void setCDKSwindowBackgroundAttrib (
               CDKSWINDOW *swindow,
               chtype attribute);

void setCDKSwindowBackgroundColor (
               CDKSWINDOW *swindow,
               const char * color);

void setCDKSwindowBox (
               CDKSWINDOW *swindow,
               boolean boxWidget);

void setCDKSwindowBoxAttribute (
               CDKSWINDOW *swindow,
               chtype character);

void setCDKSwindowContents (
               CDKSWINDOW *swindow,
               char **info,
               int lines);

void setCDKSwindowHorizontalChar (
               CDKSWINDOW *swindow,
               chtype character);

void setCDKSwindowLLChar (
               CDKSWINDOW *swindow,
               chtype character);

void setCDKSwindowLRChar (
               CDKSWINDOW *swindow,
               chtype character);

void setCDKSwindowPostProcess (
               CDKSWINDOW *swindow,
               PROCESSFN callback,
               void * data);

void setCDKSwindowPreProcess (
               CDKSWINDOW *swindow,
               PROCESSFN callback,
               void * data);

void setCDKSwindowULChar (
               CDKSWINDOW *swindow,
               chtype character);

void setCDKSwindowURChar (
               CDKSWINDOW *swindow,
               chtype character);

void setCDKSwindowVerticalChar (
               CDKSWINDOW *swindow,
               chtype character);

void trimCDKSwindow (
               CDKSWINDOW *swindow,
               int start,
               int finish);
heads up bestie 🫶 notice how eraseCDKSwindow in that list kind of runs straight into another execCDKSwindow declaration with the wonky indentation? yeah, that's exactly how the page hands it to us. i'm not touching it, i'm not "fixing" it, i'm just delivering it to you fr fr. also yes, execCDKSwindow shows up twice — once returning int with const char * command, once returning void with char *command. that's the tea. ☕

🦋 DESCRIPTION 🦋

so what IS this thing? the Cdk scrolling window — lovingly nicknamed swindow — is literally built to display messages. that's the whole job. it shows your messages, it scrolls, it serves cunt, periodt. 💅

and the functions listed up there? they're your lil toolbox for creating and manipulating the Cdk swindow box widget. new ones, setters, getters, drawers, movers, destroyers — the full roster, no one left out 👑

more parts coming, don't go anywhere bestie 🌈

✨ AVAILABLE FUNCTIONS ✨

Okay bestie, here's the whole squad of functions you can call on your swindow widget. Each one is a little legend, and we're gonna go through every single one. No skips. 💅

✨ activateCDKSwindow ✨

This function activates the swindow widget and lets the user actually interact with it. It's the go live moment. 🎬

  • The parameter swindow is a pointer to a non-NULL swindow widget.
  • If the actions parameter is passed with a non-NULL value, the characters in the array will be injected into the widget.

To activate the widget interactively, pass in a NULL pointer for actions.

If the character entered into this widget is RETURN or TAB, then this function will return 1. It will also set the widget data exitType to vNORMAL.

If the character entered into this widget was ESCAPE, then the widget will return a value of -1 and the widget data exitType will be set to vESCAPE_HIT.

✨ addCDKSwindow ✨

Adds information to a scrolling window. It's like dropping new messages into the group chat. 💬

  • The information is supplied by the info parameter. The information is immediately added to the scrolling window.
  • The position of the new information is governed by the value of the parameter insertPosition. This parameter may be two values: TOP or BOTTOM.

✨ cleanCDKSwindow ✨

Clears the information from the window. Poof, gone. ✨

✨ destroyCDKSwindow ✨

Removes the widget from the screen and frees the memory the object used. It's the ultimate goodbye. 👋

✨ drawCDKSwindow ✨

Draws the swindow widget on the screen. It's the glow-up moment. ✨

If the box parameter is true, the widget is drawn with a box.

✨ dumpCDKSwindow ✨

Saves the contents of the scrolling window into the file specified by the filename parameter. It returns -1 on failure, and the number of lines saved if the dump was successful. Like saving your bestie's texts for later. 📱

✨ eraseCDKSwindow ✨

Removes the widget from the screen. This does NOT destroy the widget. It's just hiding, not deleting. 🙈

✨ execCDKSwindow ✨

Allows the user to execute a shell command and have the output of the shell command direct itself to the scrolling window. Shell command? In my widget? It's more likely than you think. 🐚

  • The command parameter is the command to execute.
  • The insertPosition parameter tells where the output will be inserted within the scrolling window.

✨ getCDKSwindowBox ✨

Returns true if the widget will be drawn with a box around it. Box check! 📦

✨ getCDKSwindowContents ✨

Returns the contents of the scrolling window. It's giving "what's in the box?" 📦

The parameter lines will be set to the number of lines returned.

✨ injectCDKSwindow ✨

Injects a single character into the widget. Like a little keyboard shortcut for your code. 💉

  • The parameter swindow is a pointer to a non-NULL swindow widget.
  • The parameter character is the character to inject into the widget.

The return value and side-effect (setting the widget data exitType) depend upon the injected character:

  • RETURN or TAB: the function returns 1. The widget data exitType is set to vNORMAL.
  • ESCAPE: the function returns -1. The widget data exitType is set to vESCAPE_HIT.
  • Otherwise: unless modified by preprocessing, postprocessing or key bindings, the function returns -1. The widget data exitType is set to vEARLY_EXIT.

✨ jumpToLineCDKSwindow ✨

Moves the scrolling window to the given line. Like scrolling straight to the tea. ☕

The parameter line may be an integer or one of the two predefined values TOP and BOTTOM.

✨ loadCDKSwindowInformation ✨

Allows the user to load the contents of a file into the scrolling window. This function is interactive, and will ask for a filename. It's the "choose file" button of the widget world. 📂

✨ moveCDKSwindow ✨

Moves the given widget to the given position. It's the widget's main character travel arc. ✈️

  • The parameters xpos and ypos are the new position of the widget.

The parameter xpos may be an integer or one of the pre-defined values TOP, BOTTOM, and CENTER.

The parameter ypos may be an integer or one of the pre-defined values LEFT, RIGHT, and CENTER.

  • The parameter relative states whether the xpos/ypos pair is a relative move or an absolute move.

For example, if xpos = 1 and ypos = 2 and relative = TRUE, then the widget would move one row down and two columns right. If the value of relative was FALSE, then the widget would move to the position (1,2).

Do not use the values TOP, BOTTOM, LEFT, RIGHT, or CENTER when relative = TRUE (weird things may happen).
  • The final parameter refresh is a boolean value which states whether the widget will get refreshed after the move.

✨ newCDKSwindow ✨

Creates a swindow widget and returns a pointer to it. It's the birth of a star. 🌟

Parameters:

  • screen — is the screen you wish this widget to be placed in.
  • xpos — controls the placement of the object along the horizontal axis. It may be an integer or one of the pre-defined values LEFT, RIGHT, and CENTER.
  • ypos — controls the placement of the object along the vertical axis. It may be an integer or one of the pre-defined values TOP, BOTTOM, and CENTER.
  • height and width — control the height and width of the widget. If you provide a value of zero for either of the height or the width, the widget will be created with the full width and height of the screen. If you provide a negative value, the widget will be created the full height or width minus the value provided.
  • title — is the string to display at the top of the widget. The title can be more than one line; just provide a carriage return character at the line break.
  • saveLines — is the number of lines to save before throwing information away.
  • box — is true if the widget should be drawn with a box around it.
  • shadow — turns the shadow on or off around this widget.

If the widget could not be created then a NULL pointer is returned.

✨ positionCDKSwindow ✨

Allows the user to move the widget around the screen via the cursor/keypad keys. See cdk_position (3) for key bindings. It's the widget's dance floor. 💃

✨ saveCDKSwindowInformation ✨

Allows the user to save the contents of the scrolling window into a file. This function is interactive, and will ask for a filename. Like saving a screenshot of your fave convo. 📸

✨ setCDKSwindow ✨

Lets the programmer modify certain elements of an existing swindow widget. It's the customization era. 🎨

  • The parameter info is a char ** of the information to set in the scrolling window; lines is the number of lines being added.
  • The other parameter names correspond to the same parameter names listed in the newCDKSwindow function.

✨ setCDKSwindowBackgroundAttrib ✨

Sets the background attribute of the widget. It's the aesthetic. 💅

The parameter attribute is a curses attribute, e.g., A_BOLD.

✨ setCDKSwindowBackgroundColor ✨

Sets the background color of the widget. It's giving mood board. 🌈

The parameter color is in the format of the Cdk format strings.

See cdk_display (3).

✨ setCDKSwindowBox ✨

Sets whether the widget will be drawn with a box around it. Box on or box off, you decide. 📦

✨ setCDKSwindowBoxAttribute ✨

Sets the attribute of the box. Fancy box, bestie. ✨

✨ setCDKSwindowContents ✨

Lets the programmer modify certain elements of an existing swindow widget. Content update! 📝

  • The parameter info is a char ** of the information to set in the scrolling window.
  • lines is the number of lines being added.

✨ setCDKSwindowHorizontalChar ✨

Sets the horizontal drawing character for the box to the given character. Horizontal line, but make it fashion. ➖

✨ setCDKSwindowLLChar ✨

Sets the lower left hand corner of the widget's box to the given character. Corner customization! 📐

✨ setCDKSwindowLRChar ✨

Sets the lower right hand corner of the widget's box to the given character. Another corner, another slay. 📐

✨ setCDKSwindowPostProcess ✨

Allows the user to have the widget call a function after the key has been applied to the widget. It's the after-party function. 🎉

  • The parameter function is the callback function.
  • The parameter data points to data passed to the callback function.

To learn more about post-processing see cdk_process(3).

✨ setCDKSwindowPreProcess ✨

Allows the user to have the widget call a function after a key is hit and before the key is applied to the widget. It's the pre-game. 🏋️

  • The parameter function is the callback function.
  • The parameter data points to data passed to the callback function.

To learn more about pre-processing see cdk_process(3).

✨ setCDKSwindowULChar ✨

Sets the upper left hand corner of the widget's box to the given character. Upper left, but make it cute. 📐

✨ setCDKSwindowURChar ✨

Sets the upper right hand corner of the widget's box to the given character. Upper right, iconic. 📐

✨ setCDKSwindowVerticalChar ✨

Sets the vertical drawing character for the box to the given character. Vertical line, serving looks. ➖

✨ trimCDKSwindow ✨

Removes information from a scrolling window. It's the cleanup era. 🧹

The parameters start and end state where to start cutting from and where to stop.

The first element in the scrolling window starts at index 0.

✨ KEY BINDINGS ✨

Okay so when this widget gets activated, there are default key bindings that help the user enter or manipulate the info quickly. Here's the full rundown of keys and their actions for this widget, bestie. No cap, every single one is here.

  • Left Arrow — scrolls the window left one column. smooth.
  • Right Arrow — scrolls the window right one column. smooth.
  • Up Arrow — scrolls the window up one row.
  • Down Arrow — scrolls the window down one row.
  • Prev Page, Ctrl-B, b, B — scroll the window backward one page. back it up.
  • Next Page, Ctrl-F, Space, f, F — scroll the window forward one page. go go go.
  • Home, | — scroll the list to the left margin.
  • End, $ — scroll the list to the right margin.
  • 1, <, g — move to the top of the scrolling window.
  • >, G — move to the bottom of the scrolling window.
  • l, L — load a file into the scrolling window.
  • s, S — save the contents of the scrolling window into a file.
  • Return — set the widget's exitType to vNORMAL, exit the widget and return 1.
  • Tab — set the widget's exitType to vNORMAL, exit the widget and return 1.
  • Escape — set the widget's exitType to vESCAPE_HIT, exit the widget and return -1.
  • Ctrl-L — refreshes the screen.
Not me noticing: Escape is the dramatic exit, while Return and Tab are the "we're so back" exits. Choose your fighter 💅

💖 SEE ALSO 💖

This was cdk_swindow(3), dated 2025-01-14. Bye bestie, stay iconic! 💖✨

📦 where this page comes from