home *** CD-ROM | disk | FTP | other *** search
/ Visual Basic 4 Unleashed / Visual_Basic_4_Unleashed_SAMS_Publishing_1995.iso / wh21demo / macro.ls_ / macro.ls
Text File  |  1994-08-10  |  13KB  |  184 lines
  1. ; Help Macro input file (ANSI code)
  2. ; Macro name, followed by the # of parameters and a help text
  3. ; next line parameter name, followed by number of recorded values, and typedefs
  4. ; next line(s)  possible values if any
  5. ; typedefs are (not exclusive) :
  6. ; Constant     : integer value, the string will be displayed interactively, the
  7. ;                value will be put in the macro
  8. ; String       : String value
  9. ; Macro        : Macro name
  10. ; Program      : Program name
  11. ; HelpFile     : Help File name
  12.  
  13. ; List         : List on following lines are possible values
  14. ; format : STRING=VALUE or VALUE or STRING
  15. ; Linklist     : List of topics in file
  16. ; BrowseList   : List of files
  17. ; Fixed        : Only one value allowed
  18. ; Free         : Free Parameter
  19. ; List_Free    : Free List
  20.  
  21. ; Constraints :
  22. ; -----------
  23. ; 1. To accept an abbreviation of a macro, a # has to be added at the end of the
  24.       macro name (Eg: MyMacro#),
  25. ; 2. The abbreviation consists of all uppercase characters found in the macro name,
  26. ;     in the order of appearance (Eg: MyOwnMacro => MOM),
  27. ; 3. There is no check for redundant abbreviations,
  28. ;
  29. ; 4. Type definitions have to be coded EXACTLY as specified,
  30. ;    Uppercase characters included
  31. ;
  32. ; 5. The macros appear in the order specified in the dialog box.
  33.  
  34.  
  35. About                  0                         Displays Windows Help's About dialog box
  36. AddAccelerator#        3                         Assigns a Help macro to an accelerator key
  37.     Key                0 Constant VKList         Windows virtual-key value
  38.     Shift State        8 Constant List           Combination of ALT,SHIFT,CTRL
  39.        None=0 SHIFT=1 CTRL=2 SHIFT+CTRL=3 ALT=4 ALT+SHIFT=5
  40.        ALT+CTRL=6 SHIFT+ALT+CTRL=7
  41.     Macro              0 Macro                   Macro to execute
  42. Annotate               0                         Displays the Annotation dialog box from the Edit menu
  43. AppendItem             4                         Appends a menu item to the end of a menu
  44.     Menu id            0 String Free             Menu identifier
  45.     Item id            0 String Free             Item identifier
  46.     Item name          0 String Free             Name of the item
  47.     Macro              0 Macro                   Macro to execute
  48. Back                   0                         Displays the previous topic in the history list
  49. BookmarkDefine         0                         Displays the Define dialog box from the BookMark menu
  50. BookmarkMore           0                         Displays the More dialog box from the BookMark menu
  51. BrowseButtons          0                         Adds browse buttons to the button bar
  52. ChangeButtonBinding#   2                         Assigns a Help macro to a button
  53.     Button id          6 String List_Free        Button identifier
  54.        BTN_CONTENTS BTN_SEARCH BTN_BACK BTN_HISTORY BTN_PREVIOUS
  55.        BTN_NEXT
  56.     Button macro       0 Macro                   Macro to execute
  57. ChangeItemBinding#     2                         Assigns a Help macro to a menu item added using the AppendItem macro
  58.     Item id            0 String Free             Item identifier
  59.     Item macro         0 Macro                   Help macro to execute
  60. CheckItem#             1                         Places a check mark beside a menu item
  61.     Item id            0 String Free             Item identifier
  62. CloseWindow            1                         Closes a secondary window or the main Help Window
  63.     Window name        0 String Free             Name of the window to close
  64. Contents               0                         Displays the Contents topic in the current Help file
  65. CopyDialog             0                         Displays the Copy dialog box from the Edit menu
  66. CopyTopic              0                         Copies all the text in the current topic to the clipboard
  67. CreateButton#          3                         Adds a new button to the button bar
  68.     Button id          0 String Free             Button identifier
  69.     Name               0 String Free             Title of the button
  70.     Macro              0 Macro                   Macro to execute
  71. DeleteItem             1                         Removes a menu item added with the AppendItem macro
  72.     Item id            0 String Free             Item identifier
  73. DeleteMark             1                         Removes a text marker added with the SaveMark macro
  74.     Marker text        0 String Free             Text marker created with SaveMark()
  75. DestroyButton          1                         Removes a button added with the CreateButton macro
  76.     Button id          0 String List_Free        Button identifier
  77. DisableButton          1                         Grays out a button added with the CreateButton macro
  78.     Button id          0 String List_Free        Button identifier
  79. DisableItem#           1                         Grays out a menu item added with the AppendItem macro
  80.     Item id            0 String Free             Item identifier
  81. EnableButton#          1                         Re-enables a button disabled with the DisableButton macro
  82.     Button id          0 String List_Free        Button identifier
  83. EnableItem#            1                         Re-enables a menu item disabled with the DisableItem macro
  84.     Item id            0 String Free             Item identifier
  85. ExecProgram#           2                         Executes a Windows application
  86.     Command line       0 Program BrowseList      Program name and parameters
  87.     Display state      3 Constant List           How to display the program
  88.        Normal=0 Minimized=1 Maximized=2
  89. Exit                   0                         Exits the Windows Help application
  90. FileOpen               0                         Displays the Open dialog box from the File menu
  91. FocusWindow            1                         Changes the focus to the specified window
  92.     Window name        0 String Free             Window which receives the focus
  93. GotoMark               1                         Jumps to a marker set with the SaveMark macro
  94.     Marker Text        0 String Free             Text marker created with SaveMark()
  95. HelpOn                 0                         Displays the Help file for the Windows Help application
  96. HelpOnTop              0                         Toggles the on-top state of Windows Help
  97. History                0                         Displays the history list
  98. IfThen                 2                         Conditionally executes a Help macro
  99.     IsMark             1 Macro Fixed             Tests if a marker exists
  100.        Ismark
  101.     Macro              0 Macro                   Macro to execute
  102. IfThenElse             3                         Conditionally executes one of two Help macros
  103.     IsMark             1 Macro Fixed             Tests if a marker exists
  104.        Ismark
  105.     Macro1             0 Macro                   Macro to execute
  106.     Macro2             0 Macro                   Macro to execute
  107. InsertItem             5                         Inserts a menu item
  108.     Menu id            4 String List_Free        Menu identifier
  109.        File=MNU_FILE Edit=MNU_EDIT BookMark menu=MNU_BOOKMARK
  110.        Help=MNU_HELPON
  111.     Item id            0 String Free             Item identifier
  112.     Item Name          0 String Free             Name of the item
  113.     Macro              0 Macro                   Macro to execute
  114.     Position           0 Constant Free           Menu item's position
  115. InsertMenu             3                         Inserts a new menu in the Windows Help menu bar
  116.     Menu id            0 String Free             Menu identifier
  117.     Menu name          0 String Free             Name of the menu
  118.     Menu Position      0 Constant Free           Position of the menu
  119. IsMark                 1                         Tests if a marker exists
  120.     Marker Text        0 String Free             Text marker created with SaveMark()
  121. JumpContents           1                         Jumps to the Contents topic of a specified file in the Help file
  122.     HelpFile           0 HelpFile BrowseList     Name of the destination file
  123. JumpContext#           2                         Jumps to a topic mapped to a Context number in the Help file
  124.     HelpFile           0 HelpFile BrowseList     Name of the destination file
  125.     Context id         0 Constant LinkList       Context number of the topic
  126. JumpHelpOn             0                         Jumps to the Contents topic of the How to Use Help file
  127. JumpId#                2                         Jumps to the topic with the specified context string in the Help file
  128.     HelpFile           0 HelpFile BrowseList     Name of the destination file
  129.     Context id         0 String LinkList         Context string of the topic
  130. JumpKeyword#           2                         Jumps to the first topic mapped to a search keyword in the Help file
  131.     HelpFile           0 HelpFile BrowseList     Destination file with keyword table
  132.     Keyword            0 String Free             Keyword to search for
  133. ;* RegisterRoutine("MMSystem.Dll","MCIExecute","S")
  134. MCIExecute             1                         Executes multimedia commands (video, audio etc.)
  135.     Command            0 String Free             Variable parameter for multimedia
  136. Next                   0                         Displays the next topic in the browse sequence for the Help file
  137. Not                    1                         Reverses the result returned by the IsMark macro
  138.     IsMark             1 Macro Fixed             Tests if a marker exists
  139.        IsMark
  140. PopupContext#          2                         Displays the topic identified by a number in a pop-up window
  141.     HelpFile           0 HelpFile BrowseList     File containing the topic
  142.     Context id         0 Constant LinkList       Context number of the topic
  143. PopupId#               2                         Displays a topic from a specified file in a pop-up window
  144.     HelpFile           0 HelpFile BrowseList     File containing the topic
  145.     Context id         0 String LinkList         Context string of the topic
  146. PositionWindow#        6                         Sets the size and position of a window
  147.     X                  0 Constant Free           X coordinate of the window
  148.     Y                  0 Constant Free           Y coordinate of the window
  149.     Width              0 Constant Free           Default width of the window
  150.     Height             0 Constant Free           Default height of the window
  151.     State              2 Constant list           Specifies how the window is sized
  152.        Normal size=0 Maximized=1
  153.     Name               0 String Free             Name of the window
  154. Prev                   0                         Displays the previous topic in the browse sequence for the Help file
  155. Print                  0                         Sends the currently displayed topic to the printer
  156. PrinterSetup           0                         Displays the Printer Setup dialog box
  157. RegisterRoutine#       3                         Registers a function within a dynamic link library
  158.     DLL name           0 String Free             Filename of the DLL
  159.     Function name      0 String LinkList         Name of the function
  160.     Format spec        7 String List_Free        Formats of the parameters
  161.        Unsigned Short=u Unsigned Long=U Short Int=i Int=I
  162.        Near Char=s Far Char=S Void=V
  163. RemoveAccelerator#     2                         Removes the assignment of a Help macro to an accelerator key
  164.     Key                0 Constant VKList         Windows virtual-key value
  165.     Shift state        8 Constant List           Combination of ALT,SHIFT,CTRL
  166.        None=0 SHIFT=1 CTRL=2 SHIFT+CTRL=3 ALT=4 ALT+SHIFT=5
  167.        ALT+CTRL=6 SHIFT+ALT+CTRL=7
  168. SaveMark               1                         Saves the location of the currently displayed topic and file
  169.     Marker Text        0 String Free             Text marker for the topic location
  170. Search                 0                         Displays the dialog box usually opened by the Search button
  171. SetContents            2                         Designates a specific topic as the Contents topic in the Help file
  172.     HelpFile           0 HelpFile BrowseList     File containing the topic
  173.     Context id         0 Constant LinkList       Context number of the topic
  174. SetHelpOnfile          1                         Specifies the name of the replacement How to Use Help file
  175.     HelpFile           0 HelpFile BrowseList     Name of the replacement file
  176. ;* RegisterRoutine("MMSystem.Dll","SndPlaySound","Su")
  177. SndPlaySound           2                         Plays a sound from a file
  178.     SoundFile          0 String BrowseList       Name of the sound file (*.WAV)
  179.     Play mode          6 Constant List_Free      Play mode to be used
  180.        Snd_Sync=0 Snd_Async=1 Snd_NoDefault=2
  181.        Snd_Loop=8 Snd_Async_Loop=9 Snd_NoStop=16
  182. UncheckItem#           1                         Removes the check mark from a menu item
  183.     Item id            0 String Free             Item identifier to uncheck
  184.