home *** CD-ROM | disk | FTP | other *** search
/ GEMini Atari / GEMini_Atari_CD-ROM_Walnut_Creek_December_1993.iso / files / program / popup / editor.txt < prev    next >
Text File  |  1993-10-23  |  6KB  |  126 lines
  1.                         The Popup Menu Editor
  2.                         ---------------------
  3.      The  editor  allows you to edit several popup  menus  with  ease, 
  4. using a simple menu driven operation.
  5.  
  6.  
  7. Getting started
  8. ---------------
  9.      The  first thing that you should do is install the  editor,  this 
  10. tells  the  editor that amount of memory to reserve for  you  to  work 
  11. with.  Double  click on INSTALL.PRG to load the installation  program. 
  12. This reads EDMENU.INF,  and displays the results in a dialog box.  You 
  13. should  edit  the three items to values that suit you.  Click  on  the 
  14. 'Calc' button to calculate how much memory will be required (in bytes) 
  15. by your current selections. The meanings of the three numbers are...
  16.  
  17. Max menus:     You may edit more than one menu in each file,  this  is 
  18.                the maximum number that you may edit.
  19. Item memory:   This is the number of bytes allocated for storing  menu 
  20.                item definitions. About 20K should be sufficient.
  21. String memory: This  is  the  number of bytes  allocated  for  storing 
  22.                strings,  such as item names,  help strings etc.  About 
  23.                20K should sufficient.
  24.  
  25. When  you have made your mind up,  click on "Install" to save the  new 
  26. EDMENU.INF file, or "Cancel" to quit without saving.
  27.  
  28.  
  29. Running the editor
  30. ------------------
  31.      To  run  the  editor,  double-click  on  EDMENU.PRG.  The  editor 
  32. requires the file EDMENU.INF,  and one of the three supplied  resource 
  33. files, which one depends on the current screen resolution.
  34.  
  35.      When loaded, you will get a blank screen with a menu bar. You may 
  36. now immediately start editing a new file, or load a file from disk for 
  37. editing.  If you are a first time user,  it would be sensible to  load 
  38. the file DEMO.POP from the DEMO folder.  Tinkering with this will give 
  39. you a good idea of how to use the editor.
  40.  
  41. Adding menus
  42. ------------
  43.      To add or amend a popup menu definition, select the "Select menu" 
  44. option.  To  add a new menu,  enter its name and click on  "Add".  The 
  45. other options are fairly obvious in their operation.  To edit a  menu, 
  46. click on its name and then on the "Edit" button.
  47.  
  48. Editing a menu
  49. --------------
  50.      If you are editing a new menu,  a dummy item will be inserted for 
  51. you  to start on.  The first thing you will want to do is change  this 
  52. entry  to something of your choice.  To do this,  select  the  "Amend" 
  53. option  from  the  "Options" menu.  A dialog will  appear  with  three 
  54. editable parts.  The "help" and "name" strings are optional and may be 
  55. left blank if not required.  The "name" string is where you enter  the 
  56. 'C' #define name of the menu item. References to this item within your 
  57. program then use this name.
  58.      The "Add before" and "Add after" insert items before or after the 
  59. cursor position,  using the same dialog as the "Amend" option. You may 
  60. not add an item before the first item in a menu or sub-menu.
  61.      To add a new sub-menu,  select the "Add submenu" option and  fill 
  62. in the dialog as above.
  63.      To delete an item,  select the "Delete item" option.  You may not 
  64. delete the first item in the menu,  or any item that still has a  sub-
  65. menu attached.
  66.      To add/change/delete the 'C' #define name of an item,  select the 
  67. "Name item" option.
  68.  
  69.      To  move the cursor around the menu items,  use the cursor  arrow 
  70. keys.  Up  and Down move the cursor to previous/next item.  The  right 
  71. cursor  moves into a sub-menu,  If one exists.  The left cursor  moves 
  72. back out of a sub-menu.
  73.  
  74. Item attributes
  75. ---------------
  76.      Each item in the menu may be one or more of the following...
  77.  
  78. Selectable:    The  item will highlight when the mouse  cursor  passes 
  79.                over it. It will return it's index number when clicked.
  80. Disabled:      These  appear grey in the menu and may not be  selected 
  81.                by  the  user.  To display a greyed line in  the  menu, 
  82.                enter it's text as "#l",  and disable it.  This will be 
  83.                displayed as a greyed line by the main popup module.
  84. Checked:       A tick is displayed to the left of the item.
  85. Centre:        The text is centred within the bounding vertical  lines 
  86.                of the menu.
  87.  
  88.  
  89. Saving/Loading
  90. --------------
  91.      The menu definitions are saved in ".POP" files.  These files  are 
  92. in a special format unique to the editor.  It is these files that  you 
  93. load and save into the editor.
  94.  
  95. Source code
  96. -----------
  97.      In order to use the menus within your own programs,  you must use 
  98. the "Source" option.  This saves a header file (".H").  This file must 
  99. be #include'ed into your source code.
  100.  
  101. General stuff
  102. -------------
  103.      The  instructions  above  should be fairly  un-necessary  as  the 
  104. editor is very simple to use. There are, however, some things that you 
  105. should know:
  106.  
  107. 1.   Don't use desk accessories that open their own windows. They will 
  108.      corrupt the screen area where your popup menus are being edited.
  109.  
  110. 2.   You will need at least 32K of free memory.  The editor needs this 
  111.      amount of memory for storing screen data.
  112.  
  113. 2.   Help  strings will not be displayed in low resolution,  there  is 
  114.      not enough room on the screen !
  115.  
  116. 3.   If  you are creating a set of menus to be used as  a  replacement 
  117.      for GEM's top menu bar,  then you should create one menu for each 
  118.      drop-down. See the demonstration for details.
  119.  
  120.  
  121. Copyright
  122. ---------
  123.      The editor is a part of the "Popup" package,  and is governed  by 
  124. the shareware rules set out in the main "readme" file
  125.  
  126.