home *** CD-ROM | disk | FTP | other *** search
/ POINT Software Programming / PPROG1.ISO / pascal / mouselib / mouselib.doc < prev    next >
Encoding:
Text File  |  1993-02-25  |  8.3 KB  |  204 lines
  1.  
  2.  ╔══════════════════════════════════════════════════════════════════════════╗
  3.  ║                                                                          ║
  4.  ║                                 ISoft D&M                                ║
  5.  ║                                 POB. 5517                                ║
  6.  ║                           Coralville IA 52241                            ║
  7.  ║                                   U.S.A                                  ║
  8.  ║                                                                          ║
  9.  ╚══════════════════════════════════════════════════════════════════════════╝ 
  10.  
  11. (******************************************************************************
  12. *                                  MouseLib                                   *
  13. *               initial release, Loewy Ron, Feb 90.                           *
  14. *           second release, written by Loewy Ron, AUG 90.                 *
  15. *               Third  release, TP6.0 asm support, LR Jan 91.                 *
  16. *               Fourth release, added functions, LR   May 91.                 *
  17. *               Fifth  release, added intercept, release functions, Jun 91.   *
  18. *               6.th Release - Better Docs., Test Sample Program.             *
  19. *               7.th Release - Support for BP7 DPMI mode.                     *
  20. *               8.th Release - Support VGA true text cursor, help database.   *
  21. ******************************************************************************)
  22.  
  23.  mouseLib documentation file     : mouseLib.doc, rel 8.0.
  24.  last update                     : Feb. 23, 1993, LR.
  25.  
  26. File List
  27. ---------
  28.  
  29.  This package contains the following files :
  30.  
  31.  MOUSELIB.PAS   - mouseLib Turbo Pascal Source file
  32.  TPDESQ  .PAS   - DESQview support unit.
  33.  VIDEO   .PAS   - Video hardware support unit.
  34.  MOUSELIB.DOC   - This file. 
  35.  MOUSELIB.REG   - Registration File.
  36.  PROGRAMS.TXT   - ISoft D&M shareware products description.
  37.  MOUSETST.PAS   - Simple mouseLib Turbo Pascal test sample.
  38.  MOUSETST.EXE   - Compiled version of the mouseTst sample.
  39.  HELPENG .EXE   - The RL HLPDK Help Engine.
  40.  MOUSHELP.*     - mouseLib help database files.
  41.  MOUSLINK.*     - mouseLib help database files.
  42.  MOUSELIB.SET   - mouseLib help database set file.
  43.  MOUSELIB.HLP   - winHelp format help database
  44.  
  45. Why Register
  46. ------------
  47.  
  48.   mouseLib is a shareware product, if you find this product valuable, 
  49.  please register it. This section describes the reasones you should register.
  50.  
  51.   By registering mouseLib you will receive the latest mouseLib version. 
  52.   
  53.   By registering you will help us to create the next version
  54.  of mouseLib that will support more INT 33H functions, and will include even
  55.  more high-level support for TSRs, EVENT-DRIVEN programming, and more.
  56.  
  57.   Registered mouseLib users get full no-rotality usage permission, and the
  58.  complete KBDHDR keyboard interface Turbo Pascal package. 
  59.  
  60. Whats new
  61. ---------
  62.  
  63. V8.0
  64.   - Supports VGA true cursor. Use setVGATextGraphicCursor before initMouse.
  65.   - MouseTST program, operates now with true (graphic) VGA text cursor.
  66.   - Added the tpDESQ and video support units.
  67.   - Added the mouselib help database, and the help RL HLPDK help engine.
  68.  
  69. V7.0
  70.   - Support for BP7 DPMI mode - corrected the graphics mode detection
  71.     to work with DPMI mode.
  72.   - Improved MOUSETST program includes sample to event handler code.
  73.  
  74. V6.0
  75.   - Added better documentation in MOUSELIB.PAS source.
  76.   - Added A Simple Sample program - MOUSETST.PAS.
  77.   - From this version mouseLib is distributed by 
  78.     ISoft D&M, P.O.B 5517, Coralville IA 52241, U.S.A
  79.  
  80. Introduction
  81. ------------
  82.  
  83.   mouseLib is a Turbo (Borland) Pascal 6.0/7.0 mouse support unit, designed to 
  84.  provide event driven mouse support, using a standard (default) event 
  85.  handling mechanism. The unit includes all of the normal mouse library 
  86.  functions, (show, hide cursor, define tresh-hold, detect mouse etc..). 
  87.  mouseLib was used for over 3 years now, with many programs and products 
  88.  written by the author, and other programmers. Several mouseLib based packages 
  89.  are distributed by ISoft D&M, and can be downloaded for evaluation from BBSes 
  90.  around the world.
  91.  
  92. Highlights
  93. ----------
  94.  
  95.   Supports Text, Graphic and "True Cursor" text modes.
  96.  
  97.   Supports Real & DPMI modes.
  98.  
  99.   Complete - The full mouse API.
  100.  
  101.   Utilities - Pre-defined cursors, handlers etc..
  102.  
  103.   WYSIWYG - Full source code - register ONLY if you like what you see,
  104.   and find it valuable for your needs.
  105.  
  106. Technical documantation
  107. -----------------------
  108.  
  109.   With mouseLib ISoft D&M supplies the complete source code, We have tried to 
  110.  document the code as good as we could, Used the best names we could think of 
  111.  to functions and procedures, and added explanations where ever we felt the 
  112.  code was not trivial. If you intend to use this unit, you will have to look 
  113.  into the source code. 
  114.  
  115.   Additional help is available with the mouselib help database available both
  116.  in RL HLPDK help engine format, and windows 3.x help winhelp format.
  117.  
  118. Some points we would like to mention - 
  119.  
  120.  a.> use the setMouseGraph and resetMouseGraph before using the initMouse
  121.      procedure, to choose if you want text or graphics mouse support.
  122.  b.> look at the defaultHandler assembler routine, this is the heart of my
  123.      event driven applications. (use setDefaultHandler to ...).
  124.  c.> If you want to use True VGA text cursor (vgaTextGraphicCursor mode), 
  125.      call setVGATextGraphicCursor before initMouse, and be sure to call
  126.      setDefaultHandler, or provide a handler that supports mouse movement 
  127.      the way the vga true cursor handler does.
  128.  d.> Do not set or reset vgaTextGraphicCursor boolean falg by yourself, 
  129.      let the supplied set.. and reset.. procedures do that for you, 
  130.      this variable is supplied in the interface of the unit for browse
  131.      (read) purpose only, if this varible is changed not through the
  132.      suggested methods, unpredictable things can happen.
  133.  e.> In true vga cursor mode, the default handler does not trigger an event
  134.      when a "cursor changed location" condition occurs! - this is a design
  135.      feature needed to support the author's wintext library, if your code
  136.      needs to be notified of eventhappened when the mouse moves, you will
  137.      have to change the supplied default handler, or provide one of your own.
  138.  
  139.   For complete technical documentation, Please refer to the supplied 
  140.  MOUSELIB.REG file, and register your mouseLib copy.
  141.  
  142. Warranty
  143. --------
  144.  
  145.   There is no warranty what so ever, This software package is supplied as is,
  146.  The distributer (ISoft D&M), or the author (Loewy Ron), are not,
  147.  and will not be responsible for any damages, lost profits, 
  148.  or inconveniences caused by the use, or inability to use this package. 
  149.  The use of the package is at your own risk. 
  150.  By using (or attempting to use) the package you agree to this.
  151.  
  152. General
  153. -------
  154.  
  155.   mouseLib is distributed by ISoft D&M, P.O.B. 5517 CORALVILLE IA 52241, U.S.A.
  156.   
  157.   mouseLib is (c) copyrighted by Loewy Ron, 1990, 93.
  158.  
  159.   mouseLib is a shareware package, please register your copy. 
  160.   To register your copy of mouseLib please refer to the supplied
  161.   MOUSELIB.REG file. 
  162.  
  163.   Other programs distributed by ISoft D&M are described in the supplied  
  164.   PROGRAMS.TXT file.
  165.  
  166. Contact
  167. -------
  168.  
  169.   Please contact :
  170.  
  171.   ISoft D&M,  
  172.   P.O.B 5517
  173.   Coralville IA 52241,
  174.   U.S.A
  175.  
  176.   To contact the author directly : 
  177.  
  178.   Contact :     Loewy Ron,
  179.                 9 Haneveem st.
  180.                 Herzeliya, 46465
  181.                 ISRAEL.
  182.  
  183. Credits
  184. -------
  185.  
  186.   Turbo Pascal, Borland Pascal are trademarks of Borland International.
  187.  
  188.   Genius Mouse is a trademark of KUN YING ENTERPRISE CO.
  189.  
  190.   Yaniv Golan is the one to blame for the "true vga cursor" feature, he
  191.   was the one that triggered my interest in the implementation of this 
  192.   feature.
  193.  
  194.   Windows is a trademark of Microsoft corp.
  195.  
  196.   Dave Kirsch's MOU105 package was used as a reference for the development
  197.   of the true vga cursor. I used Duncan Murdoch's port of this code to
  198.   help me identify bugs in my own code. I would like however, to point
  199.   that the code was written from scratch, and is (to my opinion) supirior
  200.   regarding things such as execution (cpu) and storage (memory) overhead.
  201.  
  202.   The mouselib help database, and the supplied help engine are parts of the
  203.   HLPDK package, (c) 1992,93 Loewy Ron.
  204.