1cdk_screen(3)              Library Functions Manual              cdk_screen(3)
2
3
4

NAME

6       cdk_screen - Cdk Screen and Widget Manipulation Functions
7

SYNOPSIS

9       cc [ flag ... ] file ...  -lcdk [ library ... ]
10
11       #include <cdk.h>
12
13       void destroyCDKScreen(
14                      CDKSCREEN *screen);
15
16       void endCDK(void) ;
17
18       void eraseCDKScreen(
19                      CDKSCREEN *screen);
20
21       void initCDKColor (void) ;
22
23       CDKSCREEN *initCDKScreen (
24                      WINDOW *cursesWindow);
25
26       void lowerCDKObject(
27                      EObjectType widgetType,
28                      void *object);
29
30       void raiseCDKObject(
31                      EObjectType widgetType,
32                      void *object);
33
34       void refreshCDKScreen(
35                      CDKSCREEN *screen);
36
37       void registerCDKObject (
38                      CDKSCREEN *screen,
39                      EObjectType widgetType,
40                      void *object);
41
42       void unregisterCDKObject(
43                      EObjectType widgetType,
44                      void *object);
45

DESCRIPTION

47       Cdk  manages  all of the widgets for you.  These functions perform some
48       of the management of the widgets in a screen.
49

AVAILABLE FUNCTIONS

51       destroyCDKScreen
52            frees any memory allocated by the Cdk screen pointer.
53
54       endCDK
55            cleans up any memory  created  by  starting  Cdk  and  shuts  down
56            curses.
57
58       eraseCDKScreen
59            erases  all  of  the widgets which are currently associated to the
60            given screen.  This does NOT destroy the widgets.
61
62       initCDKColor
63            starts the Cdk color capabilities.  It defines 64 color pairs each
64            of  which is accessible using the COLOR_PAIR macro.  If you do not
65            have color support, this function call makes no difference.
66
67       initCDKScreen
68            takes a WINDOW  *  (cursesWindow)  and  returns  a  pointer  to  a
69            CDKSCREEN *.  Since all of the widgets take a CDKSCREEN pointer as
70            a first argument, this is also one of the first calls made.   This
71            also  starts  curses, so no curses initialization calls have to be
72            made when using Cdk.
73
74       lowerCDKObject
75            has the opposite effect of the raiseCDKObject function call.
76
77       raiseCDKObject
78            raises the widget to the top of the screen.  If there are any wid‐
79            gets  which overlap the given object when a refresh is done, call‐
80            ing this function has the effect of raiding the object so no other
81            widgets  obstruct  it.   The  widgetType parameter states what Cdk
82            widget type this object  is.   The  object  parameter  is  a  void
83            pointer to the object.
84
85       refreshCDKScreen
86            redraws  all  of the widgets which are currently associated to the
87            given screen.
88
89       registerCDKObject
90            is called automatically when a widget is  created.   If  for  some
91            reason  an  object does get unregistered, by calling unregisterCD‐
92            KObject, the widget can be registered again by calling this  func‐
93            tion.   The  widgetType parameter states what Cdk widget type this
94            object is.  The object parameter is a void pointer to the object.
95
96       unregisterCDKObject
97            removes the widget from the screen.  This  does  NOT  destroy  the
98            object,  it  removes  the widget from any further refreshes by the
99            function refreshCDKScreen.  The widgetType parameter  states  what
100            Cdk  widget  type  this object is.  The object parameter is a void
101            pointer to the object.
102

SEE ALSO

104       cdk(3), cdk_binding(3), cdk_display(3)
105
106
107
108                                                                 cdk_screen(3)