unixdev.net


Switch to SpeakEasy.net DSL

The Modular Manual Browser

Home Page
Manual: (NetBSD-2.0)
Page:
Section:
Apropos / Subsearch:
optional field

cdk_buttonbox(3)           Library Functions Manual           cdk_buttonbox(3)



NAME
       newCDKButtonbox,  activateCDKButtonbox, injectCDKButtonbox, drawCDKBut-
       tonbox, setCDKButtonbox, setCDKButtonboxHighlight, getCDKButtonboxHigh-
       light,  setCDKButtonboxBox,  getCDKButtonboxBox, setCDKButtonboxULChar,
       setCDKButtonboxURChar,  setCDKButtonboxLLChar,   setCDKButtonboxLRChar,
       setCDKButtonboxVerticalChar,  setCDKButtonboxHorizontalChar, setCDKBut-
       tonboxBoxAttribute, setCDKButtonboxBackgroundColor,  eraseCDKButtonbox,
       destroyCDKButtonbox, setCDKButtonboxPreProcess, setCDKButtonboxPostPro-
       cess - Creates a managed curses buttonbox widget.

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

       #include <cdk.h>

       CDKBUTTONBOX *newCDKButtonbox  (CDKSCREEN  *cdkscreen,  int  xpos,  int
       ypos, int height, int width, char ** title, int rows, int cols, char **
       buttons,  int  buttonCount,  chtype  highlight,  boolean  box,  boolean
       shadow);

       int activateCDKButtonbox (CDKBUTTONBOX *buttonbox, chtype * actions);

       int injectCDKButtonbox (CDKBUTTONBOX *buttonbox, chtype input);

       void  setCDKButtonbox (CDKBUTTONBOX *buttonbox, chtype highlight, bool-
       ean box);

       void setCDKButtonboxHighlight (CDKBUTTONBOX  *buttonbox,  chtype  high-
       light);

       chtype getCDKButtonboxHighlight (CDKBUTTONBOX *buttonbox);

       void setCDKButtonboxBox (CDKBUTTONBOX *buttonbox, boolean box);

       boolean getCDKButtonboxBox (CDKBUTTONBOX *buttonbox);

       void  setCDKButtonboxULChar  (CDKBUTTONBOX  *,buttonbox, chtype charac-
       ter);

       void setCDKButtonboxURChar (CDKBUTTONBOX  *,buttonbox,  chtype  charac-
       ter);

       void  setCDKButtonboxLLChar  (CDKBUTTONBOX  *,buttonbox, chtype charac-
       ter);

       void setCDKButtonboxLRChar (CDKBUTTONBOX  *,buttonbox,  chtype  charac-
       ter);

       void   setCDKButtonboxVerticalChar  (CDKBUTTONBOX  *,buttonbox,  chtype
       character);

       void setCDKButtonboxHorizontalChar  (CDKBUTTONBOX  *,buttonbox,  chtype
       character);

       void   setCDKButtonboxBoxAttribute  (CDKBUTTONBOX  *,buttonbox,  chtype
       character);

       void setCDKButtonboxBackgroundColor (CDKBUTTONBOX *,buttonbox,  char  *
       color);

       void moveCDKButtonbox (CDKBUTTONBOX *buttonbox, int box, int box, bool-
       ean relative, boolean refresh);

       void positionCDKButtonbox (CDKBUTTONBOX *buttonbox);

       void drawCDKButtonbox (CDKBUTTONBOX *buttonbox, boolean box);

       void eraseCDKButtonbox (CDKBUTTONBOX *buttonbox);

       void  setCDKButtonboxPreProcess  (CDKBUTTONBOX  *buttonbox,   PROCESSFN
       callback, void * data);

       void  setCDKButtonboxPostProcess  (CDKBUTTONBOX  *buttonbox,  PROCESSFN
       callback, void * data);

       void destroyCDKButtonbox (CDKBUTTONBOX *buttonbox);

       void bindCDKObject (EObjectType widgetType, void * object, chtype  key,
       BINDFN function, void * data);

