cdk_<MODEL>slider(3)

📦
version 5.0.20260119 · 4 versions
, in ubuntu resolute, ubuntu stonking

okay so you pulled up the manual for cdk_<MODEL>slider(3) — it's from the Library calls section, and bestie, it's giving slider widget energy. let's go 💅

✨ NAME ✨

cdk_<MODEL>slider — it's the Cdk slider widget, and its type is <CTYPE>. no cap.

🦋 SYNOPSIS 🦋

compile with -lcdk and include <cdk.h>, then use these functions. here's the whole lineup, exactly as the header gods wrote it:

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

       #include <cdk.h>

       int activateCDK<MIXED> (
                      CDK<UPPER> *slider,
                      chtype *actions);

       void destroyCDK<MIXED> (
                      CDK<UPPER> *slider);

       void drawCDK<MIXED> (
                      CDK<UPPER> *slider,
                      boolean box);

       void eraseCDK<MIXED> (
                      CDK<UPPER> *slider);

       boolean getCDK<MIXED>Box (
                      CDK<UPPER> *slider);
                      #if <FLOAT>

       int getCDK<MIXED>Digits (
                      CDK<UPPER> *scale);
                      #endif <FLOAT>

       <CTYPE> getCDK<MIXED>HighValue (
                      CDK<UPPER> *slider);

       <CTYPE> getCDK<MIXED>LowValue (
                      CDK<UPPER> *slider);

       <CTYPE> getCDK<MIXED>Value (
                      CDK<UPPER> *slider);

       <CTYPE> injectCDK<MIXED> (
                      CDK<UPPER> *slider,
                      chtype input);

       void moveCDK<MIXED> (
                      CDK<UPPER> *slider,
                      int xpos,
                      int ypos,
                      boolean relative,
                      boolean refresh);

       CDK<UPPER> *newCDK<MIXED> (
                      CDKSCREEN *cdkscreen,
                      int xpos,
                      int ypos,
                      const char *title,
                      const char *label,
                      chtype fillerCharacter,
                      int fieldWidth,
                      int currentValue,
                      <CTYPE> lowValue,
                      <CTYPE> highValue,
                      <CTYPE> increment,
                      <CTYPE> fastIncrement,
                      #if <FLOAT>
                      int digits,
                      #endif <FLOAT>
                      boolean box,
                      boolean shadow);

       void positionCDK<MIXED> (
                      CDK<UPPER> *slider);

       void setCDK<MIXED> (
                      CDK<UPPER> *slider,
                      <CTYPE> lowValue,
                      <CTYPE> highValue,
                      <CTYPE> currentValue,
                      boolean box);

       void setCDK<MIXED>BackgroundAttrib (
                      CDK<UPPER> *slider,
                      chtype attribute);

       void setCDK<MIXED>BackgroundColor (
                      CDK<UPPER> *slider,
                      const char * color);

       void setCDK<MIXED>Box (
                      CDK<UPPER> *slider,
                      boolean boxWidget);

       void setCDK<MIXED>BoxAttribute (
                      CDK<UPPER> *slider,
                      chtype character);
                      #if <FLOAT>

       void setCDK<MIXED>Digits (
                      CDK<UPPER> *scale,
                      int digits);
                      #endif <FLOAT>

       void setCDK<MIXED>HorizontalChar (
                      CDK<UPPER> *slider,
                      chtype character);

       void setCDK<MIXED>LLChar (
                      CDK<UPPER> *slider,
                      chtype character);

       void setCDK<MIXED>LRChar (
                      CDK<UPPER> *slider,
                      chtype character);

       void setCDK<MIXED>LowHigh (
                      CDK<UPPER> *slider,
                      <CTYPE> lowValue,
                      <CTYPE> highValue);

       void setCDK<MIXED>PostProcess (
                      CDK<UPPER> *slider,
                      PROCESSFN callback,
                      void * data);

       void setCDK<MIXED>PreProcess (
                      CDK<UPPER> *slider,
                      PROCESSFN callback,
                      void * data);

       void setCDK<MIXED>ULChar (
                      CDK<UPPER> *slider,
                      chtype character);

       void setCDK<MIXED>URChar (
                      CDK<UPPER> *slider,
                      chtype character);

       void setCDK<MIXED>Value (
                      CDK<UPPER> *slider,
                      <CTYPE> value);

       void setCDK<MIXED>VerticalChar (
                      CDK<UPPER> *slider,
                      chtype character);

