home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 1 / GoldFishApril1994_CD2.img / d4xx / d430 / smartfields / docs / introduction < prev    next >
Text File  |  1991-01-11  |  8KB  |  204 lines
  1. INTRODUCTION TO SMART FIELDS
  2.  
  3.  
  4. Welcome to SmartFields!  The SmartFields system by Software Ingenuity is a
  5. collection of functions which you link with your application programs to
  6. provide a friendly, powerful data input interface to users.  SmartFields are
  7. similar to Intuition string gadgets in many ways, but we feel that several
  8. features make them more powerful than their Intuition counterparts.
  9.  
  10.  
  11. SmartFields features:
  12. ---------------------
  13.  
  14. Images and borders simultaneously
  15.  
  16.     Intuition gadgets make you choose between the two.
  17.  
  18. Ability to select input text style, foreground color, and background color
  19.  
  20.     With Intuition string gadgets, you are limited to the window's default
  21.     colors and plain text.  With SmartFields, you can specify for each
  22.     individual field the foreground color, background color, and the text
  23.     style including italic, bold, underline, inverse, or any combination.
  24.     Best of all, you can change these field attributes "on the fly."  For
  25.     example, if a user inputs incorrect data in one of the fields, change the
  26.     data in that field to red!
  27.  
  28. Delete forward
  29.  
  30.     Also known as "Field Exit" on some of the popular minicomputers, this is
  31.     a real time saver.
  32.  
  33. Delete backward
  34.  
  35.     A feature not seen on many computers, this becomes very handy allowing
  36.     you to delete the contents of a field to the left of the cursor.
  37.  
  38. Typeover and insert mode
  39.  
  40.     You set the default for each window and allow the user to change back and
  41.     forth at will.
  42.  
  43. Tab forward and tab backward
  44.  
  45.     A handy little device to move quickly through a field using the keyboard.
  46.  
  47. Field duplication
  48.  
  49.     One of the most sought after features in database programs, this function
  50.     allows the user to duplicate the contents of a field from the previous
  51.     record.
  52.  
  53. Cut, copy, and paste between fields
  54.  
  55.     SmartFields defines, allocates, and maintains its own private clipboard
  56.     which allows the user to copy or cut the contents of any field and paste
  57.     it back into another field of the same or different length.  This and all
  58.     of the above functions are completely transparent to your calling program.
  59.  
  60. Ability to mask out any character or set of characters
  61.  
  62.     You define which of all of the 256 ASCII characters you want to allow
  63.     input into each field.  Thus you can mask out numeric characters,
  64.     alphabetic characters, alternate characters, or even all but a 'y' and
  65.     'n' for a simple yes-or-no field.  These masks are created to allow you
  66.     maximum flexibility and maximum program speed.  You are not required to
  67.     make masks for fields which allow all characters.  Three functions are
  68.     provided to help you create a field mask from within your program.
  69.  
  70. All menu command keys
  71.  
  72.     How many times have you wanted to use right-Amiga-Q as a command key
  73.     shortcut for a "Quit" menu selection?  With SmartFields, all right-Amiga
  74.     keys are free for your use.
  75.  
  76. Access to the Help and Escape keys
  77.  
  78.     Perhaps one of the biggest downfalls of Intuition string gadgets is that
  79.     they do not notify the calling program when the Help key is pressed.
  80.     With this feature you can make the ultimate user-friendly program: a
  81.     program that has a help-screen for each input field.
  82.  
  83. Programmer-defined function and control keys
  84.  
  85.     You can define any of the function and shifted function keys, and any of
  86.     the unused control key combinations.  As a matter of fact, you can
  87.     redefine any console key to your specifications.
  88.  
  89. Ability to jump from one field to another using the cursor keys
  90.  
  91.     Simulate a minicomputer environment by allowing the user to jump to the
  92.     previous field using the up-arrow key or to the next field using the
  93.     down-arrow or return key.  You also have access to the shifted-up and
  94.     down-arrow keys for jumping to the first and last fields in a window.
  95.     Your program defines to which field the cursor should move after an arrow
  96.     key has been pressed, allowing you maximum flexibility.
  97.  
  98. Pointer to the previous field in addition to the next field
  99.  
  100.     This may seem like a minor point, but if in your program cursor movement
  101.     proceeds sequentially through the field list, you can save a lot of
  102.     programming time and space by just sending the cursor to the field
  103.     pointed to by the "PrevField" pointer.
  104.  
  105. The source code
  106.  
  107.     Perhaps the very best difference of all!  If you don't like something,
  108.     change it!  Although the functions supplied are fully operational and
  109.     configured to what we feel is the best environment for user input, you
  110.     may not agree, and are completely at liberty to modify anything you see
  111.     fit.
  112.  
  113.  
  114. USE OF THE SMART FIELDS SYSTEM
  115. ------------------------------
  116.  
  117. You may incorporate SmartFields into a program in one of four
  118. ways:
  119.  
  120. 1)  Copy the source code of the desired functions directly into your program.
  121.     This method is not recommended because it defeats the purpose of separate
  122.     SmartFields functions.
  123.  
  124. 2)  Compile the desired functions and link them with your program.  This also
  125.     is not a complete use of the power afforded by the SmartFields system.
  126.  
  127. 3)  Compile all SmartFields functions and place them in a library to be linked
  128.     with you programs.  This is the method we suggest.
  129.  
  130. 4)  Create a SmartFields library to be opened by your program at run time,
  131.     similar to how a program opens the Intuition library.  This method may
  132.     save a little on program size, but you add the requirement of having to
  133.     have the library present on every system where you run your program.
  134.     This is just an added burden to the user, and therefore is not
  135.     recommended.
  136.  
  137. The rest of the manual will assume that you have selected option #3.
  138.  
  139.  
  140. THE MANUAL
  141. ----------
  142.  
  143. Introduction
  144.     License Agreement
  145.         Contains that bit of legalese that you hate to read but you really
  146.         should before opening the diskette packet.
  147.     Introduction to SmartFields
  148.         What you are reading now.
  149.     Package Contents
  150.         Lists what you should have found when you opened the SmartFields
  151.         package.
  152.  
  153. Program Information
  154.     Creating a SmartFields Program
  155.         Takes you step-by-step through the source code of a sample program,
  156.         detailing all the steps needed to create your own SmartFields program.
  157.     Function Descriptions
  158.         Contains a detailed description of every SmartFields function.
  159.     Structure Definitions
  160.         Contains a detailed description of the structures used in the
  161.         SmartFields system.
  162.     Include Header Files
  163.         Explains the meaning and use of the definitions contained in the
  164.         SmartFields include header files.
  165.     Field Layout
  166.         Illustrates the physical layout on the screen of a field in the
  167.         SmartFields system.
  168.     Keyboard Chart
  169.         Lists all keys accessible through the SmartFields system.
  170.  
  171. User Information
  172.     User Manual
  173.         Contains a manual for end-users of the SmartFields system.
  174.  
  175. Appendixes
  176.     List of Libraries
  177.         Lists the libraries that are referenced in this manual and accessed
  178.         by the SmartFields functions.
  179.     List of Functions
  180.         Contains all of the SmartFields functions in alphabetical order.
  181.     Parent-Child List
  182.     Child-Parent List
  183.         Contain the parent and child functions, in other words, functions
  184.         which call other functions.  This is provided for programmers who
  185.         wish to modify the SmartFields library and need to know the hierarchy
  186.         of the functions in the SmartFields system.
  187.     Brief Function Descriptions
  188.         Contains brief descriptions of all of the SmartFields functions.
  189.     Function Synopses
  190.         Lists all of the SmartFields functions in alphabetical order, the
  191.         arguments they require, the values they return, and the page number
  192.         on which their full descriptions reside.
  193.  
  194. Index
  195.     Contains a detailed index which hopefully will help you find everything
  196.     you need to know.
  197.  
  198.  
  199. Introduction  01/13/90
  200. © Copyright 1990 Timm Martin
  201. All Rights Reserved Worldwide
  202.  
  203. /*-- END --*/
  204.