DESCRIPTION
       The  Cdk  buttonbox widget creates a buttonbox box with a message and a
       varied number of buttons to choose from. The  following  are  functions
       which create or manipulate the Cdk buttonbox box widget.

AVAILABLE FUNCTIONS
       CDKBUTTONBOX  *newCDKButtonbox  (CDKSCREEN *screen, int xpos, int ypos,
       char **title , int rows, int cols,  char  **buttons,  int  buttonCount,
       chtype highLight, boolean box, boolean shadow);
          This  function  creates  a pointer to a buttonbox widget. The screen
          parameter is the screen you wish this widget to be  placed  in.  The
          parameter  xpos controls the placement of the object along the hori-
          zontal axis. This parameter accepts an integer value or one  of  the
          pre-defined  values  of  LEFT, RIGHT, and CENTER. The parameter ypos
          controls the placement of the object along the vertical  axis.  This
          parameter can accept an integer value or one of the pre-defined val-
          ues of TOP, BOTTOM, and CENTER.  The  height  and  width  parameters
          control  the  height and width of the widget. The parameter title is
          the title of the widget. The rows parameter states how many rows  of
          buttons  there  will  be;  of columns.  The buttons array contains a
          list of all the buttons; while buttonCount is the number of elements
          in  the  button  array.  highlight is the attribute of the currently
          highlighted button. The box parameter states whether the widget will
          be drawn with a box around it or not. The shadow parameter accepts a
          boolean value to turn the shadow on or off around  this  widget.  If
          the widget could not be created then a NULL pointer is returned.

       int activateCDKButtonbox (CDKBUTTONBOX *buttonbox, chtype *actions);
          This  function  activates  the  buttonbox  widget  and lets the user
          interact with the widget. The parameter buttonbox is a pointer to  a
          non-NULL  buttonbox widget.  If the actions parameter is passed with
          a non-NULL value, the characters in the array will be injected  into
          the  widget.  To  activate  the  widget interactively pass in a NULL
          pointer for actions. If the character entered into  this  widget  is
          RETURN  or  TAB then this function will return a value from 0 to the
          number of buttons -1, representing the button selected. It will also
          set  the  structure  member  exitType  to  vNORMAL. If the character
          entered into this widget was ESCAPE then the widget  will  return  a
          value  of  -1  and  the  structure  member  exitType  will be set to
          vESCAPE_HIT.

       int injectCDKButtonbox (CDKBUTTONBOX *buttonbox, chtype character);
          This function injects a single character into the widget. The param-
          eter  buttonbox  is  a  pointer  to a non-NULL buttonbox widget. The
          parameter character is the character to inject into the  widget.  If
          the  character injected into this widget was RETURN then the charac-
          ter injected into this widget is RETURN or TAB  then  this  function
          will return a value from 0 to the number of buttons -1, representing
          the button selected. It will also set the structure member  exitType
          to  vNORMAL.  If  the  character entered into this widget was ESCAPE
          then the widget will return a value of -1 and the  structure  member
          exitType  will  be  set to vESCAPE_HIT. Any other character injected
          into  the  widget  will  set  the  structure  member   exitType   to
          vEARLY_EXIT and the function will return -1.

       void  setCDKButtonbox (CDKBUTTONBOX *buttonbox, chtype highlight, bool-
       ean box);
          This function lets the programmer  modify  certain  elements  of  an
          already  defined buttonbox widget. The parameter names correspond to
          the same parameter names listed in the newCDKButtonbox function.

       void setCDKButtonboxHighlight (CDKBUTTONBOX  *buttonbox,  chtype  high-
       light);
          This sets the highlight attribute of the selected button.
       chtype getCDKButtonboxHighlight (CDKBUTTONBOX *buttonbox);
          This returns the highlight attribute of the widget.

       void setCDKButtonboxBox (CDKBUTTONBOX *buttonbox, boolean boxWidget);
          This  sets  whether or not the widget will be draw with a box around
          it.

       boolean getCDKButtonboxBox (CDKBUTTONBOX *buttonbox);
          This returns whether or not the widget will  be  drawn  with  a  box
          around it.

       void setCDKButtonboxULChar (CDKBUTTONBOX *buttonbox, chtype character);
          This  function sets the upper left hand corner of the widgets box to
          the given character.

       void setCDKButtonboxURChar (CDKBUTTONBOX *buttonbox, chtype character);
          This function sets the upper right hand corner of the widgets box to
          the given character.

       void setCDKButtonboxLLChar (CDKBUTTONBOX *buttonbox, chtype character);
          This  function sets the lower left hand corner of the widgets box to
          the given character.

       void setCDKButtonboxLRChar (CDKBUTTONBOX *buttonbox, chtype character);
          This function sets the lower right hand corner of the widgets box to
          the given character.

       void setCDKButtonboxVerticalChar (CDKBUTTONBOX *buttonbox, chtype char-
       acter);
          This function sets the vertical drawing character for the box to the
          given character.

       void  setCDKButtonboxHorizontalChar  (CDKBUTTONBOX  *buttonbox,  chtype
       character);
          This function sets the horizontal drawing character for the  box  to
          the given character.

       void   setCDKButtonboxBoxAttribute   (CDKBUTTONBOX  *buttonbox,  chtype
       attribute);
          This function sets the attribute of the box.

       void  setCDKButtonboxBackgroundColor  (CDKBUTTONBOX  *buttonbox,   char
       *color);
          This sets the background color of the widget. The parameter color is
          in the format of the Cdk format strings.  To  get  more  information
          look at the cdk_display manual page.

       void  moveCDKButtonbox  (CDKBUTTONBOX  *buttonbox,  int xpos, int ypos,
       boolean relative, boolean refresh);
          This function moves the given widget  to  the  given  position.  The
          parameters  xpos  and  ypos  is  the new position of the widget. The
          parameter xpos can accept an integer value or one of the pre-defined
          values  of TOP, BOTTOM, and CENTER. The parameter ypos can accept an
          integer value or one of the pre-defined values of LEFT,  RIGHT,  and
          CENTER.  The parameter relative states whether the xpos/ypos pair is
          a relative move or an absolute move. For example if  xpos  =  1  and
          ypos  =  2  and  relative = TRUE, then the widget would move one row
          down and two columns right. If the value of relative was FALSE  then
          the  widget  would move to the position (1,2). Do not use the values
          of TOP, BOTTOM, LEFT, RIGHT, or CENTER when relative = TRUE.  (weird
          things  may  happen). The final parameter refresh is a boolean value
          which states whether the widget will get refreshed after the move or
          not.

       void positionCDKButtonbox (CDKBUTTONBOX *buttonbox);
          This  function  allows the user to move the widget around the screen
          via the cursor/keypad keys. The following key bindings can  be  used
          to move the widget around the screen.

          Key Bindings
             Key          Action
             Up Arrow     Moves the widget up one line.
             Down Arrow   Moves the widget down one line.
             Left Arrow   Moves the widget left one column
             Right Arrow  Moves the widget right one column
             Keypad-1     Moves the widget down one line
                          and left one column.
             Keypad-2     Moves the widget down one line.
             Keypad-3     Moves the widget down one line
                          and right one column.
             Keypad-4     Moves the widget left one column
             Keypad-5     Centers the widget both vertically
                          and horizontally.
             Keypad-6     Moves the widget right one column
             Keypad-7     Moves the widget up one line
                          and left one column.
             Keypad-8     Moves the widget up one line.
             Keypad-9     Moves the widget up one line
                          and right one column.
             t            Moves the widget to the top of the screen.
             b            Moves the widget to the bottom of the screen.
             l            Moves the widget to the left of the screen.
             r            Moves the widget to the right of the screen.
             c            Centers the widget between the left and
                          right of the window.
             C            Centers the widget between the top and
                          bottom of the window.
             Escape       Returns the widget to its original position.
             Return       Exits the function and leaves the widget
                          where it was.

             Keypad  means  that  if  the keyboard you are using has a keypad,
             then the Num-Lock light has to be on in order to use the keys  as
             listed. (The numeric keys at the top of the keyboard will work as
             well.)

             void drawCDKButtonbox (CDKBUTTONBOX *buttonbox, boolean box);
                This function draws the buttonbox widget on  the  screen.  The
                box option draws the widget with or without a box.

             void eraseCDKButtonbox (CDKBUTTONBOX *buttonbox);
                This  function  removes  the widget from the screen. This does
                NOT destroy the widget.

             void destroyCDKButtonbox (CDKBUTTONBOX *buttonbox);
                This function removes the widget from the screen and frees  up
                any memory the object may be using.

             void  setCDKButtonboxPreProcess  (CDKBUTTONBOX  *buttonbox,  PRO-
             CESSFN function, void *data);
                This function allows the user to have the widget call a  func-
                tion  after  a key is hit and before the key is applied to the
                widget. The parameter  function  if  of  type  PROCESSFN.  The
                parameter  data is a pointer to void. To learn more about pre-
                processing read the cdk_process manual page.

             void setCDKButtonboxPostProcess  (CDKBUTTONBOX  *buttonbox,  PRO-
             CESSFN function, void *data);
                This  function allows the user to have the widget call a func-
                tion after the key has been applied to the widget.  The param-
                eter  function  if  of type PROCESSFN. The parameter data is a
                pointer to void. To learn more about post-processing read  the
                cdk_process manual page.

             void  bindCDKObject (EObjectType widgetType, void *object, chtype
             key, BINDFN function, void *data);
                This function allows the user to create special key  bindings.
                The  widgetType  parameter is a defined type which states what
                Cdk object type is being used.  To learn more about  the  type
                EObjectType  read  the  cdk_binding  manual  page.  The object
                parameter is the pointer to the widget object. The key is  the
                character to bind. The function is the function type. To learn
                more about the key binding callback function  types  read  the
                cdk_binding  manual page. The last parameter data is a pointer
                to any data that needs to get passed to the callback function.

