Cdk(3)

NAME
cdk - Curses Development Kit

SYNOPSIS

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

#include <cdk/cdk.h>

Cdk provides functions to use a large number of predefined curses widgets. To use the Cdk widgets the header file cdk.h must be included in the source.

The widgets available from Cdk are listed below.

The rest of the manual pages describe supporting functions:

Shows how to add special display attributes,
colors, and justification into a widget.
Outlines functions used for drawing text and lines.
Demonstrates the use of screens within Cdk.
Outlines miscellaneous functions provided with the Cdk library.
Demonstrates the use of the pre- and post-process function class.
.nr 3crow 0
Manual Page NameDescription
.nr 3brule 1
]
.nr 3brule 0
.nr 3crow 1
cdk_binding (3)
.nr 3brule 1
.nr 3crow 2
cdk_display (3)
.nr 3brule 1
.nr 3crow 3
cdk_draw (3)
.nr 3brule 1
.nr 3crow 4
cdk_screen (3)
.nr 3brule 1
.nr 3crow 5
cdk_misc (3)
.nr 3brule 1
.nr 3crow 6
cdk_process (3)
.nr 3brule 1

DESCRIPTION
Cdk is a library of functions which allow a programmer to quickly create a full screen interactive program with ease. The Cdk widgets support the following features: Instead of using the standard curses library, Cdk can take advantage of the colors that Ncurses provides. To learn how to take advantage of Cdk's color capabilities, see cdk_display (3).

Individual keys can be overridden with a callback. The callback is set up using the bindCDKObject function. To learn more about this see cdk_binding (3).

Certain widgets allow the user to trap a character before and after the character has been applied to the widget. This allows programmers to `filter' character input. To learn more about this see cdk_process (3).

With the use of the inject function class and the activate function, programmers can have the widgets test themselves. This allows the programmer to perform automated tests on a final program.

There are special character format commands that can be inserted into any string in Cdk and the contents will get mapped to a chtype (see the curses manual page) with character attributes. This allows the programmer to insert format types on each character if they wish.

Widgets can be associated to any given screen. If there is more than one screen defined, then Cdk has the ability to "flip" from one screen to another with ease. See the cdk_screen manual page for more details.

STANDARD WIDGET BEHAVIOR
All of the widgets have a member of the structure called exitType. This member states how the widget exited. There are three values in which to check for, they are as follows:

This value is set when the widget is given the characters TAB or RETURN.
This means the widget exited early.
This value is set when characters such as
TAB or RETURN are injected into the
widget via the injectCDKXXX function and the
character injected does not exit the widget.
This value states the user hit ESCAPE to leave the widget.
This is the initial state of the value.
This means that the widget has not been activated.
]
.nr 3crow 0
ValueMeaning
.nr 3brule 1
]
.nr 3brule 0
]
.nr 3brule 0
.nr 3crow 1
vNORMAL
.nr 3brule 1
]
.nr 3brule 0
.nr 3crow 2
vEARLY_EXIT
.nr 3brule 1
]
.nr 3brule 0
.nr 3crow 3
vESCAPE_HIT
.nr 3brule 1
]
.nr 3brule 0
.nr 3crow 4
vNEVER_ACTIVATED
.nr 3brule 1

SEE ALSO
cdk(3), cdk_binding(3), cdk_display(3), cdk_draw(3), cdk_misc(3), cdk_process(3), cdk_screen(3)

NOTES

The header file <cdk/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>.