
                           C-scape Function List
                   Copyright (c) 1992, Liant Software Corporation.

C-scape has higher and lower level functions.  The higher level functions 
make it easy for you to perform complex tasks, such as creating menuing 
systems or popups and giving screens mouse support.  Frequently, higher 
level functionality (such as vertical and horizontal scrolling) is built 
into seds (Screen EDitors), so that you automatically get the behavior 
that you want.  Of course, C-scape provides hundreds of basic functions 
to perform simple tasks, such as setting a sed's position or colors.


Sed (Screen EDitor window) Creation Functions

menu_Flush  			frees the menu object's creation data.
menu_Printf  			defines a menu.
menu_Open  				creates a new menu object.
sed_Close  				destroys a sed object.
sed_CreateBob  			creates a bob object from a sed.
sed_Go  				activates a sed.
sed_Open  				creates a new sed object.

Sed Paint Functions

sed_Clear  				clears the area under the sed.
sed_Pop  				fires a sed's window.
sed_Repaint  			repaints the sed.
sed_RepaintField  		repaints a field.
sed_RepaintFields  		repaints all the fields.
sed_Top  				moves the sed's window to the foreground.
sed_Update  			paints a sed without converting data.
sed_UpdateCurrField  	paints the current field.
sed_UpdateField  		paints a field without converting data.
sed_UpdateFields  		paints all the fields.

Sed Parameter Functions

sed_Find  				finds a sed by its name.
sed_GetBaton  			gets the sed's baton.
sed_GetColors  			gets the sed's colors.
sed_GetCorners  		gets the sed's corners.
sed_GetData  			gets the sed's generic data pointer.
sed_GetExit  			gets the sed's exit state.
sed_GetHeight  			gets the sed's height.
sed_GetHiRegAttr  		gets the sed's regular highlighted attribute.
sed_GetHiSelAttr  		gets the sed's selected highlighted attribute.
sed_GetLabel  			gets the value of the sed's label.
sed_GetMenu  			gets the sed's menu.
sed_GetMenuHeight  		gets the height of the sed's menu.
sed_GetMenuWidth  		gets the width of the sed's menu.
sed_GetName  			gets the sed's name.
sed_GetPosition  		gets the sed's position.
sed_GetScratchPad  		gets the sed's scratch pad.
sed_GetScratchSize  	gets the size of the sed's scratch pad.
sed_GetSize  			gets the sed's dimensions.
sed_GetWidth  			gets the sed's width.
sed_GetXoffset  		gets the sed's xoffset.
sed_GetYoffset  		gets the sed's yoffset.
sed_IsActive  			checks if the sed is in active mode.
sed_SetActive  			sets the sed's active flag.
sed_SetAux  			attaches an auxiliary function to a sed.
sed_SetBaton  			sets the value of the sed's baton.
sed_SetColors  			sets the sed's colors.
sed_SetData  			sets the sed's generic data pointer.
sed_SetExit  			sets the sed's exit state.
sed_SetExplode  		attaches an explode function to the sed.
sed_SetHeight  			sets the sed's height.
sed_SetHiColors  		sets the sed's highlighted attributes.
sed_SetLabel  			sets the value of the sed's label.
sed_SetName  			sets a sed's name.
sed_SetPosition  		sets the sed's position.
sed_SetShadow  			sets the sed's shadow size.
sed_SetShadowAttr  		sets the sed's shadow attribute.
sed_SetSpecial  		attaches the sed's special function.
sed_SetWidth  			sets the sed's width.
sed_ToggleExit  		exits the sed.

Sed Field Movement Functions

sed_DecField  			goes to the previous field.
sed_DownField  			moves down a field.
sed_GotoField  			goes to a specific field.
sed_GotoFirstField  	goes to the first field.
sed_GotoGridField  		goes to a field using its grid address.
sed_GotoLastField  		goes to the last field.
sed_GotoNameField  		goes to a field using its name.
sed_IncField  			goes to the next field.
sed_LeftField  			moves left a field.
sed_MoveField  			moves a field.
sed_PageDown  			scrolls the sed down one page.
sed_PageLeft  			scrolls the sed left one page.
sed_PageRight  			scrolls the sed right one page.
sed_PageUp  			scrolls the sed up one page.
sed_RightField  		moves right a field.
sed_ScrollDown  		scrolls the sed down.
sed_ScrollLeft  		scrolls the sed left.
sed_ScrollRight  		scrolls the sed right.
sed_ScrollUp  			scrolls the sed up.
sed_UpField  			moves up a field.

