cdk_scroll(3)

NAME
activateCDKScroll, addCDKScrollItem, deleteCDKScrollItem, destroyCDKScroll, drawCDKScroll, eraseCDKScroll, getCDKScrollBox, getCDKScrollHighlight, getCDKScrollItems, injectCDKScroll, moveCDKScroll, newCDKScroll, positionCDKScroll, setCDKScroll, setCDKScrollBackgroundColor, setCDKScrollBox, setCDKScrollBoxAttribute, setCDKScrollHighlight, setCDKScrollHorizontalChar, setCDKScrollItems, setCDKScrollLLChar, setCDKScrollLRChar, setCDKScrollPostProcess, setCDKScrollPreProcess, setCDKScrollULChar, setCDKScrollURChar, setCDKScrollVerticalChar - curses scrolling list widget.

SYNOPSIS

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

#include <cdk/cdk.h>

int activateCDKScroll (
    CDKSCROLL *scroll,
    chtype * actions);

void addCDKScrollItem (
    CDKSCROLL *scroll,
    char *item);

void deleteCDKScrollItem (
    CDKSCROLL *scroll,
    int position);

void destroyCDKScroll (
    CDKSCROLL *scroll);

void drawCDKScroll (
    CDKSCROLL *scroll,
    boolean box);

void eraseCDKScroll (
    CDKSCROLL *scroll);

boolean getCDKScrollBox (
    CDKSCROLL *scroll);

chtype getCDKScrollHighlight (
    CDKSCROLL *scroll);

int getCDKScrollItems (
    CDKSCROLL *scroll,
    char **itemList);

int injectCDKScroll (
    CDKSCROLL *scroll,
    chtype input);

void moveCDKScroll (
    CDKSCROLL *scroll,
    int box,
    int box,
    boolean relative,
    boolean refresh);

CDKSCROLL *newCDKScroll (
    CDKSCREEN *cdkscreen,
    int xpos,
    int ypos,
    int spos,
    int height,
    int width,
    char *title,
    char **scrollList,
    int scrollListLength,
    boolean numbers,
    chtype highlight,
    boolean box,
    boolean shadow);

void positionCDKScroll (
    CDKSCROLL *scroll);

void setCDKScroll (
    CDKSCROLL *scroll,
    char *value,
    int minimumLength,
    int maximumLength,
    boolean box);

void setCDKScrollBackgroundColor (
    CDKSCROLL *scroll,
    char * color);

void setCDKScrollBox (
    CDKSCROLL *scroll,
    boolean box);

void setCDKScrollBoxAttribute (
    CDKSCROLL *scroll,
    chtype character);

void setCDKScrollHighlight (
    CDKSCROLL *scroll,
    chtype highlight);

void setCDKScrollHorizontalChar (
    CDKSCROLL *scroll,
    chtype character);

void setCDKScrollItems (
    CDKSCROLL *scroll,
    char **itemList,
    int listSize,
    boolean numbers);

void setCDKScrollLLChar (
    CDKSCROLL *scroll,
    chtype character);

void setCDKScrollLRChar (
    CDKSCROLL *scroll,
    chtype character);

void setCDKScrollPostProcess (
    CDKSCROLL *scroll,
    PROCESSFN callback,
    void * data);

void setCDKScrollPreProcess (
    CDKSCROLL *scroll,
    PROCESSFN callback,
    void * data);

void setCDKScrollULChar (
    CDKSCROLL *scroll,
    chtype character);

void setCDKScrollURChar (
    CDKSCROLL *scroll,
    chtype character);

void setCDKScrollVerticalChar (
    CDKSCROLL *scroll,
    chtype character);

DESCRIPTION
The Cdk scroll widget creates a scrolling list. The following are functions which create or manipulate the Cdk scrolling list widget.

AVAILABLE FUNCTIONS

activateCDKScroll
    activates the scroll widget and lets the user interact with the widget. The parameter scroll is a pointer to a non-NULL scroll 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 0 to the number of items-1, representing the item selected. 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.

addCDKScrollItem
    allows the user to add an item into an existing scrolling list. The scroll parameter is a pointer to the scrolling list to add the item to. The parameter item is a char * representing the new item to add. The item is always added to the end of the list.

deleteCDKScrollItem
    allows the user to add an item into an existing scrolling list. The scroll parameter is a pointer to the scrolling list to add the item to. The parameter f2position is an int which specifies which element to remove.

destroyCDKScroll
    removes the widget from the screen and frees memory the object used.

drawCDKScroll
    draws the scroll widget on the screen. If the box option is true, the widget is drawn with a box.

eraseCDKScroll
    removes the widget from the screen. This does NOT destroy the widget.

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

getCDKScrollHighlight
    returns the attribute of the highlight bar.

getCDKScrollItems
    fills the parameter itemList with the contents of the scrolling list. It returns the number of elements in the scrolling list.

injectCDKScroll
    injects a single character into the widget. The parameter scroll is a pointer to a non-NULL scroll 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 0 to the number of items-1, representing the item selected. 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. Any other character injected into the widget will set the widget data exitType to vEARLY_EXIT and the function will return -1.

moveCDKScroll
    moves the given widget to the given position. 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.

newCDKScroll
    creates a scroll widget and returns a pointer to it. 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 may be an integer or one of the pre-defined values LEFT, RIGHT, and CENTER. The parameter ypos controls the placement of the object along the vertical axis. This parameter may be an integer value or one of the pre-defined values TOP, BOTTOM, and CENTER. The parameter spos is where the scroll bar is to be placed. This may be one of three values: LEFT, which puts the scroll bar on the left of the scrolling list. RIGHT which puts the scroll bar on the right side of the list, and NONE which does not add a scroll bar. The parameters 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. 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 parameter scrollList is the list of items to be displayed in the scrolling list; scrollListLength is the number of elements in the given list. The parameter numbers is a boolean value stating that you want the items in the list to have a number attached to the front of the list items. The highlight parameter specifies the display attribute of the currently selected item. The box parameter states whether the widget will be drawn with a box around it. 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.

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

setCDKScroll
    lets the programmer modify certain elements of an existing scroll widget. The parameter names correspond to the same parameter names listed in the newCDKScroll function.

setCDKScrollBackgroundColor
    sets the background color of the widget. The parameter color is in the format of the Cdk format strings. See cdk_display (3).

setCDKScrollBox
    sets whether the widget will be drawn with a box around it.

setCDKScrollBoxAttribute
    sets the attribute of the box.

setCDKScrollHighlight
    sets the attribute of the highlight bar.

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

setCDKScrollItems
    sets the contents of the scrolling list.

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

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

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

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

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

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

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

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 | Shifts the list left one column.
Right Arrow | Shifts the list right one column.
Up Arrow | Selects the next item up in the list.
Down Arrow | Selects the next item down in the list.
Prev Page | Moves one page backwards.
Ctrl-B | Moves one page backwards.
Next Page | Moves one page forwards.
Ctrl-F | Moves one page forwards.
g | Moves to the first element in the list.
1 | Moves to the first element in the list.
G | Moves to the last element in the list.
$ | Shifts the list to the far right.
| | Shifts the list to the far left.
Return | Exits the widget and returns the index of the selected item. This also sets the widget data exitType to vNORMAL.
Tab | Exits the widget and returns the index of the selected item. This also sets the widget data exitType to vNORMAL.
Escape | Exits the widget and returns -1. This also sets the widget data exitType to vESCAPE_HIT.
Ctrl-L | Refreshes the screen.

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