Scroll to navigation

cdk_objs(3) Library calls cdk_objs(3)

NAME

cdk_objs - Cdk object-support functions

SYNOPSIS

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

CDKOBJS *obj);
WINDOW *window,
CDKOBJS *object);
CDKOBJS *obj);
CDKOBJS *object,
WINDOW *win);
CDKOBJS *object,
const 3char *color);
CDKOBJS *object,
PROCESSFN func,
void *data);
CDKOBJS *object,
PROCESSFN func,
void *data);
CDKOBJS *obj,
EExitType *type,
chtyp ch);
CDKOBJS *obj,
const char *title,
int boxWidth);
CDKOBJS *obj);

DESCRIPTION

Cdk is written in ANSI C, which has "no" object support. Most of the object support in Cdk is done using macros and a small number of types which hold object information:

contains the function pointers for common methods of the widgets. It is separate from CDKOBJS because it is compiled into each widget's C code (see the DeclareCDKObjects() and DeclareSetXXchar() macros. The widget instances point to a single copy of CDKFUNCS for each widget.
Holds data common to all objects (widget instances). It appears first in each widget's struct to allow Cdk to use generic functions in binding.c, cdkscreen.c, position.c, etc.

AVAILABLE FUNCTIONS

The functions declared in <cdk_objs.h> are used in situations where the expressions are too complex for a macro.

Remove storage for the widget's title.
Draw the widget's title.
Returns the widget's title as a string. Colors are encoded as described in cdk_display(3). The lines of text in a multi-line title are separated by “<#10>” markers (an encoded newline).
This allows the user to use the cursor keys to adjust the position of the widget.
Set the background color of the widget.
Set data for postprocessing.
Set data for preprocessing.
Set the object's exit-type based on the input. The .exitType field should have been part of the CDKOBJS struct, but it is used too pervasively in Cdk4 applications to move.
Set the widget's title.
Returns true if a "new" was done on the object but no "destroy".

SEE ALSO

cdk_binding(3), cdk_display(3), cdk_process(3).

2024-03-28