💖 DESCRIPTION 💖

so basically the Cdk slider widget creates a visual slider box with a label and a slider field. the functions below? they create or manipulate that Cdk slider box widget. periodt.

✨ AVAILABLE FUNCTIONS ✨

okay bestie, buckle UP, this is the whole roster of functions you get with this widget, and yes we're going through every single one, no skipping 💅

🦋 activateCDK<MIXED>

activates the slider widget and lets your user actually interact with it. main character moment fr.

  • the parameter slider is a pointer to a non-NULL slider widget. don't be passing me a NULL, I will not be okay 😭
  • if the actions parameter gets passed with a non-NULL value, then the characters sitting in that array get injected into the widget.

to activate the widget interactively, you pass in a NULL pointer for actions. that's the move.

so here's the tea on what comes back: if the character entered into this widget is RETURN or TAB, then this function returns a value from the low value to the high value. and it also sets the widget data exitType to vNORMAL ✨

but if the character entered into this widget was ESCAPE, then the widget returns the unknown<DTYPE> value (peep the cdk_objs.h header file for that one). and the widget data exitType gets set to vESCAPE_HIT 💀

🧚 destroyCDK<MIXED>

removes the widget from the screen and frees the memory the object used. it's giving cleanup era. goodbye, you were iconic 🫶

🌸 drawCDK<MIXED>

draws the slider widget on the screen. if the box option is true, the widget gets drawn with a box around it. cute little frame, we love to see it.

🎀 eraseCDK<MIXED>

removes the widget from the screen. but bestie listen — this does NOT destroy the widget. it just leaves the room, it's still alive, okay?? huge difference, do not confuse them 🙈

⭐ getCDK<MIXED>Box

returns true if the widget will be drawn with a box around it.

#if <FLOAT>

💜 getCDK<MIXED>Digits

returns the number of digits shown after the decimal point for the box value.

#endif <FLOAT>

🌈 getCDK<MIXED>HighValue

returns the high value of the slider widget. the ceiling, the limit, the top of the mountain.

🍓 getCDK<MIXED>LowValue

returns the low value of the slider widget. the floor, the basement, the starting vibe.

✨ getCDK<MIXED>Value

returns the current value of the widget. like, right now, in this exact moment. the now-value.

👑 injectCDK<MIXED>

injects a single character into the widget. just one. single. character. it's giving minimalism.

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

the return value and the side-effect (aka setting the widget data exitType) depend on which character you injected:

  • RETURN or TAB — the function returns a value ranging from the slider's low value to the slider's high value. the widget data exitType gets set to vNORMAL.
  • ESCAPE — the function returns the unknown<DTYPE> value (check the cdk_objs.h header file). the widget data exitType gets set to vESCAPE_HIT.

otherwise, unless it's been modified by preprocessing, postprocessing or key bindings, the function returns the unknown<DTYPE> value (again, cdk_objs.h header file, you know the drill). and the widget data exitType gets set to vEARLY_EXIT.

🦋 moveCDK<MIXED>

moves the given widget to the given position. relocating, rebranding, fresh start ✨

  • 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. but 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. and not the fun kind of weird 😭
  • the final parameter refresh is a boolean value which states whether the widget will get refreshed after the move. yes or no, glow-up or stay as you were.

🌸 newCDK<MIXED>

this function creates a slider widget and returns a pointer to it. brand new, factory fresh, main character energy 👑

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.
  • 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. multi-line title? slay.
  • label — is the string to display in the label of the slider field.
  • fillerCharacter — is the character to be used to draw the slider bar in the field.
  • fieldWidth — controls the width of the widget. if you provide a value of zero the widget will be created with the full width of the screen. if you provide a negative value, the widget will be created the full width minus the value provided.
  • currentValue — is the value of the slider field when the widget is activated.
  • lowValue and highValue — are the low and high values of the widget respectively. they're a package deal, besties.
  • increment — is the regular increment value.
  • fastIncrement — is the accelerated increment value. zoom zoom.
  • box — is true if the widget should be drawn with a box around it.
  • shadow — turns the shadow on or off around this widget. spooky-season optional.
if the widget could not be created then a NULL pointer is returned. no widget, just vibes and disappointment 💀

🎀 positionCDK<MIXED>

allows the user to move the widget around the screen via the cursor/keypad keys. see cdk_position (3) for key bindings.

