home *** CD-ROM | disk | FTP | other *** search
/ C!T ROM 2 / ctrom_ii_b.zip / ctrom_ii_b / PROGRAM / CLIPPER / PDHM / API.HM next >
Text File  |  1993-01-14  |  3KB  |  86 lines
  1. /*
  2.         API.HM
  3. */
  4.  
  5.  
  6. ADhm_col( <nEngine> ) --> <nColumnPosition>
  7. -------------------------------------------
  8. Retyrns the column position where the currently highlighted option starts.
  9.  
  10.  
  11. ADhm_colors( <nENgine>, [aColors] ) --> <aCurrentColors>
  12. --------------------------------------------------------
  13. Sets/Gets the menu colors.  [aColors] is an array of three elements:
  14.  
  15.    1 - the standard color
  16.    2 - the enhanced color
  17.    3 - the forgroud part of the trigger color
  18.  
  19.  
  20. ADhm_current( <nEngine> ) --> <nCurrent>
  21. ----------------------------------------
  22. Returns the index position of the currently highlighted option.
  23.  
  24.  
  25. ADhm_escape( <nEngine>, <bEscape> ) --> nil
  26. -------------------------------------------
  27. Defines a codeblock that gets EVALuated when the Esc key is pressed,
  28. or when the right mouse button is clicked.  If the Esc key is currently
  29. not active (may be inactivated with ADhm_setescape()), this codeblock
  30. never gets EVALuated.
  31.  
  32.  
  33. ADhm_exit( <nEngine>, [nExitCode] ) --> nil
  34. -------------------------------------------
  35. Exits the menu, optionally setting the exit code to [nExitCode].  If
  36. [nExitCode] is not passed, the exit code is set to HMX_EXIT, #DEFINEd in
  37. Hormenu.ch.
  38.  
  39.  
  40. ADhm_extra( <nEngine>, [bBeginDisp], [bEndDisp], [bUndisplay] ) --> nil
  41. -----------------------------------------------------------------------
  42. Same description as ADvm_extra(). 
  43.  
  44.  
  45. ADhm_keys( <nEngine>, [aKeys], [bKeysHandler] ) --> nil
  46. -------------------------------------------------------
  47. Same description as ADhm_keys().
  48.  
  49.  
  50. ADhm_lbuttons( <nEngine>, [aSpots], [bSpotsHandler] ) --> nil
  51. -------------------------------------------------------------
  52. Same description as ADvm_lbuttons().
  53.  
  54.  
  55. ADhm_pulldown( <nEngine>, <aPullDown> ) --> nil
  56. -----------------------------------------------
  57. Specifies which options in the horizontal menu gets automatically "pulled
  58. down" when the highlight is moved to it.  <aPullDown> is an array of these
  59. index positions.
  60.  
  61.  
  62. ADhm_row( <nEngine> ) --> <nRowPosition>
  63. -----------------------------------------
  64. Returns the row position of the horizontal menu.  Currently, this is
  65. always the top row (zero)
  66.  
  67.  
  68. ADhm_setescape( <nEngine>, <lActivate> ) --> nil
  69. ------------------------------------------------
  70. Activates/deactivates the Esc key or the right mouse button as an
  71. exit key.  Its default status is FALSE (not active).
  72.  
  73.  
  74. ADpulldown( <nEngine>, <aVMMenu>, [aVMTrigger], [xVMProcess] )
  75.         --> <nVMSelection>
  76. --------------------------------------------------------------
  77. Implements a pulldown ADvermenu().
  78.  
  79. <aVMMenu>, [aVMTrigger] and [xVMProcess] are the vertical menu's
  80. options array, triggers array, and options processor.  Their
  81. meanings are similar to the corresponding <aMenu>, [aTrigger] and
  82. [xProcess] parameters of ADvermenu().
  83.  
  84. <nVMSelection> is the return value similar to that of ADvermenu().
  85.  
  86.