home *** CD-ROM | disk | FTP | other *** search
/ Programmer 7500 / MAX_PROGRAMMERS.iso / CLIPPER / MISC / CLPHLP22.ZIP / WHATSNEW.TXT < prev   
Encoding:
Text File  |  1992-04-03  |  6.8 KB  |  147 lines
  1.                    What's New in ClipHelp (C) vs. 2.2
  2.                    ----------------------------------
  3.  
  4.      Optional ability to call a UDF on accessing help (a 'pre-help'
  5.      UDF) and/or another on leaving help (a 'post-help UDF') via public
  6.      variables in Summer 87 version and code block parameters in
  7.      Clipper 5 version.  Scope for imagination!
  8.  
  9.      Fixed bug in both 2.1 vs libraries whereby help screens overlaid a
  10.      junk background when ClipHelp was used in mono mode.
  11.  
  12.      For those presently using ClipHelp vs 2.1 (CLHLP2.EXE dated
  13.      19-Feb-92), or vs 2.0 (CLHLP2.EXE dated 5-Jan-92) the following
  14.      sidelined extracts from the vs 2.2 user manual (CLIPHELP.DOC)
  15.      summarise changes in the new library files:
  16.  
  17.  
  18.          13.  Clipper Summer '87 version - PUBLIC variables to declare in
  19.               your application
  20.  
  21.          Include the following statements and function call in the main .PRG
  22.          module of your application (or in your setup procedure if you use
  23.          one):
  24.  
  25.               * ----- Declare ClipHelp PUBLIC variables
  26.               PUBLIC no_pages,;        && (N) ) Used
  27.                     no_topics,;        && (N) ) within
  28.                        st_rec,;        && (N) ) ClipHelp
  29.                      head_tag,;        && (C))
  30.                       hlp_var,;        && (C) Context-sensitivity variable
  31.                       explode,;        && (L) .T. - explode boxes, else .F.
  32.                       expl_in,;        && (N) Box expansion increment 1-2.
  33.                       expl_dl,;        && (N) 0=fastest. Increase to slow.
  34.                        shadow,;        && (L) .T. - shadow boxes, else .F.
  35.                          mono,;        && (L) .T. - force mono, .F. - color
  36.      |              prehelpfn,;        && (C) Procname to call when F1 tapped
  37.      |             posthelpfn,;        && (C) Procname to call before return
  38.                         hpath          && (C) Location of HELP.DAT specified
  39.                                        &&     as "<disk>:\<sub-dirirectory>\"
  40.  
  41.               * ----- Declare default values
  42.               STORE   0 TO no_pages, no_topics, st_rec
  43.               STORE  "" TO hlp_var, head_tag, hpath 
  44.               STORE .T. TO explode     && Change these to suit your
  45.               STORE .T. TO shadow      && preferences.  You could use
  46.               STORE .F. TO mono        && command line parameters in
  47.               expl_in = 1              && your application
  48.               expl_dl = 5              && if you wish.
  49.      |        prehelpfn  = ""          && ) See 'Optional UDFs on entering
  50.      |        posthelpfn = ""          && )  and leaving Help' on page 19.
  51.  
  52.  
  53.               * ----- Call function which gathers important information
  54.               *       from HELP.DAT for later use when <F1> pressed
  55.               LdHelpMU()
  56.  
  57.  
  58.      |   SUGGESTION:    To avoid 'typos', use your ASCII editor's facilities
  59.      |   ----------     to cut and paste everything above from
  60.      |
  61.      |                       '* ----- Declare ClipHelp...'
  62.      |                  to
  63.      |
  64.      |                       'LdHelpMU()'
  65.      |
  66.      |                  into your application's source code, then edit
  67.      |                  judiciously.
  68.  
  69.  
  70.  
  71.      |   15.  Optional UDFs on entering and leaving Help
  72.      |
  73.      |   ClipHelp vs 2.2 optionally allows user defined functions to be
  74.      |   called:
  75.      |
  76.      |        (a)  immediately following the tapping of <F1> and before the
  77.      |             display of help screens; and
  78.      |
  79.      |        (b)  immediately following the removal of help screens and
  80.      |             prior to return to the point in an application at which
  81.      |             <F1> was tapped.
  82.      |
  83.      |   in case you wish to have some special routine performed at either or
  84.      |   both of these points.
  85.      |
  86.      |   In the Summer 87 version this is achieved by assigning the names of
  87.      |   UDFs to public variables PREHELPFN and POSTHELPFN, respectively, eg
  88.      |
  89.      |        prehelpfn  = "MyPreHlpFn"
  90.      |        posthelpfn = "MyPstHlpFn"
  91.      |
  92.      |   for pre-help function MyPreHlpFn(), while in the Clipper 5 version
  93.      |   it is achieved by passing code blocks containing them as optional
  94.      |   parameters 7 and 8 when initially calling LdHelpMU(), eg
  95.      |
  96.      |        LdHelpMU( <par1>..<par6>,{||MyPreHlpFn()},{||MyPstHlpFn()} )
  97.      |
  98.      |   Note that any functions called at these points should save current
  99.      |   color and cursor conditions (and blink conditions in Clipper 5) on
  100.      |   entry and restore them on exit, if appropriate.  If you so wish, you
  101.      |   can have your pre-help function cause a return to your application
  102.      |   without displaying help by:
  103.      |
  104.      |        Summer 87 - keyboarding a CHR(255) prior to returning, ie
  105.      |
  106.      |                  KEYBOARD CHR(255)
  107.      |
  108.      |             This enables you to let the user use <Esc> if you wish.
  109.      |             ClipHelp automatically follows this with a CLEAR TYPEAHEAD
  110.      |             command so that nothing untoward will happen on return to
  111.      |             your application.
  112.      |
  113.      |        Clipper 5 - returning (.F.).  Be sure to return (.T.) to
  114.      |             proceed with the display of help screens.
  115.      |
  116.      |   Any value returned by a post-help function is ignored.
  117.      |
  118.      |   How can these function calls be used?  Here are a couple of
  119.      |   suggestions:
  120.      |
  121.      |        (c)  Some users of earlier versions of ClipHelp complained that
  122.      |             while their mouse was being turned off on summoning Help
  123.      |             it was not being restored afterwards.  Whether or not this
  124.      |             happens seems to be related to the mouse driver in use
  125.      |             moreso than to mouse functions.  If you experience such a
  126.      |             problem you could write a pre-help function to save the
  127.      |             current mouse condition and post-help one which calls your
  128.      |             own library's mouse restore function prior to returning
  129.      |             from Help.
  130.      |
  131.      |        (d)  A post-help function could be used in the latter stages of
  132.      |             development to call a function opening with a dialogue box
  133.      |             by means of which a user could opt to append notes to a
  134.      |             disk file for later scrutiny by the programmer with
  135.      |             suggestions about help screens.
  136.      |
  137.      |   I would welcome responses from users about the uses they have found
  138.      |   for these functions.
  139.  
  140.                                __________
  141.  
  142.      ClipHelp (C) 1991, 1992
  143.      Richard Eddy
  144.      S.R. Eddy & Associates
  145.      Perth, Western Australia   Tel: 61 9 455-1004  CIS ID: 100033,3272
  146.      3 April 1992
  147.