Sed Cursor Movement Functions

sed_DecChar  			moves to the previous character.
sed_GoEnd  				goes to the end of the current field.
sed_GoHome  			goes to the start of the current field.
sed_GotoChar  			goes to a position in the current field.
sed_IncChar  			moves to the next character in a field.
sed_IsEnd  				checks if the cursor is at the end of a field.
sed_IsHome  			checks if the cursor is at the start of a field.
sed_Overwrite  			overwrites the current character.
sed_PullLeft  			deletes a character, pulling left.
sed_PullRight  			deletes a character, pulling right.
sed_PushLeft  			inserts a character, pushing left.
sed_PushRight  			inserts a character, pushing right.

Sed Field Functions

sed_DeleteField  		removes a field.
sed_DeleteRows  		deletes rows from a sed.
sed_DoFieldFenter  		executes the field's fenter function.
sed_DoFieldFexit  		executes the field's fexit function.
sed_DoFieldFkey  		executes the field's fkey function.
sed_DoFieldSenter  		executes the field's senter function.
sed_DoFieldSexit  		executes the field's sexit function.
sed_DoSenters  			executes all the fields' senter functions.
sed_DoSexits  			executes all the fields' sexit functions.
sed_DoSpecial  			executes the sed's special function.
sed_GetChar  			gets a character within the current field.
sed_GetCurrChar  		gets the character at the current position.
sed_GetCurrFieldData 	gets the current field's data pointer.
sed_GetCurrMerge  		gets the current field's merge.
sed_GetCurrRecord  		gets the current field's record.
sed_GetCurrRecordLen 	gets current field's record length.
sed_GetCurrVar  		gets the current field's variable.
sed_GetFieldBob  		gets the bob attached to a field.
sed_GetFieldChar  		gets a character within a field.
sed_GetFieldCol  		gets the field's first column number.
sed_GetFieldColors  	gets the field's colors.
sed_GetFieldCount  		gets the number of fields in the sed.
sed_GetFieldData  		gets a field's data pointer.
sed_GetFieldDataCount	gets the field's number of data pointers.
sed_GetFieldLastCol  	gets the field's last column number.
sed_GetFieldName  		gets a field's name.
sed_GetFieldNo  		gets the current field number.
sed_GetFieldRow  		gets the field's row number.
sed_GetFieldWidth  		gets the field's displayed width.
sed_GetFieldXoffset  	gets the field's xoffset.
sed_GetFuncs  			gets the field's field function.
sed_GetGridCol  		gets the field's grid column number.
sed_GetGridField  		gets the field number at the grid position.
sed_GetGridRow  		gets the field's grid row number.
sed_GetMerge  			gets the field's merge.
sed_GetMergeLen  		gets the length of the field's merge.
sed_GetMergePos  		gets the current position in the merge.
sed_GetNameNo  			gets the field number associated with a name.
sed_GetNameVar  		gets the field variable associated with a name.
sed_GetRecord  			gets the field's record.
sed_GetRecordLen  		gets the length of the field's record.
sed_GetRecordPos  		gets the current position in the record.
sed_GetVar  			gets the field's variable.
sed_GetVarSize  		gets the field's variable size.
sed_InsertRows  		inserts rows in a sed.
sed_IsMarkedField  		checks if the field is marked.
sed_IsProtectedField 	checks if the field is protected.
sed_MarkField  			marks a field.
sed_ProtectField  		protects a field.
sed_SearchMerge  		searches for fields by first letter.
sed_SetCurrRecord  		sets the current field's record.
sed_SetFieldBob  		attaches a bob object to a field.
sed_SetFieldData  		sets a field's data pointer.
sed_SetFieldHiChar  	sets a field's highlighted character.
sed_SetFieldName  		sets a field's name.
sed_SetFieldWidth  		sets the field's displayed width.
sed_SetFuncs  			sets the field's field function.
sed_SetRecord  			sets the field's record.
sed_SetVar  			sets the field's variable.
sed_SwapFields  		swaps fields' positions.
sed_UnMarkField  		unmarks a field.
sed_UnProtectField  	unprotects a field.

