home *** CD-ROM | disk | FTP | other *** search
/ The AGA Experience 2 / agavol2.iso / software / utilities / wb_tools / prop3d / prop3d_eng.doc < prev    next >
Text File  |  1996-02-14  |  9KB  |  177 lines
  1.  
  2.            ========================================================
  3.                                     PROP3D
  4.            --------------------------------------------------------
  5.             Version 40.95 (15 February 1996) by Massimo Tantignone
  6.            ========================================================
  7.  
  8.    This program patches some system library functions to improve the look of
  9. the GadTools proportional gadgets, namely sliders and scrollers. Their knob
  10. is currently the only element of the Amiga GUI that still appears "flat":
  11. Prop3D gives them a full three-dimensional look just like the rest of the
  12. system gadgets, and adds a dithered pattern to their container's background.
  13.    Furthermore, Prop3D can force the arrow buttons of scrollers to always
  14. be perfectly square, and/or modify their look as well.
  15.  
  16.    Note that Prop3D only modifies GadTools gadgets, any other custom
  17. proportional gadget is left untouched.
  18.  
  19.    To use Prop3D you just have to add the following line at the beginning
  20. of your User-startup:
  21.  
  22.    Run > NIL: Prop3D
  23.  
  24. after copying Prop3D into a directory that is in the system path (for
  25. example SYS:C or SYS:Utilities).
  26.  
  27.    It is important to start Prop3D before any program that uses the
  28. gadtools.library, so put the above command among the very first lines of
  29. your User-startup.
  30.  
  31.    Alternatively you can simply copy Prop3D along with its icon into your
  32. WBStartup drawer and forget about it. Do not remove the "DONOTWAIT" tooltype.
  33.  
  34.    To remove Prop3D you can run it a second time or send a CTRL-C to its
  35. process. By doing this the program restores the original library functions
  36. and exits. Make sure that no programs are using the gadtools.library while
  37. you remove Prop3D, or else there could be spectacular system crashes.
  38.  
  39.    Starting from version 40.85, the look of the proportional gadgets is
  40. somewhat configurable. You can control various aspects of their appearance
  41. by setting some environment variables.
  42.    For instance, the command "SetEnv Prop3D/KnobStyle XEN" (without quotes)
  43. tells Prop3D to create its proportional gadgets with a special XEN-style knob.
  44.  
  45.    In addition, you can also put all your settings into a single ASCII file,
  46. which must be called "ENV:Prop3D/Settings", using the standard tooltype
  47. format and writing each entry on a separate line without spaces.
  48.    An example of a typical entry could be "KnobStyle=XEN".
  49.    However, keep in mind that the environment variables always override the
  50. contents of the Settings file.
  51.  
  52.    The program reads these settings when it is launched; if you change them
  53. later, you have to make it re-read them by running it a second time, for
  54. instance by typing "Prop3D" in a Shell window. If any of the settings was
  55. changed, Prop3D will continue to work using the new values, else it will
  56. remove itself, as already said.
  57.  
  58.    The variables currently recognized, along with their possible values,
  59. are the following:
  60.  
  61.   ----------------------+---------------+-----------------------------------
  62.   Variable name         | Value         | Meaning
  63.   ----------------------+---------------+-----------------------------------
  64.   Prop3D/KnobFrame      | GADTOOLS      | Knob with classic GadTools frame
  65.                         | SIMPLE        | Knob with simple 3D border
  66.   ----------------------+---------------+-----------------------------------
  67.   Prop3D/KnobStyle      | CLEAN         | For a "clean" knob
  68.                         | XEN           | For the XEN-style knob
  69.   ----------------------+---------------+-----------------------------------
  70.   Prop3D/KnobHiMethod   | DITHER        | Highlight knob with dithering
  71.                         | SOLID         | Highlight knob with solid color
  72.   ----------------------+---------------+-----------------------------------
  73.   Prop3D/KnobHiPen      | SHINEPEN      | Highlight knob with SHINEPEN
  74.                         | FILLPEN       | Highlight knob with FILLPEN
  75.                         | BACKGROUNDPEN | Don't highlight knob
  76.   ----------------------+---------------+-----------------------------------
  77.   Prop3D/KnobHiLook     | RAISED        | Knob raised when selected
  78.                         | RECESSED      | Knob recessed when selected
  79.   ----------------------+---------------+-----------------------------------
  80.   Prop3D/ContainerFrame | GADTOOLS      | Container with GadTools frame
  81.                         | SIMPLE        | Container with simple 3D border
  82.   ----------------------+---------------+-----------------------------------
  83.   Prop3D/BackFill       | DITHER        | Container with dithered background
  84.                         | SOLID         | Container with solid background
  85.   ----------------------+---------------+-----------------------------------
  86.   Prop3D/ButtonAspect   | IGNORE        | Leave arrow buttons as they are
  87.                         | SQUARE        | Force arrow buttons to be square
  88.   ----------------------+---------------+-----------------------------------
  89.   Prop3D/ButtonStyle    | NORMAL        | Arrow buttons with normal look
  90.                         | XEN           | Arrow buttons with XEN-style look
  91.   ----------------------+---------------+-----------------------------------
  92.   Prop3D/ButtonHiPen    | FILLPEN       | Highlight buttons with FILLPEN
  93.                         | BACKGROUNDPEN | Don't highlight buttons
  94.   ----------------------+---------------+-----------------------------------
  95.   Prop3D/ButtonPlace    | NORMAL        | Place buttons the usual way
  96.                         | SIDES         | Place buttons at opposite sides
  97.   ----------------------+---------------+-----------------------------------
  98.   Prop3D/PressedLook    | NORMAL        | Press items the normal way
  99.                         | SHIFTED       | Press items shifting them
  100.   ----------------------+---------------+-----------------------------------
  101.  
  102.    Note 1: the first value for each variable is always the default one.
  103.  
  104.    Note 2: "ContainerFrame" only works with AmigaOS 3.0 or higher.
  105.  
  106.    Note 3: "ButtonHiPen" and "PressedLook", for arrow buttons, work only if
  107.            "ButtonStyle" is NOT set to NORMAL; "PressedLook", for the knob
  108.            image, requires "KnobHiLook" to be set to RECESSED.
  109.  
  110.    Note 4: "ContainerFrame" also controls the frame of the arrow buttons,
  111.            but only if "ButtonStyle" is NOT set to NORMAL. Then again,
  112.            "ContainerFrame" only really makes sense if you're also using
  113.            some patch that makes "thin" all other GadTools frames, such as
  114.            "MagicFrames" by Luke Elliott, so this shouldn't be a big issue.
  115.  
  116.    Prop3D was tested with AmigaOS 2.04/3.0/3.1 and Enforcer. It shouldn't
  117. have any serious bug, but I can't by any means guarantee that it will work
  118. with future releases of AmigaOS (hopefully there will be no need of it).
  119.    Furthermore under AmigaOS 2.x it works, but the look of the gadgets is
  120. slightly less attractive. So please buy and install AmigaOS 3.1. You won't
  121. regret it.
  122.  
  123. ============================================================================
  124.    Changes from version 40.91 to version 40.95:
  125.  
  126.    · Now you can also configure the arrow buttons of scrollers
  127.  
  128.    · Slightly enhanced the look of gadgets with ContainerFrame=SIMPLE
  129. ----------------------------------------------------------------------------
  130.    Changes from version 40.85 to version 40.91:
  131.  
  132.    · Some people complained because Prop3D did read its ENV: variables
  133.      every time a proportional gadget was created. Now it reads them only
  134.      when it's launched, but you have to manually re-run it when you change
  135.      its settings to make it recognize them
  136.  
  137.    · Added the option of using a single settings file to save memory
  138. ----------------------------------------------------------------------------
  139.    Changes from version 40.63 to version 40.85:
  140.  
  141.    · Now at last the look of the proportional gadgets is configurable
  142.      [Note: this version can only be found on the IPISA '95 CD-ROM]
  143. ----------------------------------------------------------------------------
  144.    Changes from version 40.27 to version 40.63:
  145.  
  146.    · No more Enforcer hits when KingCON opens its requester for filename
  147.      completion
  148.  
  149.    · Now Prop3D can be run after PatchControl without crashing the system
  150.  
  151.    · Enhanced overall compatibility with other programs
  152. ----------------------------------------------------------------------------
  153.    Changes from version 40.14 to version 40.27:
  154.  
  155.    · Fixed the bug that caused a lot of gadget flashing
  156.  
  157.    · Now Prop3D correctly uses BACKGROUNDPEN instead of color 0
  158.  
  159.    · The gadgets that are only 12 pixels high (or less) get a slightly
  160.      different look that makes it easier to use them
  161.  
  162.    · Fixed a really obscure bug that caused a memory loss each time
  163.      a program freed its gadgets
  164. ============================================================================
  165.  
  166.    For any comments, suggestions, questions, bug reports, etc. contact me at
  167. the following address:
  168.  
  169.    Massimo Tantignone
  170.    Via Campagnoli, 4
  171.    28100 Novara (NO)
  172.         ITALY
  173.  
  174.    Fidonet: 2:331/126.6
  175.    E-mail: tanti@intercom.it
  176.  
  177.