home *** CD-ROM | disk | FTP | other *** search
/ Nebula 1994 June / NEBULA_SE.ISO / SourceCode / MiscKit / Projects / MiscFindPanel / README
Encoding:
Text File  |  1994-01-15  |  4.0 KB  |  85 lines
  1. This directory and its sub-directories contains the source code, support
  2. files, and documentation to the MiscFindPanel class and AppKit class
  3. categories. The MiscFindPanel class is designed to be a mostly self-contained
  4. bundle which can be incorporated into a project with minimal effort.
  5.  
  6. [Ed. Note:  The documentation has been moved to the MiscKit/Documentation
  7. directory and is available spread throughout the Class/Category/Protocol
  8. subdirectories or all together in the MiscFindPanel directory.  -don]
  9.  
  10. This is version 1.1 (22 October 1993).
  11. This product requires NeXTSTEP 3.x or higher.
  12.  
  13.  
  14. Known bugs in 1.1:
  15.    - The only known bug in this software is in the MiscFindPanel class's
  16.      internal _calcFindPanelTarget instance method.  The method assumes
  17.      that the responder chains of the key and main windows end with some
  18.      responder that has a next responder of nil (this "end of the chain"
  19.      responder need not be the windows themselves, though it is them if
  20.      the windows' next responders have not been explicitly set).  This
  21.      also means that a responder chain that loops is also a bad thing.
  22.      Under "normal" usage, this bug will not manifest itself.
  23.  
  24. Changes from version 1.0:
  25.   - Donated to the MiscKit project.  Most externally visible names now
  26.     have a "Misc" prefix
  27.   - Fixed some documentation bugs
  28.   - A new example application has been included with the distribution
  29.   - The methods instancesRespondTo: and respondsTo:, in the MiscFindPanel
  30.     class, have been overridden to return NO for those methods that have
  31.     been "disabled"
  32.   - A fully functional SearchText category is now included
  33.   - Added the ability to set the object to act as first conformer
  34.   - An error value enumeration has been defined in the SearchableText protocol
  35.  
  36. Possible future enhancements:
  37.   - The ability to add one or more accessory views
  38.   - Fix first conformer searching so that possible loops are avoided
  39.   - Implement a generic SearchMatrix category (unless someone beats me to it)
  40.   - Add message support for the different SearchErr values of SearchableText
  41.   - Add stream-oriented searching wrapper functions around MiscTBMK routines
  42.  
  43.  
  44. Written and maintained by Christopher J. Kane (kane@gac.edu).
  45. Please feel free to contact the author with any questions,
  46. comments, bug reports, or suggestions about this package.
  47.  
  48. Copyright (c) 1993 Christopher J. Kane.  All rights reserved.
  49.  
  50. This software is subject to the terms of the MiscKit license
  51. agreement.  Refer to the license document included with the
  52. MiscKit distribution for these terms.
  53.  
  54. ---------------------------------------------------------------------------
  55. README                   - This file (cleverly enough)
  56.  
  57. Documentation/
  58.   HowToUse.rtf           - Instructions for adding a find panel to a project
  59.   MiscFindPanel.rtf      - Documentation for the MiscFindPanel class
  60.   MiscFindPanelClass.rtf - Documentation for the MiscFindPanelClass category
  61.   SearchableText.rtfd    - Documentation for the SearchableText protocol
  62.   FAQ.MiscFindPanel     - Questions (and answers) about MiscFindPanel
  63.  
  64. MiscFindPanel/           - Source code for MiscFindPanel bundle
  65.   MiscFindPanel.h        - MiscFindPanel class header file
  66.   MiscFindPanel.m        -   and source file
  67.   MiscFindPanelClass.h   - MiscFindPanelClass category header file
  68.   MiscFindPanelClass.m   -   and source file
  69.   SearchableText.h       - Header file for SearchableText protocol
  70.   Makefile               \
  71.   PB.gdbinit              | Bundle project support files
  72.   PB.project             /
  73.   English.lproj          \
  74.   French.lproj            \
  75.   German.lproj             | Language directories (contain localized
  76.   Italian.lproj            |   string and FindPanel.nib files)
  77.   Spanish.lproj           /
  78.   Swedish.lproj          /
  79.  
  80. SearchBench/             - An example application using the MiscFindPanel
  81.  
  82. SearchCategories/        - String searching routines and categories
  83.                              implementing the SearchableText protocol
  84. ---------------------------------------------------------------------------
  85.