Sed Border Functions

sed_BorderExists  		checks if the sed has a border.
sed_BorderPrompt  		displays a prompt in the border.
sed_GetBordCorners  	gets the sed's border's corners.
sed_GetBorderColor  	gets the color of the sed's border.
sed_GetBorderHeight  	gets the height of the sed's border.
sed_GetBorderWidth  	gets the width of the sed's border.
sed_RepaintBorder  		repaints the sed's border.
sed_SetBorder  			attaches a border to a sed.
sed_SetBorderColor  	sets the color of the sed's border.
sed_SetBorderFeature 	sets the features of a border. 
sed_SetBorderTitle  	sets the title of a titled border.

Standard Field Functions

alpha_funcs  			edits an alphabetic string.
attr_funcs   			provides popup for entry of attributes.
bob_funcs  				passes control to an embedded basic object
bobint_funcs            passes control to an embedded basic object.
char_funcs  			edits a single character.
check_funcs  			makes multiple selections with a check mark.
click_funcs  			makes a menu choice with characters or Enter.
clong_funcs  			edits a long integer with commas.
cmoney_funcs  			edits a monetary value with commas.
date_funcs  			edits a date.
datet_funcs             edits a date.
digit_funcs  			edits a numeric string.
double_funcs  			edits a double floating point value.
framer_funcs  			controls framer menuing systems.
gmenu_funcs  			makes a menu choice using grid movement.
hex_funcs  				edits a hexadecimal integer.
int_funcs  				edits an integer, calculator style.
list_funcs  			selects from a pop up a list.
long_funcs  			edits a long integer, calculator style.
mark_funcs  			makes multiple selections by highlighting.
menu_funcs  			makes a menu choice.
money_funcs  			edits a monetary value.
nowrite_funcs  			treats the field as a menu choice.
odir_funcs         		controls directory field of a filebox dialog.
ofile_funcs       		controls field field of a filebox dialog.
pint_funcs  			edits a positive integer.
plong_funcs  			edits a positive long integer.
popbob_funcs       		pops up a bob attached to the field. 
radio_funcs  			selects one choice from a group.
radiobob_funcs          selects exclusively from a list.
range_funcs  			edits an integer as scaled bar.
screen_funcs       		provides popups for screens in a screen file. 
sdouble_funcs  			edits a double, string style.
secure_funcs  			edits a disguised character string.
sfloat_funcs  			edits a float, string style.
sint_funcs  			edits an integer, string style.
slong_funcs  			edits of a long integer, string style.
slug_funcs  			controls slug menuing systems.
string_funcs  			edits a string.
strlist_funcs   		provides popup based on string array.
ted_funcs  				edits a sed's text buffer.
time_funcs  			edits a time.
timet_funcs             edits a time.
toggle_funcs  			steps through choices from a list.
togint_funcs  			steps through choices from a list.
xstring_funcs  			edits a string with extended ASCII.
yesno_funcs  			chooses Yes or No.

Popup Functions

opc_Close				destroys a popup context.
opc_Edit  				creates a popup editor box.
opc_FileBox				creates a file selection box.
opc_Get*				queries a popup context
opc_Menu  				creates a popup menu.
opc_Message  			creates a popup message box.
opc_Open				opens a popup context.
opc_Prompt  			creates a popup prompt box.
opc_Set*				modifies a popup context
opc_Text  				creates a popup text box.
opc_Verify				creates a verifiction box.
opc_View  				views text in a popup box.

Framer (Pulldown) Menu Functions

frame_Close				destroys a frame menu object.
frame_Go				activate a frame menu.
frame_Lock				locks a frame menu choice.
frame_Open				creates a frame menu object.
frame_Repaint			paints a frame menu.
frame_SetPosition		sets the position of a frame menu.
frame_UnLock			unlocks a frame menu choice.

