--- name: "setCDKItemlsitPostProcess" section: "3" platform: "linux" package: "libcdk-dev" version: "4.9.9-4" release: "Debian 3.1 (Sarge)" platforms: ["linux"] url: "https://new.carta.tech/cdk_itemlist" --- # setCDKItemlsitPostProcess(3) Creates a managed curses itemlist widget. Part of [cdk\_itemlist(3)](/cdk_itemlist/3.md). ## NAME newCDKItemlist, activateCDKItemlist, injectCDKItemlist, setCDKItemlist, setCDKItemlistValues, getCDKItemlistValues, setCDKItemlistDefaultItem, getCDKItemlistDefaultItem, setCDKItemlistCurrentItem, getCDKItemlistCurrentItem, setCDKItemlistBox, getCDKItemlistBox, setCDKItemlistULChar, setCDKItemlistURChar, setCDKItemlistLLChar, setCDKItemlistLRChar, setCDKItemlistVerticalChar, setCDKItemlistHorizontalChar, setCDKItemlistBoxAttribute, setCDKItemlistBackgroundColor, drawCDKItemlist, eraseCDKItemlist, cleanCDKItemlist, destroyCDKItemlist, setCDKItemlistPreProcess, setCDKItemlsitPostProcess - Creates a managed curses itemlist widget. ## SYNOPSIS **cc** \[ *flag* ... \] *file* ... **-lcdk** \[ *library* ... \] \#include \ **CDKITEMLIST \*newCDKItemlist (CDKSCREEN \****cdkscreen***,** **int** *xpos***,** **int** *ypos***,** **char \****title***,** **char \****label***,** **char \*\****itemList***,** **int** *itemCount***,** **int** *defaultItem***,** **boolean** *box***,** **boolean** *shadow***);** **int activateCDKItemlist (CDKITEMLIST \****itemlist***,** **chtype \****actions***);** **int injectCDKItemlist (CDKITEMLIST \****,***itemlist***,* **chtype** *input***);** **void setCDKItemlist (CDKITEMLIST \****itemlist***,** **char \*\****itemList***,** **int** *itemCount***,** **int** *currentSelection***,** **boolean** *box***);** **void setCDKItemlistValues (CDKITEMLIST \****itemlist***,** **char \*\****itemList***,** **int** *itemCount***);** **char \*\*getCDKItemlistValues (CDKITEMLIST \****itemlist***,** **int \****listSize***);** **void setCDKItemlistDefaultItem (CDKITEMLIST \****itemlist***,** **int** *defaultItem***);** **int getCDKItemlistDefaultItem (CDKITEMLIST \****itemlist***);** **void setCDKItemlistCurrentItem (CDKITEMLIST \****itemlist***,** **int** *currentItem***);** **int getCDKItemlistCurrentItem (CDKITEMLIST \****itemlist***);** **void setCDKItemlistBox (CDKITEMLIST \****itemlist***,** **boolean** *box***);** **boolean getCDKItemlistBox (CDKITEMLIST \****itemlist***);** **void setCDKItemlistULChar (CDKITEMLIST \****,***itemlist***,* **chtype** *character***);** **void setCDKItemlistURChar (CDKITEMLIST \****,***itemlist***,* **chtype** *character***);** **void setCDKItemlistLLChar (CDKITEMLIST \****,***itemlist***,* **chtype** *character***);** **void setCDKItemlistLRChar (CDKITEMLIST \****,***itemlist***,* **chtype** *character***);** **void setCDKItemlistVerticalChar (CDKITEMLIST \****,***itemlist***,* **chtype** *character***);** **void setCDKItemlistHorizontalChar (CDKITEMLIST \****,***itemlist***,* **chtype** *character***);** **void setCDKItemlistBoxAttribute (CDKITEMLIST \****,***itemlist***,* **chtype** *character***);** **void setCDKItemlistBackgroundColor (CDKITEMLIST \****,***itemlist***,* **char \*** *color***);** **void moveCDKItemlist (CDKITEMLIST \****itemlist***,** **int** *box***,** **int** *box***,** **boolean** *relative***,** **boolean** *refresh***);** **void positionCDKItemlist (CDKITEMLIST \****itemlist***);** **void drawCDKItemlist (CDKITEMLIST \****itemlist***,** **boolean** *box***);** **void eraseCDKItemlist (CDKITEMLIST \****itemlist***);** **void cleanCDKItemlist (CDKITEMLIST \****itemlist***);** **void destroyCDKItemlist (CDKITEMLIST \****itemlist***);** **void setCDKItemlistPreProcess (CDKITEMLIST \****itemlist***,** **PROCESSFN***callback***,** **void \****data***);** **void setCDKItemlistPostProcess (CDKITEMLIST \****itemlist***,** **PROCESSFN***callback***,** **void \****data***);** **void bindCDKObject (EObjectType** *widgetType***,** **void \****object***,** **chtype** *key***,** **BINDFN** *function***,** **void \****data***);** ## DESCRIPTION The Cdk itemlist widget creates a widget which allows a user to select from a list of preset character strings. The best examples of something like this are the days of the week or the months of the year. The following are functions which create or manipulate the Cdk itemlist widget. ## AVAILABLE FUNCTIONS CDKITEMLIST \*newCDKItemlist (CDKSCREEN \**screen*, int *xpos*, int *ypos*, char \**title*, char \**label*, char \*\**itemList*, int *itemCount*, int *defaultItem*, boolean *box*, boolean *shadow*); This function creates a pointer to an itemlist 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 itemlist field. The *itemList* parameter is the list of the strings which will be displayed in the widget; *itemCount* is the number of elements in the list. The parameter *defaultItem* is an integer value which represents which string is to be displayed as the default item. 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 activateCDKItemlist (CDKITEMLIST \**itemlist*, chtype \**actions*); This function activates the itemlist widget and lets the user interact with the widget. The parameter *itemlist* is a pointer to a non-NULL itemlist 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 buttons -1, representing the button selected. 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 injectCDKItemlist (CDKITEMLIST \**itemlist*, chtype *character*); This function injects a single character into the widget. The parameter *itemlist* is a pointer to a non-NULL itemlist 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 buttons -1, representing the button selected. 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 setCDKItemlist (CDKITEMLIST \**itemlist*, char \*\**itemList*, int *itemCount*, int *currentSelection*, boolean *box*); This function lets the programmer modify certain elements of an already defined itemlist widget. The parameter names correspond to the same parameter names listed in the ***newCDKItemlist*** function. void setCDKItemlistCurrentItem (CDKITEMLIST \**itemlist*, int *currentItem*); This sets the currently displayed item in the widget. int getCDKItemlistCurrentItem (CDKITEMLIST \**itemlist*); This returns the index of the currently displayed item in the widget. void setCDKItemlistDefaultItem (CDKITEMLIST \**itemlist*, int *defaultItem*); This sets the default item in the widget. int getCDKItemlistDefaultItem (CDKITEMLIST \**itemlist*); This returns the index of the default item in the widget. void setCDKItemlistBox (CDKITEMLIST \**itemlist*, boolean *boxWidget*); This sets whether or not the widget will be draw with a box around it. boolean getCDKItemlistBox (CDKITEMLIST \**itemlist*); This returns whether or not the widget will be drawn with a box around it. void setCDKItemlistULChar (CDKITEMLIST \**itemlist*, chtype *character*); This function sets the upper left hand corner of the widgets box to the given character. void setCDKItemlistURChar (CDKITEMLIST \**itemlist*, chtype *character*); This function sets the upper right hand corner of the widgets box to the given character. void setCDKItemlistLLChar (CDKITEMLIST \**itemlist*, chtype *character*); This function sets the lower left hand corner of the widgets box to the given character. void setCDKItemlistLRChar (CDKITEMLIST \**itemlist*, chtype *character*); This function sets the lower right hand corner of the widgets box to the given character. void setCDKItemlistVerticalChar (CDKITEMLIST \**itemlist*, chtype *character*); This function sets the vertical drawing character for the box to the given character. void setCDKItemlistHorizontalChar (CDKITEMLIST \**itemlist*, chtype *character*); This function sets the horizontal drawing character for the box to the given character. void setCDKItemlistBoxAttribute (CDKITEMLIST \**itemlist*, chtype *attribute*); This function sets the attribute of the box. void setCDKItemlistBackgroundColor (CDKITEMLIST \**itemlist*, 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 moveCDKItemlist (CDKITEMLIST \**itemlist*, 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***. (wierd 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 positionCDKItemlist (CDKITEMLIST \**itemlist*); 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 it's 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 drawCDKItemlist (CDKITEMLIST \**itemlist*, boolean *box*); This function draws the itemlist widget on the screen. The *box* option draws the widget with or without a box. void eraseCDKItemlist (CDKITEMLIST \**itemlist*); This function removes the widget from the screen. This does ***NOT*** destroy the widget. void destroyCDKItemlist (CDKITEMLIST \**itemlist*); This function removes the widget from the screen and frees up any memory the object may be using. void setCDKItemlistPreProcess (CDKITEMLIST \**itemlist*, 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 setCDKItemlistPostProcess (CDKITEMLIST \**itemlist*, 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 f2widgetType 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 Cycles the list one to the left and displays it. Down Arrow Cycles the list one to the left and displays it. - Cycles the list one to the left and displays it. p Cycles the list one to the left and displays it. Right Arrow Cycles the list one to the right and displays it. Up Arrow Cycles the list one to the right and displays it. Space Cycles the list one to the right and displays it. + Cycles the list one to the right and displays it. n Cycles the list one to the right and displays it. d Displays the default item. D Displays the default item. 0 Displays the first item in the list. $ Displays the last item in the list. Return Exits the widget and returns an integer value representing the current selection. It also sets the structure member exitType in the widget pointer to vNORMAL. Tab Exits the widget and returns an integer value representing the current selection. It also sets the structure member exitType in the widget pointer to vNORMAL. Escape Exits the widget and returns -1. It also sets the structure member exitType in the widget pointer to vESCAPE_HIT. Ctrl-L Refreshes the screen. ``` ## SEE ALSO [**cdk**(3)](/cdk/3.md), [**cdk\_binding**(3)](/cdk_binding/3.md), [**cdk\_display**(3)](/cdk_display/3.md), [**cdk\_process**(3)](/cdk_process/3.md), [**cdk\_screen**(3)](/cdk_screen/3.md) ## NOTES The header file ***\*** automatically includes the header files ***\***, ***\***, ***\***, ***\***, ***\***, ***\***, ***\***, ***\***, ***\***, ***\***, ***\***, and ***\***. The ***\*** header file includes ***\*** and ***\***. If you have ***Ncurses*** installed on your machine add -DNCURSES to the compile line to include the Ncurses header files instead.