cdk_slider(3)

📦
version 5.0.20250116 · 3 versions
, in debian trixie, ubuntu questing

💖 cdk_slider — Library calls 💖

okay bestie, welcome to the cdk_slider page, it's the Cdk slider widget and yes it's type int, we're all about them integers here, no cap 🎀

✨ NAME ✨

cdk_slider — the Cdk slider widget (type int). literally that's it. a slider. for ints. iconic. 💅

🌸 SYNOPSIS 🌸

so first you gotta link the library, obviously:

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

and pull in the header, don't forget it bestie:

#include <cdk.h>

then here's the whole roster of functions, verbatim, no edits, slay 🫶:

int activateCDKSlider (
               CDKSLIDER *slider,
               chtype *actions);

void destroyCDKSlider (
               CDKSLIDER *slider);

void drawCDKSlider (
               CDKSLIDER *slider,
               boolean box);

void eraseCDKSlider (
               CDKSLIDER *slider);

boolean getCDKSliderBox (
               CDKSLIDER *slider);

int getCDKSliderHighValue (
               CDKSLIDER *slider);

int getCDKSliderLowValue (
               CDKSLIDER *slider);

int getCDKSliderValue (
               CDKSLIDER *slider);

int injectCDKSlider (
               CDKSLIDER *slider,
               chtype input);

void moveCDKSlider (
               CDKSLIDER *slider,
               int xpos,
               int ypos,
               boolean relative,
               boolean refresh);

CDKSLIDER *newCDKSlider (
               CDKSCREEN *cdkscreen,
               int xpos,
               int ypos,
               const char *title,
               const char *label,
               chtype fillerCharacter,
               int fieldWidth,
               int currentValue,
               int lowValue,
               int highValue,
               int increment,
               int fastIncrement,
               boolean box,
               boolean shadow);

void positionCDKSlider (
               CDKSLIDER *slider);

void setCDKSlider (
               CDKSLIDER *slider,
               int lowValue,
               int highValue,
               int currentValue,
               boolean box);

void setCDKSliderBackgroundAttrib (
               CDKSLIDER *slider,
               chtype attribute);

void setCDKSliderBackgroundColor (
               CDKSLIDER *slider,
               const char * color);

void setCDKSliderBox (
               CDKSLIDER *slider,
               boolean boxWidget);

void setCDKSliderBoxAttribute (
               CDKSLIDER *slider,
               chtype character);

void setCDKSliderHorizontalChar (
               CDKSLIDER *slider,
               chtype character);

void setCDKSliderLLChar (
               CDKSLIDER *slider,
               chtype character);

void setCDKSliderLRChar (
               CDKSLIDER *slider,
               chtype character);

void setCDKSliderLowHigh (
               CDKSLIDER *slider,
               int lowValue,
               int highValue);

void setCDKSliderPostProcess (
               CDKSLIDER *slider,
               PROCESSFN callback,
               void * data);

void setCDKSliderPreProcess (
               CDKSLIDER *slider,
               PROCESSFN callback,
               void * data);

void setCDKSliderULChar (
               CDKSLIDER *slider,
               chtype character);

void setCDKSliderURChar (
               CDKSLIDER *slider,
               chtype character);

void setCDKSliderValue (
               CDKSLIDER *slider,
               int value);

void setCDKSliderVerticalChar (
               CDKSLIDER *slider,
               chtype character);

🦋 DESCRIPTION 🦋

okay so here's the vibe: the Cdk slider widget makes a visual slider box — you get a label and a slider field, all pretty and interactive ✨

and then all the functions below? they're the ones that create the slider box or manipulate it. that's the whole deal. that's the assignment. 💖

ngl this page is long so it's split into parts — more coming, don't go anywhere bestie 🧚

✨ AVAILABLE FUNCTIONS ✨

Okay bestie, this is the whole lineup of functions you can call on a slider widget. Each one is a little tool in your Unix toolkit. Let's go function by function, no skips, no cap. 💅

✨ activateCDKSlider ✨

This one activates the slider widget and lets the user actually interact with it. It's giving main character energy.

  • slider — a pointer to a non-NULL slider widget. Don't pass garbage, okay?
  • actions — if you pass this with a non-NULL value, the characters in the array get injected into the widget. If you want the widget to be interactive, pass a NULL pointer for actions. That's the vibe.

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. It also sets the widget data exitType to vNORMAL. Slay.

If the character entered into this widget was ESCAPE, then the widget returns the unknownInt value (peep the cdk_objs.h header file). The widget data exitType is set to vESCAPE_HIT. Not the vibe, but okay.

✨ destroyCDKSlider ✨

This one removes the widget from the screen and frees the memory the object used. It's the ultimate cleanup, periodt. 🧹

✨ drawCDKSlider ✨

