cdk_screen(3) - NetBSD Manual Pages

Command:
Section:
Arch:
Collection:
>>>
cdk_screen(3)                                                    cdk_screen(3)




NAME

       initCDKScreen,  initCDKColor,  registerCDKObject,  unregisterCDKObject,
       raiseCDKObject,   lowerCDKObject,   refreshCDKScreen,   eraseCDKScreen,
       destroyCDKScreen, endCDK - Cdk Screen and Widget Manipulation Functions


SYNOPSIS

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

       #include <cdk.h>

       CDKSCREEN *initCDKScreen (WINDOW *cursesWindow );

       void initCDKColor ();

       void registerCDKObject (CDKSCREEN *screen ,  EObjectType  widgetType  ,
       void *object);

       void unregisterCDKObject(EObjectType widgetType , void *object);

       void raiseCDKObject(EObjectType widgetType , void *object);

       void lowerCDKObject(EObjectType widgetType , void *object);

       void refreshCDKScreen(CDKSCREEN *screen);

       void eraseCDKScreen(CDKSCREEN *screen);

       void destroyCDKScreen(CDKSCREEN *screen);

       void endCDK();



DESCRIPTION

       One  of  the  features of Cdk is that it will manage all of the widgets
       for you.  These functions perform some of the management of the widgets
       in a screen. The following outline each function and its purpose.



AVAILABLE FUNCTIONS

       CDKSCREEN *initCDKScreen (WINDOW *cursesWindow);
          This  function takes a WINDOW * (cursesWindow) and returns a pointer
          to a CDKSCREEN *. Since all of the widgets take a CDKSCREEN  pointer
          as  a first argument, this is also one of the first calls made. This
          also starts curses, so no curses initialization  calls  have  to  be
          made when using Cdk.

       void initCDKColor ();
          This  call  starts  the  Cdk color capabilities. It defines 64 color
          pairs each of which is accessible using the COLOR_PAIR macro. If you
          do not have color support, this function call makes no difference.

       void registerCDKObject (CDKSCREEN *screen, EObjectType widgetType, void
       *object);
          This function is called automatically when a widget is  created.  If
          for some reason an object does get unregistered, by calling unregis-
          terCDKObject, the widget can be registered  again  by  calling  this
          function.  The widgetType parameter states what Cdk widget type this
          object is. The object parameter is a void pointer to the object.

       void unregisterCDKObject (EObjectType cdktype, void *object);
          This function removes the widget from  the  screen.  This  does  NOT
          destroy the object, it removes the widget from any further refreshes
          by the function refreshCDKScreen. The  widgetType  parameter  states
          what  Cdk widget type this object is. The object parameter is a void
          pointer to the object.

       void raiseCDKObject (EObjectType cdktype, void *object);
          This function raises the widget to the top of the screen.  If  there
          are  any  widgets  which  overlap the given object when a refresh is
          done, calling this function has the effect of raiding the object  so
          no  other  widgets obstruct it. The widgetType parameter states what
          Cdk widget type this object is.  The  object  parameter  is  a  void
          pointer to the object.

       void lowerCDKObject (EObjectType cdktype, void *object);
              This  function  has  the  opposite  effect of the raiseCDKObject
              function call.

       void refreshCDKScreen (CDKSCREEN *screen);
          This function redraws all of the widgets which are currently associ-
          ated to the given screen.

       void eraseCDKScreen (CDKSCREEN *screen);
          This  function erases all of the widgets which are currently associ-
          ated to the given screen. This does NOT destroy the widgets.

       void destroyCDKScreen (CDKSCREEN *screen);
          This function destroys  any  memory  allocated  by  the  Cdk  screen
          pointer.

       void endCDK();
          This function cleans up any memory created by starting Cdk and shuts
          down curses.


SEE ALSO

       cdk(3), cdk_binding(3), cdk_display(3)


NOTES

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

       If you have Ncurses installed on your machine add -DNCURSES to the com-
       pile line to include the Ncurses header files instead.



                                  05 Dec 1995                    cdk_screen(3)