--- name: "cdk_binding" section: "3" platform: "linux" package: "libcdk5-dev" version: "5.0.20250116-1" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/cdk_binding" --- # cdk\_binding(3) Cdk character binding capabilities ## NAME cdk\_binding - *Cdk* character binding capabilities ## SYNOPSIS **cc** \[ *flag* ... \] *file* ... **-lcdk** \[ *library* ... \] ``` #include ``` - **void bindCDKObject (** **EObjectType** *cdkType***,** **void \****object***,** **chtype** *key***,** **BINDFN** *function***,** **void \****data***);** - **int checkCDKObjectBind (** **EObjectType** *cdkType***,** **void \****object***,** **chtype** *key***);** - **void cleanCDKObjectBindings (** **EObjectType** *cdkType***,** **void \****object***);** - **bool isCDKObjectBind (** **EObjectType** *cdkType***,** **void \****object***,** **chtype** *key***);** - **void unbindCDKObject (** **EObjectType** *cdkType***,** **void \****object***,** **chtype** *key***);** - **int getcCDKObject (** **CDKOBJS \****object***);** - **int getchCDKObject (** **CDKOBJS \****object***,** **boolean \****functionKey***);** ## DESCRIPTION Cdk has the ability to create user definable key bindings. This ability makes Cdk more dynamic and usable for a wide variety of tasks. The following section outlines the binding functions, their use, and their purpose. - **bindCDKObject** creates a key binding between a specific Cdk widget (**object**) given key (**key**). The parameter **cdkType** is of type *EObjectType* which is one of the following values. | | | | | --- | --- | --- | | **EObjectType\_Value** | Corresponding\_Widget | Widget\_Manual\_Page | | vALPHALIST | Alphalist Widget | [**cdk\_alphalist**(3)](/cdk_alphalist/3.md) | | vBUTTON | Button Widget | [**cdk\_button**(3)](/cdk_button/3.md) | | vBUTTONBOX | Buttonbox Widget | [**cdk\_buttonbox**(3)](/cdk_buttonbox/3.md) | | vCALENDAR | Calendar Widget | [**cdk\_calendar**(3)](/cdk_calendar/3.md) | | vDIALOG | Dialog Widget | [**cdk\_dialog**(3)](/cdk_dialog/3.md) | | vDSCALE | DoubleFloat Widget | [**cdk\_dscale**(3)](/cdk_dscale/3.md) | | vENTRY | Entry Widget | [**cdk\_entry**(3)](/cdk_entry/3.md) | | vFSCALE | Floating Scale Widget | [**cdk\_fscale**(3)](/cdk_fscale/3.md) | | vFSELECT | File Selector Widget | [**cdk\_fselect**(3)](/cdk_fselect/3.md) | | vFSLIDER | Floating Slider Widget | [**cdk\_fslider**(3)](/cdk_fslider/3.md) | | vGRAPH | Graph Widget | [**cdk\_graph**(3)](/cdk_graph/3.md) | | vHISTOGRAM | Histogram Widget | [**cdk\_histogram**(3)](/cdk_histogram/3.md) | | vITEMLIST | Item List Widget | [**cdk\_itemlist**(3)](/cdk_itemlist/3.md) | | vLABEL | Label Widget | [**cdk\_label**(3)](/cdk_label/3.md) | | vMARQUEE | Marquee Widget | [**cdk\_marquee**(3)](/cdk_marquee/3.md) | | vMATRIX | Matrix Widget | [**cdk\_matrix**(3)](/cdk_matrix/3.md) | | vMENTRY | Multiple Line Entry Widget | [**cdk\_mentry**(3)](/cdk_mentry/3.md) | | vMENU | Menu Widget | [**cdk\_menu**(3)](/cdk_menu/3.md) | | vRADIO | Radio List Widget | [**cdk\_radio**(3)](/cdk_radio/3.md) | | vSCALE | Integer Scale Widget | [**cdk\_scale**(3)](/cdk_scale/3.md) | | vSCROLL | Scrolling List Widget | [**cdk\_scroll**(3)](/cdk_scroll/3.md) | | vSELECTION | Selection List Widget | [**cdk\_selection**(3)](/cdk_selection/3.md) | | vSLIDER | Slider Widget | [**cdk\_slider**(3)](/cdk_slider/3.md) | | vSWINDOW | Scrolling Window Widget | [**cdk\_swindow**(3)](/cdk_swindow/3.md) | | vTEMPLATE | Template Entry Widget | [**cdk\_template**(3)](/cdk_template/3.md) | | vUSCALE | Unsigned Scale Widget | [**cdk\_uscale**(3)](/cdk_uscale/3.md) | | vUSLIDER | Unsigned Slider Widget | [**cdk\_uslider**(3)](/cdk_uslider/3.md) | | vVIEWER | Viewer Widget | [**cdk\_viewer**(3)](/cdk_viewer/3.md) | The parameter **function** is the callback function. The parameter **data** points to data passed to the callback function. The parameter **key** is the key hit which triggered this callback. - **checkCDKObjectBind** check to see if a binding for the given **key** exists. If it does, Cdk runs the associated command and returns its value, normally TRUE. If no binding exists, return FALSE. - The widgets which accept input, e.g., via "inject" methods, use this to check if the injected character is bound to a function. If that returns TRUE, the widget may update its *exitType* value: if *earlyExit* value is set (not equal to vNEVER\_ACTIVATED), the widget sets *exitType* to that value. - **cleanCDKObjectBindings** removes all user defined key bindings from the given widget. - **isCDKObjectBind** check to see if a binding for the given **key** exists. If it does return TRUE. If no binding exists, return FALSE. - **unbindCDKObject** removes a specific binding to an object. The parameter are the same as for **bindCDKObject**. - **getcCDKObject** reads a keycode from the given widget. This is deprecated: use **getchCDKObject**. - **getchCDKObject** reads a keycode from the given widget, and sets a flag via the *functionKey* parameter to indicate if the result is a function key. The *functionKey* parameter may be null; the keycode is returned whether or not the flag can be set. - If the keycode has been bound to the special function **getcCDKBind**, then it will be translated to the value which was given for the binding data. Otherwise, a few special cases are performed: | | | | --- | --- | | **Key** | Result | | CTRL-A | KEY\_HOME | | CTRL-B | KEY\_LEFT | | CTRL-E | KEY\_END | | CTRL-F | KEY\_RIGHT | | CTRL-N | tab | | CTRL-P | KEY\_BTAB | | DEL | KEY\_DC | | backspace | KEY\_BACKSPACE | | carriage return | KEY\_ENTER | | newline | KEY\_ENTER | All of the widgets use **getchCDKObject** internally for consistency. ## EXAMPLES To help demonstrate how to use the key bindings I will demonstrate a simple dialog box widget with help for each button. The following code segment creates a dialog box and a callback function named *dialogHelpCB*. ``` ________________________________________ ``` \#include \ \#ifdef HAVE\_XCURSES char \*XCursesProgramName="bind\_ex"; #endif static int dialogHelpCB (EObjectType cdktype GCC\_UNUSED, void \*object, void \*clientData GCC\_UNUSED, chtype key GCC\_UNUSED) {\ CDKDIALOG \*dialog = (CDKDIALOG \*)object;\ char \*mesg\[5\]; /\* Check which button we are on. \*/\ if (dialog-\>currentButton == 0)\ {\ mesg\[0\] = "\\Help for \Who\.";\ mesg\[1\] = "\When this button is picked the name of the current";\ mesg\[2\] = "\user is displayed on the screen in a popup window.";\ popupLabel (ScreenOf(dialog), mesg, 3);\ }\ else if (dialog-\>currentButton == 1)\ {\ mesg\[0\] = "\\Help for \Time\.";\ mesg\[1\] = "\When this button is picked the current time is";\ mesg\[2\] = "\displayed on the screen in a popup window.";\ popupLabel (ScreenOf(dialog), mesg, 3);\ }\ else if (dialog-\>currentButton == 2)\ {\ mesg\[0\] = "\\Help for \Date\.";\ mesg\[1\] = "\When this button is picked the current date is";\ mesg\[2\] = "\displayed on the screen in a popup window.";\ popupLabel (ScreenOf(dialog), mesg, 3);\ }\ else if (dialog-\>currentButton == 3)\ {\ mesg\[0\] = "\\Help for \Quit\.";\ mesg\[1\] = "\When this button is picked the dialog box is exited.";\ popupLabel (ScreenOf(dialog), mesg, 2);\ }\ return (FALSE); } int main (void) {\ /\* Declare variables. \*/\ CDKSCREEN \*cdkscreen;\ CDKDIALOG \*question;\ char \*buttons\[40\];\ char \*message\[40\], \*info\[5\], \*loginName;\ char temp\[256\];\ int selection;\ time\_t clck;\ struct tm \*currentTime; cdkscreen = initCDKScreen (NULL); /\* Start color. \*/\ initCDKColor(); /\* Set up the dialog box. \*/\ message\[0\] = "\\Simple Command Interface";\ message\[1\] = "Pick the command you wish to run.";\ message\[2\] = "\Press \?\ for help.";\ buttons\[0\] = "Who";\ buttons\[1\] = "Time";\ buttons\[2\] = "Date";\ buttons\[3\] = "Quit"; /\* Create the dialog box. \*/\ question = newCDKDialog (cdkscreen, CENTER, CENTER,\ message, 3, buttons, 4, A\_REVERSE,\ TRUE, TRUE, FALSE); /\* Check if we got a null value back. \*/\ if (question == (CDKDIALOG \*)0)\ {\ destroyCDKScreen (cdkscreen); /\* End curses... \*/\ endCDK(); /\* Spit out a message. \*/\ printf ("Oops. Can't seem to create the dialog box. Is the window too small?\\n");\ exit (1);\ } /\* Create the key binding. \*/\ bindCDKObject (vDIALOG, question, '?', dialogHelpCB, 0); /\* Activate the dialog box. \*/\ selection = 0;\ while (selection != 3)\ {\ /\* Get the users button selection. \*/\ selection = activateCDKDialog (question, (chtype \*)0); /\* Check the results. \*/\ if (selection == 0)\ {\ /\* Get the users login name. \*/\ info\[0\] = "\ \Login Name\ ";\ loginName = getlogin();\ if (loginName == (char \*)0)\ {\ strcpy (temp, "\\Unknown");\ }\ else\ {\ sprintf (temp, "\\<%s\>", loginName);\ }\ info\[1\] = copyChar (temp);\ popupLabel (ScreenOf(question), info, 2);\ freeChar (info\[1\]);\ }\ else if (selection == 1)\ {\ /\* Print out the time. \*/\ time(&clck);\ currentTime = localtime(&clck);\ sprintf (temp, "\%d:%d:%d", currentTime-\>tm\_hour,\ currentTime-\>tm\_min,\ currentTime-\>tm\_sec);\ info\[0\] = "\ \Current Time\ ";\ info\[1\] = copyChar (temp);\ popupLabel (ScreenOf(question), info, 2);\ freeChar (info\[1\]);\ }\ else if (selection == 2)\ {\ /\* Print out the date. \*/\ time(&clck);\ currentTime = localtime(&clck);\ sprintf (temp, "\%d/%d/%02d", currentTime-\>tm\_mday,\ currentTime-\>tm\_mon,\ currentTime-\>tm\_year % 100);\ info\[0\] = "\ \Current Date\ ";\ info\[1\] = copyChar (temp);\ popupLabel (ScreenOf(question), info, 2);\ freeChar (info\[1\]);\ }\ } /\* Clean up. \*/\ destroyCDKDialog (question);\ destroyCDKScreen (cdkscreen);\ endCDK();\ exit (0); }\ *\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_* ## SEE ALSO [**cdk**(3)](/cdk/3.md), [**cdk\_display**(3)](/cdk_display/3.md), [**cdk\_screen**(3)](/cdk_screen/3.md)