The Cdk file selector widget creates a widget which allows a user to interact
with the Unix file system. This widget allows the user to traverse the file
system and even delete files. (See NOTES below for more information)
AVAILABLE FUNCTIONS
CDKFSELECT *newCDKFselect (CDKSCREEN *screen, int xpos, int ypos, int height, int width, char *title, char *label, chtype fieldAttribute, chtype fillerChar, chtype highlight, chtype dirAttribute, chtype fileAttribute, chtype linkAttribute, chtype sockAttribute, boolean box, boolean shadow);
This function creates a pointer to a fselect 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 horizontal axis. This parameter
can accept 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 values of TOP, BOTTOM, and CENTER.
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 provide 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
label sets the label of the file selector. The fieldAttribute
parameter sets the attribute of the entry field at the top of the widget;
fillerCharacter defines the filler character for the entry field. The
highlight sets the highlight attribute on the scrolling list. The next
four parameters: dirAttribute, fileAttribute, linkAttribute,
and sockAttribute set the attributes of directories, files, links, and
sockets found in the directory list. 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.
This function activates the file selector widget and lets the user interact with the
widget. The parameter fselect is a pointer to a non-NULL file selector 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 char * representing the information typed into the widget and the
structure member exitType will be set to vNORMAL. If the character
entered was ESCAPE then the function will returns NULL pointer and
the structure member exitType is set to vESCAPE_HIT.
This function injects a single character into the widget. The parameter
fselect is a pointer to a non-NULL file selector. The parameter
character is the character to inject into the widget. If the character
injected into this widget was RETURN or TAB then this function will
return a char * representing the information typed into the widget and the
structure member exitType will be set to vNORMAL. If the character
entered was ESCAPE then the function will returns NULL pointer and
the structure member exitType is 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 a NULL pointer.
This function lets the programmer modify certain elements of an already
defined fselect widget. The parameter names correspond to the same parameter
names listed in the newCDKFselect function.
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 moveCDKFselect (CDKFSELECT *fselect, 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. (wierd 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 positionCDKFselect (CDKFSELECT *fselect);
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 it's 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.)
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
call-back 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 call-back 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. Since this widget is
built from both the scrolling list widget and the entry field widget, the key
bindings are the same for the respective fields. The extra key bindings are
listed below.
Key Bindings
Key Action
Tab Tries to complete the current filename.
Up Arrow Scrolls the scrolling list up one line.
Down Arrow Scrolls the scrolling list down one line.
Page Up Scrolls the scrolling list up one page.
CTRL-B Scrolls the scrolling list up one page.
Page Down Scrolls the scrolling list down one page.
CTRL-F Scrolls the scrolling list down one page.
Return Returns the filename in the entry field of
the file selector. It also sets the structure
member exitType in the widget to vNORMAL.
Escape Exits the widget and returns a NULL pointer.
It also sets the structure member exitType
in the widget to vESCAPE_HIT.
This widget is created from the scrolling list widget and the entry field
widget. This is a good example on how to build your own widgets using the
base widgets provided in this distribution. In order for you to delete
files using the file selector, you must add the following line of code
into your program. (the character X is the character you wish to use to
tell the file selector you want to delete a file.)
where fselect is a pointer to the object. This was originally turned on,
but I thought it better to put the control of file deletion on an 'as-need'
basis.