cdk_radio(3)
- NetBSD Manual Pages
cdk_radio(3) cdk_radio(3)
NAME
newCDKRadio, activateCDKRadio, injectCDKRadio, setCDKRadio, setCDKRa-
dioHighlight, getCDKRadioHighlight, setCDKRadioChoiceCharacter, getCD-
KRadioChoiceCharacter, setCDKRadioLeftBrace, getCDKRadioLeftBrace,
setCDKRadioRightBrace, getCDKRadioRightBrace, setCDKRadioBox, getCDKRa-
dioBox, setCDKRadioULChar, setCDKRadioURChar, setCDKRadioLLChar, setCD-
KRadioLRChar, setCDKRadioVerticalChar, setCDKRadioHorizontalChar,
setCDKRadioBoxAttribute, setCDKRadioBackgroundColor, drawCDKRadio,
eraseCDKRadio, destroyCDKRadio, setCDKRadioPreProcess, setCDKRadioPost-
Process
- Creates a managed curses radio list widget.
SYNOPSIS
cc [ flag ... ] file ... -lcdk [ library ... ]
#include <cdk.h>
CDKRADIO *newCDKRadio (CDKSCREEN *cdkscreen, int xpos, int ypos, int
spos, int height, int width, char *title, char **radioList, int radi-
oListLength, chtype choiceCharacter, int defaultItem, chtype highlight,
boolean box, boolean shadow);
int activateCDKRadio (CDKRADIO *radio, chtype *actions);
int injectCDKRadio (CDKRADIO *radio, chtype input);
void setCDKRadio (CDKRADIO *radio, chtype highlight, chtype choiceChar-
acter, boolean box);
void setCDKRadioHighlight (CDKRADIO *radio, chtype highlight);
chtype getCDKRadioHighlight (CDKRADIO *radio);
void setCDKRadioChoiceCharacter (CDKRADIO *radio, chtype character);
chtype getCDKRadioChoiceCharacter (CDKRADIO *radio);
void setCDKRadioLeftBrace (CDKRADIO *radio, chtype character);
chtype getCDKRadioLeftBrace (CDKRADIO *radio);
void setCDKRadioRightBrace (CDKRADIO *radio, chtype character);
chtype getCDKRadioRightBrace (CDKRADIO *radio);
void setCDKRadioBox (CDKRADIO *radio, boolean box);
boolean getCDKRadioBox (CDKRADIO *radio);
void drawCDKRadio (CDKRADIO *radio, boolean box);
void setCDKRadioULChar (CDKRADIO *,radio, chtype character);
void setCDKRadioURChar (CDKRADIO *,radio, chtype character);
void setCDKRadioLLChar (CDKRADIO *,radio, chtype character);
void setCDKRadioLRChar (CDKRADIO *,radio, chtype character);
void setCDKRadioVerticalChar (CDKRADIO *,radio, chtype character);
void setCDKRadioHorizontalChar (CDKRADIO *,radio, chtype character);
void setCDKRadioBoxAttribute (CDKRADIO *,radio, chtype character);
void setCDKRadioBackgroundColor (CDKRADIO *,radio, char * color);
void moveCDKRadio (CDKRADIO *radio, int box, int box, boolean relative,
boolean refresh);
void positionCDKRadio (CDKRADIO *radio);
void eraseCDKRadio (CDKRADIO *radio);
void destroyCDKRadio (CDKRADIO *radio);
void setCDKRadioPreProcess (CDKRADIO *radio, PROCESSFN callback, void *
data);
void setCDKRadioPostProcess (CDKRADIO *radio, PROCESSFN callback, void
* data);
void bindCDKObject (EObjectType widgetType, void *object, chtype key,
BINDFN function, void *data);
DESCRIPTION
The Cdk radio widget creates a radio list. The following are functions
which create or manipulate the Cdk radio box widget.
AVAILABLE FUNCTIONS
CDKRADIO *newCDKRadio (CDKSCREEN *screen, int xpos, int ypos, int
height, int width, char *title, char **radioList, int radioListLength,
chtype choiceCharacter, int defaultItem, chtype highlight, boolean box,
boolean shadow);
This function creates a pointer to a radio widget. The screen param-
eter is the screen you wish this widget to be placed in. The parame-
ter xpos controls the placement of the object along the horizontal
axis. This parameter can accept an integer value or one of the pre-
defined values of LEFT, RIGHT, and CENTER. The parameter ypos con-
trols 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 parameter spos is where the
scroll bar is to be placed. This can accept one of three values:
LEFT, which puts the scroll bar on the left of the scrolling list.
RIGHT which puts the scroll bar on the right side of the list, and
NONE which does not add a scroll bar. The parameters height and
width control the height and width of the widget. If you provide a
value of zero for either of the height or the width, the widget will
be created with the full width and height of the screen. If you pro-
vide a negative value, the widget will be created the full height or
width minus the value provided. The title parameter is the string
which will be displayed at the top of the widget. The title can be
more than one line; just provide a carriage return character at the
line break. The parameter radioList is the list of items to be dis-
played in the radio list; radioListLength is the number of elements
in the given list. The highlight parameter specifies the display
attribute of the currently selected item. The choiceCharacter param-
eter is the character to use to highlight the current selection. The
defaultItem value is an integer which corresponds to the default
selection. 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 activateCDKRadio (CDKRADIO *radio, chtype *actions);
This function activates the radio widget and lets the user interact
with the widget. The parameter radio is a pointer to a non-NULL
radio 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 items
-1, representing the item selected. It will also set the structure
member exitType to vNORMAL. If the character entered into this wid-
get was ESCAPE then the widget will return a value of -1 and the
structure member exitType will be set to vESCAPE_HIT.
int injectCDKRadio (CDKRADIO *radio, chtype character);
This function injects a single character into the widget. The param-
eter radio is a pointer to a non-NULL radio widget. The parameter
character is the character to inject into the widget. If the charac-
ter injected into this widget was RETURN then the character injected
into this widget is RETURN or TAB then this function will return a
value from 0 to the number of items -1, representing the items
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 func-
tion will return -1.
void setCDKRadio (CDKRADIO *radio, chtype highlight, chtype choiceChar-
acter, boolean box);
This function lets the programmer modify certain elements of an
already defined radio widget. The parameter names correspond to the
same parameter names listed in the newCDKRadio function.
void setCDKRadioChoiceCharacter (CDKRADIO *radio, chtype choiceCharac-
ter);
This sets the character to use to draw the selected element in the
list.
chtype getCDKRadioChoiceCharacter (CDKRADIO *radio);
This returns the character being used to draw the selected element
in the list.
void setCDKRadioLeftBrace (CDKRADIO *radio, chtype choiceCharacter);
This sets the character to use to draw the left brace of the selec-
tion box.
chtype getCDKRadioLeftBrace (CDKRADIO *radio);
This returns the character being used to draw the left brace of the
selection box.
void setCDKRadioRightBrace (CDKRADIO *radio, chtype choiceCharacter);
This sets the character to use to draw the right brace of the selec-
tion box.
chtype getCDKRadioRightBrace (CDKRADIO *radio);
This returns the character being used to draw the right brace of the
selection box.
void setCDKRadioHighlight (CDKRADIO *radio, chtype highlight);
This sets the attribute of the highlight bar.
chtype getCDKRadioHighlight (CDKRADIO *radio);
This returns the attribute of the highlight bar.
void setCDKRadioBox (CDKRADIO *radio, boolean boxWidget);
This sets whether or not the widget will be draw with a box around
it.
boolean getCDKRadioBox (CDKRADIO *radio);
This returns whether or not the widget will be drawn with a box
around it.
void setCDKRadioULChar (CDKRADIO *radio, chtype character);
This function sets the upper left hand corner of the widgets box to
the given character.
void setCDKRadioURChar (CDKRADIO *radio, chtype character);
This function sets the upper right hand corner of the widgets box to
the given character.
void setCDKRadioLLChar (CDKRADIO *radio, chtype character);
This function sets the lower left hand corner of the widgets box to
the given character.
void setCDKRadioLRChar (CDKRADIO *radio, chtype character);
This function sets the lower right hand corner of the widgets box to
the given character.
void setCDKRadioVerticalChar (CDKRADIO *radio, chtype character);
This function sets the vertical drawing character for the box to the
given character.
void setCDKRadioHorizontalChar (CDKRADIO *radio, chtype character);
This function sets the horizontal drawing character for the box to
the given character.
void setCDKRadioBoxAttribute (CDKRADIO *radio, chtype attribute);
This function sets the attribute of the box.
void setCDKRadioBackgroundColor (CDKRADIO *radio, 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 moveCDKRadio (CDKRADIO *radio, int xpos, int ypos, boolean rela-
tive, 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 positionCDKRadio (CDKRADIO *radio);
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 drawCDKRadio (CDKRADIO *radio, boolean box);
This function draws the radio widget on the screen. The box
option draws the widget with or without a box.
void eraseCDKRadio (CDKRADIO *radio);
This function removes the widget from the screen. This does
NOT destroy the widget.
void destroyCDKRadio (CDKRADIO *radio);
This function removes the widget from the screen and frees up
any memory the object may be using.
void setCDKRadioPreProcess (CDKRADIO *radio, PROCESSFN 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 setCDKRadioPostProcess (CDKRADIO *radio, PROCESSFN 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, char
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 Shifts the whole list left one character.
Right Arrow Shifts the whole list right one character.
Up Arrow Selects the next item up in the list.
Down Arrow Selects the next item down in the list.
Space Selects/deselects the current choice.
Prev Page Moves one page backwards.
Ctrl-B Moves one page backwards.
Next Page Moves one page forwards.
Ctrl-F Moves one page forwards.
g Moves to the first element in the list.
1 Moves to the first element in the list.
G Moves to the last element in the list.
$ Shifts the whole list to the far right.
| Shifts the whole list to the far left.
Return Exits the widget and returns an integer
value representing which item 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 item 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_screen(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.
24 April 1997 cdk_radio(3)
Powered by man-cgi (2024-03-20).
Maintained for NetBSD
by Kimmo Suominen.
Based on man-cgi by Panagiotis Christias.