Slug (and 123-style) Menu Functions

slug_Close				destroys a slug menu object.
slug_Go					activates a slug menu.
slug_Open				creates a slug menu object.
slug_Repaint			paints a slug menu.


Sled (Scrolling List EDiting window) Functions

sled_DeleteRows  		destroys rows in a sled.
sled_GetCol  			gets the sled's current column.
sled_GetColSize  		gets the size of the sled's columns.
sled_GetColVar  		gets a pointer to a sled entry.
sled_GetMarkAttr  		gets the sled's marking colors.
sled_GetRow  			gets the sled's current row.
sled_InsertRows  		inserts blank rows into a sled.
sled_IsLastRow  		checks if the current row is the last.
sled_IsMarkedCol  		checks the mark state of a column.
sled_IsMarkedRow  		check the mark state of a row.
sled_IsProtectedCol  	checks the protected state of a column.
sled_IsProtectedRow  	checks the protected state of a row.
sled_MarkCol  			marks a column in a sled.
sled_MarkRow  			marks a row in a sled.
sled_Open  				creates a scrolling list.
sled_ProtectCol  		protects a column in a sled.
sled_ProtectRow  		protects a row in a sled.
sled_Remap  			remaps the sled's field variables.
sled_Repaint  			refreshes the sled to the display.
sled_SetColVar  		sets the value of a sled entry.
sled_SetMarkAttr 		sets the sled's marking colors.
sled_UnMarkCol  		unmarks a column in a sled.
sled_UnMarkRow  		unmarks a row in a sled.
sled_UnProtectCol  		unprotects a column in a sled.
sled_UnProtectRow  		unprotects a row in a sled.

Ted (Text EDitor window) Block Functions

ted_BlockAttr  			sets the marked text block's attribute. 
ted_BlockCopy  			copies a marked text block to buffer.
ted_BlockCut  			cuts a marked text block to buffer.
ted_BlockDelete  		deletes a marked text block.
ted_BlockPaste  		pastes buffer into a text block.

Ted Editing and Cursor Movement Functions

ted_AddChar  			writes a character to the sed.
ted_AddRow  			adds a row to the sed.
ted_AddString  			writes a string to the sed.
ted_DeleteChar  		deletes a character.
ted_DownChar  			moves down one character.
ted_GoBottom  			moves to the bottom of the sed text.
ted_GoEnd  				moves to the end of the row.
ted_GoHome  			moves to the start of the row.
ted_GotoCursor  		goes to a text cursor offset.
ted_GoTop  				moves to the top of the sed text.
ted_GotoPosition  		goes to a text position in the sed.
ted_LeftChar  			moves left one character.
ted_LeftWord  			moves left one word.
ted_PageDown  			moves down one page.
ted_PageUp  			moves up one page.
ted_RightChar  			moves right one character.
ted_RightWord  			moves right one word.
ted_Search  			searches for a string.
ted_StartWorking  		starts up a text editor.
ted_UpChar  			moves up one character.

Ted I/O Functions

sed_ClearTB  			resets the sed's text buffer.
sed_GetTB  				gets the sed's text buffer.
sed_RewindTB  			rewinds the sed's text buffer.
sed_SetTB  				sets the sed's text buffer.
ted_ReadFile  			fills a text buffer from a file.
ted_WriteFile  			writes a text buffer to a file.

Ted Parameter Functions

ted_GetCursor  			gets the text cursor offset.
ted_GetInsert  			gets the text insert mode.
ted_GetLineLen  		gets the length of the current line.
ted_GetMark  			gets the text marking mode.
ted_GetMaxSize  		gets the text buffer's maximum size.
ted_GetNewLineChar  	gets the displayed newline character.
ted_GetPosition  		gets the text position in the sed.
ted_GetRefresh  		gets the text refresh mode.
ted_GetSize  			gets the text buffer's size.
ted_GetString  			copies a string from the sed.
ted_GetTabChar  		gets the displayed tab character.
ted_GetTabSize  		gets the sed's tab size.
ted_GetWrapWidth  		gets the sed's wrap width.
ted_SetInsert  			sets the text insert mode.
ted_SetMark  			sets the text marking mode.
ted_SetMaxSize  		sets the text buffer's maximum size.
ted_SetMoveMethod  		sets the cursor movement method.
ted_SetNewLineChar  	sets the displayed newline character.
ted_SetRefresh  		sets the text refresh mode.
ted_SetTabChar  		sets the displayed tab character.
ted_SetTabSize  		sets the sed's tab size.
ted_SetWrapWidth  		sets the sed's wrap width.