KEY BINDINGS
       When the widget is activated there are  several  default  key  bindings
       which  will  help the user enter or manipulate the information quickly.
       The following table outlines the keys and their actions for  this  wid-
       get.

          Key          Action
          Left Arrow   Selects the button to the left of the current button.
          Right Arrow  Selects the button to the right of the current button.
          Tab          Selects the button to the right of the current button.
          Space        Selects the button to the right of the current button.
          Return       Exits the widget and returns an integer value
                       representing which button was selected. This also sets
                       the structure member exitType in the widget pointer
                       to the value of vNORMAL.
          Tab          Exits the widget and returns an integer value representing
                       which button was selected. This also sets the structure
                       member exitType in the widget pointer to the value
                       of vNORMAL.
          Escape       Exits the widget and returns -1. This also sets the structure
                       member exitType in the widget pointer to the value of
                       vESCAPE_HIT.
          Ctrl-L       Refreshes the screen.

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

NOTES
       The  header  file  &lt&lt;cdk.h&gt&gt;  automatically  includes  the  header  files
       &lt&lt;curses.h&gt&gt;, &lt&lt;stdlib.h&gt&gt;, &lt&lt;string.h&gt&gt;, &lt&lt;ctype.h&gt&gt;, &lt&lt;unistd.h&gt&gt;,  &lt&lt;dirent.h&gt&gt;,
       &lt&lt;time.h&gt&gt;, &lt&lt;errno.h&gt&gt;, &lt&lt;pwd.h&gt&gt;, &lt&lt;grp.h&gt&gt;, &lt&lt;sys/stat.h&gt&gt;, and &lt&lt;sys/types.h&gt&gt;.
       The &lt&lt;curses.h&gt&gt; header file includes &lt&lt;stdio.h&gt&gt; and &lt&lt;unctrl.h&gt&gt;.

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



                                 24 April 1997                cdk_buttonbox(3)