🌈 setCDK<MIXED>

lets the programmer modify certain elements of an existing slider widget. the parameter names correspond to the same parameter names listed in the newCDK<MIXED> function. so yeah, everything you set up at birth, you can tweak later. glow-up unlocked.

💜 setCDK<MIXED>BackgroundAttrib

sets the background attribute of the widget.

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

⭐ setCDK<MIXED>BackgroundColor

sets the background color of the widget.

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

see cdk_display (3).

🍓 setCDK<MIXED>Box

sets whether the widget will be drawn with a box around it. box on, box off, box optional, box iconic.

✨ setCDK<MIXED>BoxAttribute

function sets the attribute of the box.

#if <FLOAT>

🧚 setCDK<MIXED>Digits

sets the number of digits shown after the decimal point for the box value.

#endif <FLOAT>

🦋 setCDK<MIXED>HorizontalChar

sets the horizontal drawing character for the box to the given character.

💜 setCDK<MIXED>LLChar

sets the lower left hand corner of the widget's box to the given character. corner glow-up, lower-left edition.

🌸 setCDK<MIXED>LRChar

sets the lower right hand corner of the widget's box to the given character. lower-right, we see you.

🎀 setCDK<MIXED>LowHigh

sets the low and high values of the widget. yes both, at the same time, together, as a duo 💖

👑 setCDK<MIXED>PostProcess

allows the user to have the widget call a function after the key has been applied to the widget.

  • 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).

🍓 setCDK<MIXED>PreProcess

allows the user to have the widget call a function after a key is hit and before the key is applied to the widget.

  • 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).

⭐ setCDK<MIXED>ULChar

sets the upper left hand corner of the widget's box to the given character.

🌈 setCDK<MIXED>URChar

sets the upper right hand corner of the widget's box to the given character.

✨ setCDK<MIXED>Value

sets the current value of the widget. you're in charge now.

🧚 setCDK<MIXED>VerticalChar

sets the vertical drawing character for the box to the given character.

and bestie, we are not done yet, there is still more coming, do not close the tab 🙈

🎀 KEY BINDINGS 🎀

Okay bestie, so once the widget is activated, there's a whole set of default key bindings just sitting there waiting to help you enter or manipulate the info fast. Here's the whole roster for this widget, no skips, no cuts 💅

  • Down Arrow — decrements the field by the normal decrement value
  • Up Arrow — increments the field by the normal increment value
  • u — increments the field by the normal increment value
  • Prev Page — decrements the field by the accelerated decrement value
  • U — decrements the field by the accelerated decrement value
  • Ctrl-B — decrements the field by the accelerated decrement value
  • Next Page — increments the field by the accelerated increment value
  • D — increments the field by the accelerated increment value
  • Ctrl-F — increments the field by the accelerated increment value
  • Home — sets the value to the low value
  • g — sets the value to the low value
  • End — sets the value to the high value
  • G — sets the value to the high value
  • $ — sets the value to the high value
  • Return — exits the widget and returns the current value. This also sets the widget data exitType to vNORMAL.
  • Tab — exits the widget and returns the current value. This also sets the widget data exitType to vNORMAL.
  • Escape — exits the widget and returns the unknown<DTYPE> value (peep the cdk_objs.h header file). This also sets the widget data exitType to vESCAPE_HIT.
  • Ctrl-R — refreshes the screen
fr fr heads up: that Escape one is your little escape hatch, and it hands back the unknown<DTYPE> value — not your current value. Don't get it twisted 🙈

Now, plot twist — if the cursor is not pointing at the field's value, a whole different set of bindings kicks in. You can use the left/right arrows to move the cursor onto the field's value and then modify it by typing characters to replace the digits and the sign. Iconic, honestly ✨

  • Left Arrow — decrements the scale by the normal value
  • Right Arrow — increments the scale by the normal value
  • d — decrements the scale by the normal value
  • D — increments the scale by the accelerated value
  • - — decrements the scale by the normal value
  • + — increments the scale by the normal value
  • 0 — sets the scale to the low value

🌈 SEE ALSO 🌈

Go read these too, they're the friend group of this page, no cap:

and that's a wrap on the whole page, bestie 🫶 this was cdk_<MODEL>slider(3), dated 2025-10-13 — go forth and slide responsibly, you absolute main character 👑💖

📦 where this page comes from