Sfile (Screen File) Functions

sfile_Close  			closes a screen file.
sfile_LoadSed  			loads a sed from a screen file.
sfile_Open  			opens a screen file.
sfile_ReadOnly  		opens a screen file for reading only.
sfile_SaveSed  			saves a sed to a screen file.

Display Modes (set by C-scape's display initialization function)

def_ModeCurrent:  		The current video mode.  This options links in the 
						support routines for all the video modes.
def_ModeText:  			The best available text mode.  It only links in the 
						support routines for text mode.
def_ModeGraphics:  		The highest resolution graphics mode available.  On 
                        a PC the modes are selected in the following order: 
						mode 12, mode F, mode 10, mode 13, mode 6, and 
						Hercules.  The support routines for all of these 
                        modes are linked in.  disp_Init fails if the video
                        hardware cannot support graphics.
pc_ModeBIOS:  			The best available text mode and to use only BIOS 
						calls in communicating with the display.  Only the 
						support routines for BIOS text mode are linked in.  
						You cannot use graphics with this option.
pc_Mode2:  				80x25 color text with the color burst disabled.
pc_Mode3:  				80x25 color text.
pc_Mode4:  				320x200 4 color graphics with color burst disabled.
pc_Mode5:  				320x200 4 color graphics.
pc_Mode6:  				640x200 2 color graphics.
pc_Mode7:  				80x25 monochrome text.
pc_ModeD:  				320x200 16 color EGA graphics.
pc_ModeE:  				640x200 16 color EGA graphics.
pc_ModeF:  				640x350 monochrome EGA graphics.
pc_Mode10:  			640x350 16 color EGA graphics.
pc_Mode11:  			640x480 monochrome VGA graphics.
pc_Mode12:  			640x480 16 color VGA graphics.
pc_Mode13:  			320x200 256 color VGA/MCGA graphics.
pc_ModeEGA43:  			EGA 43 line mode.
pc_ModeVGA50:  			VGA 50 line mode.
pc_ModeHerc:  			Hercules 720x348 monochrome graphics mode.

Display Window Classes (set by C-scape's display initialization function)

cmwin_Class:  			Character map window.  This window class saves the 
						contents of the display when disp_Init is called and   
						restores them when disp_Close is called.
grwin_Class:  			Graphics window.  Use this window class if you wish 
                        to have C-scape automatically restore underlying 
                        graphics images when it removes windows.
NULL:  					No background window.  If you use no background
                        window, the background will be cleared and its
                        contents will not be restored by disp_Close.

Keyboard Functions

kb_Alt  				checks if the Alt key is pressed.
kb_CapsLock  			checks if the keyboard is in Caps Lock mode.
kb_Check  				checks state of the keyboard buffer.
kb_CheckWait  			waits for a keystroke without processing it.
kb_Clear  				clears the keyboard buffer.
kb_Control  			checks if the Control key is pressed.
kb_Idle  				attaches a keyboard idle function.
kb_Insert  				checks if the keyboard is in Insert mode.
kb_NumLock  			checks if the keyboard is in Num Lock mode.
kb_Read  				reads a character from the keyboard.
kb_Record  				records/plays keystrokes to/from a file.
kb_ScrollLock  			checks if the keyboard is in Scroll Lock mode.
kb_Shift  				checks if the Shift key is pressed.

String Formatting Functions

strcenter  				centers a string.
strclip  				removes the trailing spaces from a string.
strfill  				fills a string with characters.
strleft  				left justifies a string.
strpad  				pads a string with spaces.
strpreclip  			removes the leading spaces from a string.
strright  				right justifies a string.
strwrap  				word-wraps a string.
