home *** CD-ROM | disk | FTP | other *** search
/ World of A1200 / World_Of_A1200.iso / programs / commodity / cycletomenu-2.1 / english / cycletomenu.doc < prev    next >
Text File  |  1995-02-27  |  11KB  |  352 lines
  1. ----------------------------------------------------------------------------
  2.  
  3.                               CycleToMenu 2.1
  4.  
  5. ----------------------------------------------------------------------------
  6.  
  7.  
  8. The files in this archive were written by Federico Giannici and are freely
  9. distributable as long as the archive remains intact, and only a nominal fee
  10. is charged for its distribution.
  11.  
  12. This software is provided "AS IS" without warranty of any kind, either
  13. expressed or implied. By using it, you agree to accept the entire risk as to
  14. the quality and performance of the program.
  15.  
  16.  
  17. This program is CardWare: if you like it, send a postcard of your country to
  18. the author. Comments, suggestions, donations and bug reports are welcome.
  19.  
  20. The author's address is:
  21.  
  22.     Federico Giannici
  23.     Viale Francia 4
  24.     90146 Palermo
  25.     Italy
  26.  
  27.  
  28. E-Mail: MC4080@mclink.it
  29.  
  30.  
  31.  
  32.  
  33.     OVERVIEW
  34. ~~~~~~~~~~~~~~~~
  35. CycleToMenu is a commodity that turns the standard cycle gadgets into popup
  36. menus or "expanding" gadgets. This way, selecting the desired option is
  37. easier and faster.
  38.  
  39. If you click on the arrow image on the left of the cycle gadgets they will
  40. behave in the usual way. This feature allows you to step straight to the
  41. next item. It can also be useful in low-memory situations or when the popup
  42. menu is too long to completely fit inside the screen.
  43.  
  44. Note that the configuration window and other rarely used functions are put
  45. into an overlay, so that normally they don't waste memory. A drawback is
  46. that you cannot delete the CycleToMenu file while the program is running.
  47.  
  48.  
  49.  
  50.     REQUIREMENTS
  51. ~~~~~~~~~~~~~~~~~~~~
  52. · AmigaOS Release 2.0
  53. · AmigaOS Release 2.1 is required for the localization
  54.  
  55.  
  56.  
  57.     INSTALLATION
  58. ~~~~~~~~~~~~~~~~~~~~
  59. Installation is very simple: open the drawer of the language you want to use
  60. and double-click the installation icon.
  61.  
  62. An AmigaDOS script will start and copy the CycleToMenu program into the
  63. WBStartup drawer of your Workbench partition (or disk). If the selected
  64. language is different from English, the corresponding "catalog" file will be
  65. copied in the appropriate directory, so that CycleToMenu will be able to use
  66. that language. In the end, you will be asked if you want to install the
  67. MagicWb-style icon.
  68.  
  69. Note that CycleToMenu has effect only on those cycle gadgets created while
  70. CycleToMenu was already running. So, it's very important to launch
  71. CycleToMenu as soon as possible. To achieve this, the default CycleToMenu's
  72. STARTPRI ToolType is set to a high value (100). Workbench uses this ToolType
  73. to decide in which order the programs in WBStartup shall be executed.
  74.  
  75.  
  76.  
  77.     CHANGING THE CONFIGURATION
  78. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  79. Once CycleToMenu is running, you can open its configuration window in three
  80. different ways:
  81.  
  82. · By means of the hot-key (default is "control alt y")
  83. · Through the Exchange program
  84. · Launching CycleToMenu again
  85.  
  86. You can configure the menus look and behavior by means of the window
  87. gadgets. You can immediately see the new behavior experimenting with the
  88. three test gadgets at the bottom of the window.
  89.  
  90. The "Save" menu item may be used to save the configuration.
  91.  
  92.  
  93.  
  94.     GADGETS
  95. ~~~~~~~~~~~~~~~
  96.  
  97.   Make zoom
  98.   ---------
  99. If this is selected, the popup menus will smoothly unfold.
  100.  
  101.  
  102.   Min duration
  103.   Max duration
  104.   ------------
  105. These two gadgets control the duration of the zoom (expressed as fraction of
  106. a second). The actual duration is proportional to the number of items in the
  107. popup menu. The minimum duration is obtained when the menu has only two
  108. items. The maximum duration is reached with ten or more items.
  109.  
  110.  
  111.   Use screen font
  112.   ---------------
  113. By default, CycleToMenu uses the same font of the cycle gadget. If this
  114. option is active, it will use the current screen font.
  115.  
  116.  
  117.   Min font size
  118.   -------------
  119. Usually, CycleToMenu uses the same font of the cycle gadget. Unfortunately,
  120. many programs use some quite little font (e.g. topaz/8). If the cycle
  121. gadget's font is smaller than the value specified here, CycleToMenu will use
  122. the screen font (only if it is taller than the gadget's one). If you want to
  123. always use the cycle gadget's font, set this value to "0".
  124.  
  125.  
  126.   Min items
  127.   ---------
  128. If the cycle gadget has a number of items lower than the specified value,
  129. CycleToMenu doesn't open its popup menu. So, for example, a good value can
  130. be "3". In this way, no popup menu is opened for cycle gadgets with only two
  131. items.
  132.  
  133.  
  134.   Menu look
  135.   MagicMenu look
  136.   Gadget look
  137.   --------------
  138. This gadgets select one of the three different kind of popup menus.
  139.  
  140. Menu look - simulate the usual Intuition's menus.
  141.  
  142. MagicMenu look - uses the same look of "MagicMenu" (MagicMenu is copyright
  143. by Martin Korndörfer).
  144.  
  145. Gadget look - make the popup menus look like gadgets. The idea is that a
  146. cycle gadget is a little "window" in the list of all possible gadget's
  147. values. When the user click on the gadget, the window expands revealing the
  148. complete list of all possible values.
  149.  
  150.  
  151.   Force NewLook menu
  152.   ------------------
  153. This gadget forces CycleToMenu to always use the NewLook menus introduced
  154. with AmigaOS 3.0. Under AmigaOS 2.x, CycleToMenu tries to emulate this new
  155. look as close as possible.
  156.  
  157.  
  158.   Centre on current item
  159.   ----------------------
  160. If this option is active, the menus are positioned so that the current item
  161. is centred onto the cycle gadget.
  162.  
  163.  
  164.   Double border
  165.   -------------
  166. This Gadget is used to simulate the "Double Borders" option of MagicMenu.
  167.  
  168.  
  169.   Inner border
  170.   ------------
  171. This option adds an empty border between the external border of the menu and
  172. the items inside (the difference is more evident with the current (reversed)
  173. item).
  174.  
  175.  
  176.   Recess current item
  177.   -------------------
  178. If this option is active, the current item is shown recessed.
  179.  
  180.  
  181.   Test gadgets
  182.   ------------
  183. These three gadgets have no influence at all on the popup menus. You may use
  184. them to test the effects of the changes you make to the configuration. In
  185. order to test the configuration under the wider situations, the three
  186. gadgets use a different font (indicated above them) and a different number
  187. of items.
  188.  
  189.  
  190.  
  191.     MENUS
  192. ~~~~~~~~~~~~~
  193.  
  194.   Save
  195.   ----
  196. This item saves the current configuration into the ToolTypes. Note that you
  197. have to launch CycleToMenu from Workbench (or WBStartup) to have the
  198. ToolTypes to take effect.
  199.  
  200.  
  201.   About
  202.   -----
  203. Opens a requester with some information about the program and its author.
  204.  
  205.  
  206.   Hide
  207.   ----
  208. Closes the configuration window. The programs keeps running with the current
  209. configuration.
  210.  
  211.  
  212.   Quit
  213.   ----
  214. It closes the configuration window and quits the program. The cycle gadgets
  215. will resume the usual behaviour.
  216.  
  217.  
  218.  
  219.     PARAMETERS & TOOLTYPES
  220. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  221. CycleToMenu uses the same names for both the Shell parameters and the
  222. Workbench ToolTypes.
  223.  
  224. Usually, you will not directly modify these parameters, as it's much more
  225. comfortable to change them by means of the configuration window. The only
  226. parameters that you have to change by hand are CX_POPKEY and PUBSCREEN.
  227.  
  228.  
  229.   CX_POPKEY                    Default: control alt y
  230.   ---------
  231. This is the hot-key, the input sequence that opens the window if it is
  232. closed, or brings it to the front if it is already open. Refer to the Amiga
  233. User Manual for a complete specification of the recognized keywords.
  234.  
  235.  
  236.   CX_POPUP                     Default: YES
  237.   --------
  238. This tells if the configuration window should be opened when the program is
  239. run for the first time. Usually, you should set this parameter to NO.
  240.  
  241.  
  242.   CX_PRIORITY                  Default: 0
  243.   -----------
  244. This is the priority of the commodity handler used for the hot-key. Usually,
  245. you will not need to change this.
  246.  
  247.  
  248.   PUBSCREEN                    Default: the Workbench screen
  249.   ---------
  250. This is the name of the public screen where to open the configuration
  251. window.
  252.  
  253.  
  254.   MAKEZOOM                     Default: YES
  255.   --------
  256. This parameter corresponds to the "Make zoom" gadget status.
  257.  
  258.  
  259.   MINZOOMDURATION              Default: 8
  260.   ---------------
  261. This parameter corresponds to the "Min zoom duration" gadget value.
  262.  
  263.  
  264.   MAXZOOMDURATION              Default: 16
  265.   ---------------
  266. This parameter corresponds to the "Max zoom duration" gadget value.
  267.  
  268.  
  269.   USESCREENFONT                Default: NO
  270.   -------------
  271. This parameter corresponds to the "Use screen font" gadget status.
  272.  
  273.  
  274.   MINFONTSIZE                  Default: 0
  275.   -----------
  276. This parameter corresponds to the "Min font size" gadget value.
  277.  
  278.  
  279.   MINITEMS                     Default: 0
  280.   --------
  281. This parameter corresponds to the "Min items" gadget value.
  282.  
  283.  
  284.   LOOK                         Default: GADGET
  285.   ----
  286. This parameter corresponds to the three "look" gadgets status. There are
  287. three possible keywords for this parameter:
  288.  
  289. MENU - corresponds to the "Menu look" option
  290.  
  291. MAGICMENU - corresponds to the "MagicMenu look" option
  292.  
  293. GADGET - corresponds to the "Gadget look" option
  294.  
  295.  
  296.   FORCENEWLOOKMENU             Default: NO
  297.   ----------------
  298. This parameter corresponds to the "Force NewLook menu" gadget status.
  299.  
  300.  
  301.   CENTRECURRENT                Default: NO
  302.   -------------
  303. This parameter corresponds to the "Centre on current item" gadget status.
  304.  
  305.  
  306.   DOUBLEBORDER                 Default: NO
  307.   ------------
  308. This parameter corresponds to the "Double border" gadget status.
  309.  
  310.  
  311.   INNERBORDER                  Default: NO
  312.   -----------
  313. This parameter corresponds to the "Inner border" gadget status.
  314.  
  315.  
  316.   RECESSCURRENT                Default: NO
  317.   -------------
  318. This parameter corresponds to the "Recess current item" gadget status.
  319.  
  320.  
  321.  
  322.     LIMITATIONS
  323. ~~~~~~~~~~~~~~~~~~~
  324. CycleToMenu works with every program that uses the standard GadTools' cycle
  325. gadgets, but it doesn't work with those programs that simulate such gadgets
  326. (i.e., almost only those programs that work also with AmigaOS 1.3).
  327.  
  328. Some badly written programs don't use the IntuiMessage->Code field but they
  329. simply assume that every time the gadget is clicked it makes a step forward.
  330. This is absolutely wrong! As mentioned above, you can avoid this problem
  331. clicking on the arrow image of the gadget making it behave in the usual way.
  332.  
  333.  
  334.  
  335.     ACKNOWLEDGMENTS
  336. ~~~~~~~~~~~~~~~~~~~~~~~
  337. As usual, I have to thank my beta testers, whose help has been invaluable
  338. during the development of this program: Nicola Salmoria, Dante Profeta and
  339. Stefano Iacus.
  340.  
  341. Special thanks go to Reinhard Spisser for the German translation, Ronald van
  342. Eijck for the Dutch one and Goncalves A. Georges for the French one.
  343.  
  344. I also want to thank all the people which E-Mailed me useful suggestions and
  345. bug reports.
  346.  
  347.  
  348.    __
  349.   |-
  350.   |ederico
  351.  
  352.