home *** CD-ROM | disk | FTP | other *** search
/ Peanuts NeXT Software Archives / Peanuts-Update.iso / CDROM / Contents / READMEs / Peanuts-U / OpenStep / developer / resources / MiscTableScroll.129.1.mw.s.README < prev    next >
Encoding:
Text File  |  1998-03-08  |  9.2 KB  |  258 lines
  1. MiscTableScroll
  2.  
  3. By Paul S. McCarthy and Eric Sunshine
  4. Copyright (C)1995-1997 by Paul S. McCarthy and Eric Sunshine
  5. July 11, 1997
  6.  
  7.  
  8. OVERVIEW
  9. ========
  10. This is the source code for the MiscTableScroll framework and palette for 
  11. OPENSTEP.  MiscTableScroll is similar to NeXT's NSTableView class.  This 
  12. version of MiscTableScroll is compatible with OPENSTEP 4.2 for both Mach and 
  13. Windows NT, as well as OPENSTEP 4.1 for Mach.  
  14.  
  15. User Interface Features
  16. -----------------------
  17. - Column and row titles.
  18. - Resizing of columns and rows.
  19. - Dragging rows and columns to rearrange them.
  20. - Automatic sorting of rows as columns are rearranged.
  21. - A button in column titles to toggle between ascending and descending sort 
  22.   direction.  
  23. - Incremental search.
  24. - In-cell text editing.
  25. - Exporting contents as ASCII, ASCII-delimited or dBASE through the Save Panel.
  26. - Full keyboard and mouse control.
  27. - Interacts with the Pasteboard, Font Panel, and Services.
  28.  
  29. Programmer Interface Features
  30. -----------------------------
  31. - Each column and row can have its own size.
  32. - Each cell can have its own color and font or inherit them from the 
  33.   MiscTableScroll.  
  34. - Each column can have its own cell type.
  35. - Lazy mode for large or expensive-to-generate data sets.
  36. - Full control over selection.
  37. - Smart memory management -- you don't pay for features you don't use.
  38. - Simple indexed access to rows and columns regardless of visual order.
  39. - Uniform treatment of rows and columns -- referred to generically as slots.
  40. - Support for dragging images directly out of cells.
  41. - Extensive delegate hooks.
  42.  
  43.  
  44. INSTALLATION
  45. ============
  46. MiscTableScroll is normally distributed with the MiscKit for OPENSTEP.  
  47. However, since it does not use nor rely on any other part of the MiscKit, it 
  48. can be used as a stand-alone framework and palette.  Use this package to 
  49. create a stand-alone framework and palette or to replace an out-of-date copy 
  50. of MiscTableScroll.  
  51.  
  52. Follow these steps to install the MiscTableScroll package:
  53.  
  54. - Check version numbers
  55. - Remove previous version
  56. - Unpack
  57. - Compile and install framework and palette
  58. - Compile the example programs (optional)
  59. - Clean up
  60.  
  61. All of the instructions below assume that the environment variable 
  62. ${NEXT_ROOT} is defined.  This variable is defined by default under Windows 
  63. NT.  However under Mach it is not defined so you should define it yourself 
  64. before issuing the commands in the following sections.  
  65.  
  66. Under Mach, the typical value of ${NEXT_ROOT} is the empty string.  If you are 
  67. using the C-shell then define it by typing: 
  68.  
  69. % setenv NEXT_ROOT ""
  70.  
  71. If you are using the Bourne shell then type:
  72.  
  73. $ NEXT_ROOT=""
  74. $ export NEXT_ROOT
  75.  
  76.  
  77. Check Version Numbers
  78. ---------------------
  79. If you have a previous version of MiscTableScroll for OPENSTEP, check the 
  80. version number of the MiscTableScroll that you already have by looking in the 
  81. PACKAGE_NUMBER file in the source code directory or inside either the 
  82. installed framework or palette.  Compare that number with the version number 
  83. encoded in the name of the file 
  84. MiscTableScroll-OPENSTEP.v???.?.mw.s.gnutar.gz.  This way you can tell which 
  85. version is newer or older, and decide whether to proceed.  
  86.  
  87.  
  88. Remove Previous Version
  89. -----------------------
  90. If you have a previous version of the MiscTableScroll that you want to replace 
  91. with this package, then you need to remove the old version before unpacking 
  92. the new version.  
  93.  
  94. If you used the standard MiscKit directory structure then these commands will 
  95. remove the previous version.  If you used a different directory structure, 
  96. then you will need to adjust the commands as necessary to match your 
  97. installation.  
  98.  
  99. # Remove source
  100. % rm -rf ${NEXT_ROOT}/LocalDeveloper/Source/MiscKit2/Palettes/MiscTableScroll \
  101.     ${NEXT_ROOT}/LocalDeveloper/Source/MiscKit2/Examples/LazyScrollDir \
  102.     ${NEXT_ROOT}/LocalDeveloper/Source/MiscKit2/Examples/ScrollDir
  103.  
  104. # Remove targets
  105. % rm -rf ${NEXT_ROOT}/LocalLibrary/Frameworks/MiscTableScroll.framework \
  106.     ${NEXT_ROOT}/LocalDeveloper/Palettes/MiscTableScroll.palette \
  107.     ${NEXT_ROOT}/LocalDeveloper/Examples/MiscKit2/LazyScrollDir \
  108.     ${NEXT_ROOT}/LocalDeveloper/Examples/MiscKit2/ScrollDir
  109.  
  110.  
  111. Unpack
  112. ------
  113. Unpack the MiscTableScroll package by choosing a convenient directory, such as 
  114. ${NEXT_ROOT}/LocalDeveloper/Source, and performing the following commands: 
  115.  
  116. % mkdirs ${NEXT_ROOT}/LocalDeveloper/Source
  117. % cd ${NEXT_ROOT}/LocalDeveloper/Source
  118. % gnutar xvfz MiscTableScroll-OPENSTEP.v???.?.mw.s.gnutar.gz
  119.  
  120. Unpacking the MiscTableScroll package creates the following directory 
  121. structure: 
  122.  
  123. MiscKit2
  124.     Examples
  125.     LazyScrollDir
  126.     ScrollDir
  127.     Palettes
  128.     MiscTableScroll
  129.         Framework
  130.         Documentation
  131.         Notes
  132.         Palette
  133.  
  134.  
  135. Compile and Install Framework and Palette
  136. -----------------------------------------
  137. By default, MiscTableScroll is configured to install its components in the 
  138. following locations: 
  139.  
  140. ${NEXT_ROOT}/LocalLibrary/Frameworks    MiscTableScroll.framework
  141. ${NEXT_ROOT}/LocalLibrary/Executables    MCGHTableScroll.dll
  142. ${NEXT_ROOT}/LocalDeveloper/Palettes    MiscTableScroll.palette
  143.  
  144. If these locations are inappropriate for your site, you can adjust them using 
  145. Project Builder's Inspector panel.  The installation directory can be 
  146. configured individually for the framework and the palette.  
  147.  
  148. To build and install the MiscTableScroll framework and palette using Project 
  149. Builder, follow these steps: 
  150.  
  151. - Open the project file contained within the top-level MiscTableScroll source 
  152.   directory: Source/MiscKit2/Palettes/MiscTableScroll/PB.project 
  153. - Choose the appropriate architectures from the Build Options panel.
  154. - Select the 'install' target from the Build Options panel.
  155. - Press the Build button.
  156.  
  157. If you are using Windows NT or 95 then you need to add the framework's 
  158. executable path to your system PATH variable.  For instance, if ${NEXT_ROOT} 
  159. at your site is defined as D:/NeXT, then you should add 
  160. D:\NeXT\LocalLibrary\Executables to your PATH.  Consult the Windows 
  161. documentation if you need help setting the PATH variable.  
  162.  
  163.  
  164. Compile Example Programs (optional)
  165. ------------------------
  166. You can build the example programs LazyScrollDir and ScrollDir using Project 
  167. Builder, as follows: 
  168.  
  169. - Open the project file contained within the source directory.
  170. - Choose the appropriate architectures from the Build Options panel.
  171. - Press the Build button.
  172.  
  173. The project files for the example programs are located in:
  174.  
  175. ${NEXT_ROOT}/LocalDeveloper/Source/MiscKit2/Examples/LazyScrollDir/PB.project
  176. ${NEXT_ROOT}/LocalDeveloper/Source/MiscKit2/Examples/ScrollDir/PB.project
  177.  
  178. Finally, if you would like to have the source code for the example programs 
  179. installed in ${NEXT_ROOT}/LocalDeveloper/Examples/MiscKit2, either copy the 
  180. directories there using NeXT's Workspace or execute the following commands: 
  181.  
  182. % cd ${NEXT_ROOT}/LocalDeveloper
  183. % rm -rf Examples/MiscKit2/LazyScrollDir Examples/MiscKit2/ScrollDir
  184. % mkdirs Examples/MiscKit2
  185. % cp -r Source/MiscKit2/Examples/LazyScrollDir \
  186.     Source/MiscKit2/Examples/ScrollDir Examples/MiscKit2
  187.  
  188.  
  189. Clean Up
  190. --------
  191. At this point the installation is complete.  To reclaim disk space, remove the 
  192. temporary files which were created during the build process by pressing the 
  193. Clean button on Project Builder's Build panel.  Or, if you do not plan to 
  194. refer back to the source code, then you can delete that directory entirely: 
  195.  
  196. % rm -rf ${NEXT_ROOT}/LocalDeveloper/Source/MiscKit2
  197.  
  198.  
  199. CONVERSION
  200. ==========
  201. This package comes with a tops script to aid porting of NEXTSTEP 3.x programs 
  202. which use MiscTableScroll to OPENSTEP 4.x.  The script should be run after 
  203. running the standard NeXT-supplied conversion scripts.  It is located within 
  204. the MiscTableScroll framework: 
  205.  
  206. MiscTableScroll.framework/Resources/MiscTableScroll-3.3-4.x.tops
  207.  
  208.  
  209. DOCUMENTATION
  210. =============
  211. Documentation for the public classes is located within the framework and can 
  212. be found in the files: 
  213.  
  214. - MiscTableScroll.rtf
  215. - MiscTableCell.rtf
  216. - MiscExporter.rtf
  217.  
  218. The example programs demonstrate how to use the most important features of 
  219. MiscTableScroll: 
  220.  
  221. - LazyScrollDir
  222. - ScrollDir
  223.  
  224. The following files also provide valuable information.  Except for 
  225. PACKAGE_NUMBER which is located in the top-level source directory, all of the 
  226. remaining files reside in the Notes subdirectory.  
  227.  
  228. PACKAGE_NUMBER        MiscTableScroll version.
  229. HISTORY.txt        Description of changes between versions.
  230. OPENSTEP-HISTORY.txt    Description of OPENSTEP-specific changes between
  231.             versions.
  232. TODO.txt        A list of future enhancements.
  233. OPENSTEP-TODO.txt    A list of OPENSTEP-specific future enhancements.
  234. BUGS.txt        A list of known bugs.
  235. OPENSTEP-BUGS.txt    A list of OPENSTEP-specific bugs.
  236. MACH-NT-4.2.txt        Description of issues which arose when porting
  237.             MiscTableScroll from OPENSTEP 4.1 for Mach to
  238.             OPENSTEP 4.2 for both Mach and Windows NT.
  239.  
  240. Finally, the source code itself is commented and may be consulted as needed.  
  241. It has been formatted with tab-stops of 8 characters and indentation of 4 
  242. spaces.  
  243.  
  244.  
  245. CONCLUSION
  246. ==========
  247. MiscTableScroll was written by Paul S. McCarthy and Eric Sunshine and is 
  248. copyright (C)1995-1997 by Paul S. McCarthy and Eric Sunshine.  It is included 
  249. in the MiscKit by permission from the authors and is governed by the MiscKit 
  250. license found in the file License.rtf in the MiscKit distribution.  
  251.  
  252. Please direct comments, questions, and complaints to:
  253.  
  254. - Paul S. McCarthy <zarnuk@mcgh.org>
  255. - Eric Sunshine <sunshine@mcgh.org>
  256.  
  257. NeXT, MIME, and ASCII mail accepted.
  258.