cdk_scale(3)

NAME
newCDKScale, activateCDKScale, injectCDKScale, setCDKScale, setCDKScaleLowHigh, getCDKScaleLowValue, getCDKScaleHighValue, setCDKScaleValue, getCDKScaleValue, setCDKScaleBox, getCDKScaleBox, setCDKScaleULChar, setCDKScaleURChar, setCDKScaleLLChar, setCDKScaleLRChar, setCDKScaleVerticalChar, setCDKScaleHorizontalChar, setCDKScaleBoxAttribute, setCDKScaleBackgroundColor, drawCDKScale, eraseCDKScale, destroyCDKScale, setCDKScalePreProcess, setCDKScalePostProcess
 - Creates a managed curses scale widget.

SYNOPSIS

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

#include <cdk.h>

CDKSCALE *newCDKScale (CDKSCREEN *cdkscreen, int xpos, int ypos, char *title, char *label, chtype fieldAttribute, int fieldWidth, int currentValue, int lowValue, int highValue, int increment, int fastIncrement, boolean box, boolean shadow);

int activateCDKScale (CDKSCALE *scale, chtype *actions);

int injectCDKScale (CDKSCALE *scale, chtype input);

void setCDKScale (CDKSCALE *scale, int lowValue, int highValue, int currentValue, boolean box);

void setCDKScaleLowHigh (CDKSCALE *scale, int low, int high);

