Changes

From CDOT Wiki
Jump to: navigation, search

Oop344 20102 - iof functions

274 bytes added, 23:45, 16 June 2010
edited IsTextEditor Section so that it is easier to read, corrected wrong urls to IsTextEditor Section
# If '''"*curpos"''' exceeds the value of fieldlen, correct the '''"*curpos"''' so that cursor stands at the last position inside the field.
# If '''"*offset"''' is greater than the length of the string, set the '''"*offset"''' so the “last character of str” is hidden right before the first space in the field. (See '''“[[OOP344 BIO 20101Oop344 20102 - iof functions#IsTextEditor:|IsTextEditorSection #1]]”''' for more)
# After the above, if cursor is past the last character of '''“str”''', set '''"*curpos"''' so the cursor stands right after the last character of "str".
<u>Editing is terminated by pressing ENTER, TAB, UP, DOWN, PGUP, PGDN or any of the function keys (F1 to F12)</u>. Pressing<u>ESCAPE will terminate the iof_edit() and abort editing</u>: '''"str"'''will contain originally passed data when leaving function.
Note that the conditions of termination are changed if the '''“IsTextEditor”''' flag is true (non-zero). See '''“[[OOP344 BIO 20101Oop344 20102 - iof functions#IsTextEditor:|IsTextEditor]]”'''section for detail.
If '''"ReadOnly"''' has a true value (non-zero), then any attempt to change the content of '''"str"''' should end the function and return the key. Note that all other keys should work (Function and Non-ASCII keys). This makes the '''iof_edit()''' funciton "read only", but the user still can scroll the text to left or right and etc....
The function handles at least the following special keys:
* '''LEFT ''' - move cursor left one character. If cursor is at the beginning of the field and there is hidden data before the cursor, then shift string to right instead.* '''RIGHT ''' - move cursor right one character. If cursor is at the end of the field but not at the end of the string, then scroll one to left.* '''HOME ''' – move cursor to the beginning of the string. Scroll all the way to right if necessary. (i.e. if there is hidden data at the beginning)* '''END ''' - go to the end of the data in the string, i.e. just past the last character in the string. Scroll all the way to left if necessary.* '''DEL ''' – eat the current character above the cursor and move all subsequent characters one position to the left.* '''BACKSPACE ''' - move the rest of the field (including the cursor) one position to the left, eating the previous character.* '''TAB''':
** if '''IsTextEditor''' is false, TAB will simply terminate the function like a Function key
** if '''IsTextEditor''' is true, TAB will insert '''CIO_TAB_SIZE ''' number of spaces into the string.'''CIO_TAB_SIZE''' should be a defined "tab size" value in ciol.h. If '''CIO_TAB_SIZE''' spaces cannot be inserted into the string for any reason then the inputted tab should be ignored. (See below for more about '''“[[OOP344 BIO 20101Oop344 20102 - iof functions#IsTextEditor:|IsTextEditorSection #2]]”''' flagfor more)* '''ESCAPE ''' - Terminates iof_edit() and aborts editing: '''"str"''' will contain originally passed data when leaving function. (See '''“[[OOP344 BIO 20101Oop344 20102 - iof functions#IsTextEditor:|IsTextEditorSection #3]]”''' for exception)* '''INSERT ''' - toggle Insert/Overstrike mode**<br /u>In Insert mode</u>, printable characters are inserted into the string, moving the remainder of the string to the right to make room. **<u>In Overstrike mode</u>, printable characters overwrite existing characters (if any). Note that if you are past the end of the string, printable characters are appended to the string (as long as the string isn't full) regardless of the mode. **Also note that, regardless of the mode, the cursor advances as printable characters are typed into the string. **Finally, if the cursor is at the end of the field, instead of moving to right, the characters are shifted to left.
==== IsTextEditor: ====
====[Section #1] IsTextEditor and *offset====
If IsTextEditor is true, then it means that the function is being used to edit text by editing one line of text at a time. In this case, shifting a line to the left or right should not only cause the editing line to be shifted, but also the rest of the lines in the text. To do this, iof_edit() should let the calling function know that a shift has happened. Since shifting essentially means modifying '''“*offset”''' when '''“IsTextEditor”''' is true, and that there are times when you find that '''“*offset”''' needs to be modified, you should terminate the function afterwards. With termination, the function should return the terminating key.
Note that at the beginning of the execution of iof_edit(), validating '''*offset''' may require the value of '''*offset''' to change. If so, make sure to correct the offset and then terminate the function before any editing happens returning the default value of key.
''when '''IsTextEditor''' ====[Section #2]====# The iof_edit() function always shows blanks in any the part of the field that is true, and Escape is hit do not abort occupied by the editing but simply terminate data in the function returning the Escape keystring.#<u>UNDER NO CIRCUMSTANCES DOES THE FUNCTION CHANGE ANY POSITION ON THE SCREEN OUTSIDE OF THE FIELD</u>.''
Any normal printable key ====[Section #3] IsTextEditor and ESCAPE KEY====# When '"IsTextEditor"' is true and ESCAPE KEY is hit, do not abort the editing, and simply placed into terminate the string according to function returning the rules laid out in ESCAPE KEY.# If memory allocation for aborting the discussion of the INSERT key above. edit (The keys from the space character to the tilde character in ESCAPE KEY) fails, quit the ASCII table are considered "printable"function returning -1.)
====[Section #4] Others====# Any normal printable key is simply placed into the string according to the rules laid out in the discussion of the INSERT key above.(The keys from the space character to the tilde character in the ASCII table are considered "printable".)# Like most C library functions, your iof_edit() function always shows blanks in any may assume that it is the calling program's responsibility is to ensure that the array is large enough to handle the part specified number of characters, and that the field that is not occupied by starting screen position provides enough room (on the data in screen) for the string.<u>UNDER NO CIRCUMSTANCES DOES THE FUNCTION CHANGE ANY POSITION ON THE SCREEN OUTSIDE OF THE FIELD</u>field, etc.
Like most C library functions, your iof_edit() may assume that it is the calling program's responsibility is to ensure that the array is large enough to handle the specified number of characters, and that the starting screen position provides enough room (on the screen) for the field, etc.
 
'''''Note:'''''
 
If memory allocation for aborting the edit (ESCAPE KEY) fails, quit the function returning -1.
=== Selection Editor ===
1
edit

Navigation menu