Draws the slider widget on the screen. If the box option is true, the widget is drawn with a box. Aesthetic.

✨ eraseCDKSlider ✨

Removes the widget from the screen. This does NOT destroy the widget. So don't get it twisted.

✨ getCDKSliderBox ✨

Returns true if the widget will be drawn with a box around it. Simple as.

✨ getCDKSliderHighValue ✨

Returns the high value of the slider widget. The ceiling, the limit, the top tier.

✨ getCDKSliderLowValue ✨

Returns the low value of the slider widget. The floor, the basement, the lowkey.

✨ getCDKSliderValue ✨

Returns the current value of the widget. What's the vibe right now? This tells you.

✨ injectCDKSlider ✨

Injects a single character into the widget. Like a little text message straight to the slider.

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

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

  • 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 is set to vNORMAL. 💖
  • ESCAPE — the function returns the unknownInt value (see the cdk_objs.h header file). The widget data exitType is set to vESCAPE_HIT.

Otherwise, unless modified by preprocessing, postprocessing, or key bindings, the function returns the unknownInt value (see the cdk_objs.h header file). The widget data exitType is set to vEARLY_EXIT. Okay so it's giving early exit, noted.

✨ moveCDKSlider ✨

Moves the given widget to the given position. It's giving relocation.

  • xpos and ypos — 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.

  • 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). Fr fr, don't do it.
  • refresh — the final parameter, a boolean value which states whether the widget will get refreshed after the move. Do you want a glow-up or not?

✨ newCDKSlider ✨

This function creates a slider widget and returns a pointer to it. Iconic. 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? She's flexible.
  • 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.
  • increment — is the regular increment value.
  • fastIncrement — is the accelerated increment value.
  • 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. Not the slay we wanted.

✨ positionCDKSlider ✨

Allows the user to move the widget around the screen via the cursor/keypad keys. See cdk_position (3) for key bindings. Go ahead, drag her around, she doesn't mind.

✨ setCDKSlider ✨

Lets the programmer modify certain elements of an existing slider widget. The parameter names correspond to the same parameter names listed in the newCDKSlider function. So you already know the drill.

✨ setCDKSliderBackgroundAttrib ✨

Sets the background attribute of the widget.

The parameter attribute is a curses attribute, e.g., A_BOLD. Bold background? We love a bold choice.

✨ setCDKSliderBackgroundColor ✨

Sets the background color of the widget.

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

See cdk_display (3). Color her world. 🌈

✨ setCDKSliderBox ✨

Sets whether the widget will be drawn with a box around it. Box or no box, that is the question.

✨ setCDKSliderBoxAttribute ✨

This function sets the attribute of the box. The box's whole personality.

✨ setCDKSliderHorizontalChar ✨

Sets the horizontal drawing character for the box to the given character. Customize the horizontal lines, bestie.

✨ setCDKSliderLLChar ✨

Sets the lower left hand corner of the widget's box to the given character. Corner customization, we love to see it.

✨ setCDKSliderLRChar ✨

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

✨ setCDKSliderLowHigh ✨

Sets the low and high values of the widget. Define her range, her limits, her whole spectrum.

✨ setCDKSliderPostProcess ✨

Allows the user to have the widget call a function after the key has been applied to the widget. It's giving aftercare, but for keys.

  • function — the callback function.
  • data — points to data passed to the callback function.

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

✨ setCDKSliderPreProcess ✨

Allows the user to have the widget call a function after a key is hit and before the key is applied to the widget. Pre-game, but make it code.

  • function — the callback function.
  • data — points to data passed to the callback function.

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

✨ setCDKSliderULChar ✨

Sets the upper left hand corner of the widget's box to the given character. Upper left corner, represent.

✨ setCDKSliderURChar ✨

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

✨ setCDKSliderValue ✨

Sets the current value of the widget. Change her mind, change her value.

✨ setCDKSliderVerticalChar ✨

Sets the vertical drawing character for the box to the given character. Vertical lines, but make it custom. 💅

⌨️ KEY BINDINGS ⌨️

Okay bestie, so once the widget is activated (main character moment, we love to see it), there's a whole lil squad of default key bindings ready to help your user slam info in fast or fiddle with it. Here's the full rundown of keys and what they do for this widget 💅

  • 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 unknownInt value (peep the cdk_objs.h header file for that one). This also sets the widget data exitType to vESCAPE_HIT 🚪
  • Ctrl-R — refreshes the screen 🔄

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

  • 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
lowkey obsessed with how D does two totally different things depending on where your cursor is. it's giving versatility, fr fr 👑

👀 SEE ALSO 👀

and that's a wrap on cdk_slider(3) bestie!! 🎀🦋 this whole thing is from the cdk fam, dated 2025-01-14 — go forth and slide those sliders, you absolute icon 💖✨

📦 where this page comes from