int getCDKScaleLowValue ((CDKSCALE *scale);

int getCDKScaleHighValue ((CDKSCALE *scale);

void setCDKScaleValue (CDKSCALE *scale, int value);

int getCDKScaleValue (CDKSCALE *scale);

void setCDKScaleBox (CDKSCALE *scale, boolean box);

boolean getCDKScaleBox (CDKSCALE *scale);

void setCDKScaleULChar (CDKSCALE *,scale, chtype character);

void setCDKScaleURChar (CDKSCALE *,scale, chtype character);

void setCDKScaleLLChar (CDKSCALE *,scale, chtype character);

void setCDKScaleLRChar (CDKSCALE *,scale, chtype character);

void setCDKScaleVerticalChar (CDKSCALE *,scale, chtype character);

void setCDKScaleHorizontalChar (CDKSCALE *,scale, chtype character);

void setCDKScaleBoxAttribute (CDKSCALE *,scale, chtype character);

void setCDKScaleBackgroundColor (CDKSCALE *,scale, char * color);

void moveCDKScale (CDKSCALE *scale, int box, int box, boolean relative, boolean refresh);

void positionCDKScale (CDKSCALE *scale);

void drawCDKScale (CDKSCALE *scale, boolean box);

void eraseCDKScale (CDKSCALE *scale);

void destroyCDKScale (CDKSCALE *scale);

void setCDKScalePreProcess (CDKSCALE *scale, PROCESSFN callback, void * data);

void setCDKScalePostProcess (CDKSCALE *scale, PROCESSFN callback, void * data);

void bindCDKObject (EObjectType widgetType, void *object, chtype key, BINDFN function, void *data);

DESCRIPTION
The Cdk scale widget creates a scale box with a label and a scale field. The following are functions which create or manipulate the Cdk scale box widget.

AVAILABLE FUNCTIONS
CDKSCALE *newCDKScale (CDKSCREEN *screen, int xpos, int ypos, char *title, char *label, chtype fieldAttribute, chtype fillerCharacter, EDisplayType displayType, int fieldWidth, int minimumLength, int maximumLength, boolean box, boolean shadow);
    This function creates a pointer to a scale widget. The screen parameter is the screen you wish this widget to be placed in. The parameter xpos controls the placement of the object along the horizontal axis. This parameter can accept an integer value or one of the pre-defined values of LEFT, RIGHT, and CENTER. The parameter ypos controls the placement of the object along the vertical axis. This parameter can accept an integer value or one of the pre-defined values of TOP, BOTTOM, and CENTER. The title parameter is the string which will be displayed at the top of the widget. The title can be more than one line; just provide a carriage return character at the line break. The label parameter is the string which will be displayed in the label of the scale field. The fieldAttribute is the attribute of the characters displayed in the field. The parameter 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. The parameter currentValue is the value of the scale field when the widget is activated. The parameters lowValue and highValue are the low and high values of the widget respectively. The parameter increment is the regular increment value while fastIncrement is the accelerated increment value. The box parameter states whether the widget will be drawn with a box around it or not. The shadow parameter accepts a boolean value to turn the shadow on or off around this widget. If the widget could not be created then a NULL pointer is returned.
int activateCDKScale (CDKSCALE scale, chtype *actions);
    This function activates the scale widget and lets the user interact with the widget. The parameter scale is a pointer to a non-NULL scale 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 a value from the low value to the high value. It will also set the structure member exitType to vNORMAL. If the character entered into this widget was ESCAPE then the widget will return a value of -1 and the structure member exitType will be set to vESCAPE_HIT.
int injectCDKScale (CDKSCALE *scale, chtype character);
    This function injects a single character into the widget. The parameter scale is a pointer to a non-NULL scale widget. The parameter character is the character to inject into the widget. If the character injected into this widget was RETURN then the character injected into this widget is RETURN or TAB then this function will return a value from the low value to the high value. It will also set the structure member exitType to vNORMAL. If the character entered into this widget was ESCAPE then the widget will return a value of -1 and the structure member exitType will be set to vESCAPE_HIT. Any other character injected into the widget will set the structure member exitType to vEARLY_EXIT and the function will return -1.
void setCDKScale (CDKSCALE *scale, int value, int minimumLength, int maximumLength, boolean box);
    This function lets the programmer modify certain elements of an already defined scale widget. The parameter names correspond to the same parameter names listed in the newCDKScale function.
void setCDKScaleLowHigh (CDKSCALE *scale, int lowValue, int highValue);
    This sets the low and high values of the widget.
int getCDKScaleLowValue (CDKSCALE *scale);
    This returns the low value of the scale widget.
int getCDKScaleHighValue (CDKSCALE *scale);
    This returns the high value of the scale widget.
void setCDKScaleValue (CDKSCALE *scale, int value);
    This sets the current value of the widget.
int getCDKScaleValue (CDKSCALE *scale);
    This returns the current value of the widget.
void setCDKScaleBox (CDKSCALE *scale, boolean boxWidget);
    This sets whether or not the widget will be draw with a box around it.
boolean getCDKScaleBox (CDKSCALE *scale);
    This returns whether or not the widget will be drawn with a box around it.
void setCDKScaleULChar (CDKSCALE *scale, chtype character);
    This function sets the upper left hand corner of the widgets box to the given character.
void setCDKScaleURChar (CDKSCALE *scale, chtype character);
    This function sets the upper right hand corner of the widgets box to the given character.
void setCDKScaleLLChar (CDKSCALE *scale, chtype character);
    This function sets the lower left hand corner of the widgets box to the given character.
void setCDKScaleLRChar (CDKSCALE *scale, chtype character);
    This function sets the lower right hand corner of the widgets box to the given character.
void setCDKScaleVerticalChar (CDKSCALE *scale, chtype character);
    This function sets the vertical drawing character for the box to the given character.
void setCDKScaleHorizontalChar (CDKSCALE *scale, chtype character);
    This function sets the horizontal drawing character for the box to the given character.
void setCDKScaleBoxAttribute (CDKSCALE *scale, chtype attribute);
    This function sets the attribute of the box.
void setCDKScaleBackgroundColor (CDKSCALE *scale, char *color);
    This sets the background color of the widget. The parameter color is in the format of the Cdk format strings. To get more information look at the cdk_display manual page.
void moveCDKScale (CDKSCALE *scale, int xpos, int ypos, boolean relative, boolean refresh);
    This function moves the given widget to the given position. The parameters xpos and ypos is the new position of the widget. The parameter xpos can accept an integer value or one of the pre-defined values of TOP, BOTTOM, and CENTER. The parameter ypos can accept an integer value or one of the pre-defined values of 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 of 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 or not.
void positionCDKScale (CDKSCALE *scale);
    This function allows the user to move the widget around the screen via the cursor/keypad keys. The following key bindings can be used to move the widget around the screen.

    Key Bindings
        Key          Action
        Up Arrow     Moves the widget up one line.
        Down Arrow   Moves the widget down one line.
        Left Arrow   Moves the widget left one column
        Right Arrow  Moves the widget right one column
        Keypad-1     Moves the widget down one line
                     and left one column.
        Keypad-2     Moves the widget down one line.
        Keypad-3     Moves the widget down one line
                     and right one column.
        Keypad-4     Moves the widget left one column
        Keypad-5     Centers the widget both vertically
                     and horizontally.
        Keypad-6     Moves the widget right one column
        Keypad-7     Moves the widget up one line
                     and left one column.
        Keypad-8     Moves the widget up one line.
        Keypad-9     Moves the widget up one line
                     and right one column.
        t            Moves the widget to the top of the screen.
        b            Moves the widget to the bottom of the screen.
        l            Moves the widget to the left of the screen.
        r            Moves the widget to the right of the screen.
        c            Centers the widget between the left and
                     right of the window.
        C            Centers the widget between the top and
                     bottom of the window.
        Escape       Returns the widget to its original position.
        Return       Exits the function and leaves the widget
                     where it was.

        Keypad means that if the keyboard you are using has a keypad, then the Num-Lock light has to be on in order to use the keys as listed. (The numeric keys at the top of the keyboard will work as well.)

        void drawCDKScale (CDKSCALE *scale, boolean box);
            This function draws the scale widget on the screen. The box option draws the widget with or without a box.
        void eraseCDKScale (CDKSCALE *scale);
            This function removes the widget from the screen. This does NOT destroy the widget.
        void destroyCDKScale (CDKSCALE *scale);
            This function removes the widget from the screen and frees up any memory the object may be using.
        void setCDKScalePreProcess (CDKSCALE *scale, PROCESSFN function, void *data);
            This function 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 if of type PROCESSFN. The parameter data is a pointer to void. To learn more about pre-processing read the cdk_process manual page.

        void setCDKScalePostProcess (CDKSCALE *scale, PROCESSFN function, void *data);
            This function allows the user to have the widget call a function after the key has been applied to the widget. The parameter function if of type PROCESSFN. The parameter data is a pointer to void. To learn more about post-processing read the cdk_process manual page.
        void bindCDKObject (EObjectType widgetType, void *object, char key, BINDFN function, void *data);
            This function allows the user to create special key bindings. The widgetType parameter is a defined type which states what Cdk object type is being used. To learn more about the type EObjectType read the cdk_binding manual page. The object parameter is the pointer to the widget object. The key is the character to bind. The function is the function type. To learn more about the key binding callback function types read the cdk_binding manual page. The last parameter data is a pointer to any data that needs to get passed to the callback function.

KEY BINDINGS
When the widget is activated there are several default key bindings which will help the user enter or manipulate the information quickly. The following table outlines the keys and their actions for this widget.

    Key         Action
    Left Arrow  Decrements the value in the field
                by the normal decrement value.
    Down Arrow  Decrements the value in the field
                by the normal decrement value.
    d           Decrements the value in the field
                by the normal decrement value.
    -           Decrements the value in the field
                by the normal decrement value.
    Right Arrow Increments the value in the field
                by the normal increment value.
    Up Arrow    Increments the value in the field
                by the normal increment value.
    u           Increments the value in the field
                by the normal increment value.
    +           Increments the value in the field
                by the normal increment value.
    Prev Page   Decrements the value in the field
                by the accelerated decrement value.
    U           Decrements the value in the field
                by the accelerated decrement value.
    Ctrl-B      Decrements the value in the field
                by the accelerated decrement value.
    Next Page   Increments the value in the field
                by the accelerated increment value.
    D           Increments the value in the field
                by the accelerated increment value.
    Ctrl-F      Increments the value in the field
                by the accelerated increment value.
    Home        Sets the value to the low value.
    g           Sets the value to the low value.
    0           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 an
                integer value representing which
                item was selected. This also sets
                the structure member exitType
                in the widget pointer to the value of
                vNORMAL.
    Tab         Exits the widget and returns an integer
                value representing which item was
                selected. This also sets the structure
                member exitType in the widget pointer
                to the value of vNORMAL.
    Escape      Exits the widget and returns -1. This
                also sets the structure member exitType
                in the widget pointer to the value of
                vESCAPE_HIT.
    Ctrl-R      Refreshes the screen.

SEE ALSO
cdk(3), cdk_binding(3), cdk_display(3), cdk_screen(3)

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>. The <curses.h> header file includes <stdio.h> and <unctrl.h>.

If you have Ncurses installed on your machine add -DNCURSES to the compile line to include the Ncurses header files instead.