home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 13 / amigaformatcd13.iso / mui / mui_developer / autodocs / mui_prop.doc < prev    next >
Text File  |  1997-03-10  |  5KB  |  173 lines
  1. TABLE OF CONTENTS
  2.  
  3. Prop.mui/Prop.mui
  4. Prop.mui/MUIA_Prop_Entries
  5. Prop.mui/MUIA_Prop_First
  6. Prop.mui/MUIA_Prop_Horiz
  7. Prop.mui/MUIA_Prop_Slider
  8. Prop.mui/MUIA_Prop_UseWinBorder
  9. Prop.mui/MUIA_Prop_Visible
  10. Prop.mui/MUIM_Prop_Decrease
  11. Prop.mui/MUIM_Prop_Increase
  12. Prop.mui/Prop.mui
  13.  
  14. Prop class generates the well known proportional gadgets.
  15. It offers the same attributes as a usual boopsi gadget
  16. of propgclass. However, MUI's prop gadgets allow using
  17. any imagery for the knob and for the background.
  18. Prop.mui/MUIA_Prop_Entries
  19.  
  20.     NAME
  21.     MUIA_Prop_Entries -- (V4 ) [ISG], LONG
  22.  
  23.     FUNCTION
  24.     Set or get the total number of entries.
  25.  
  26.     SEE ALSO
  27.     MUIA_Prop_Horiz, MUIA_Prop_Visible, MUIA_Prop_First
  28. Prop.mui/MUIA_Prop_First
  29.  
  30.     NAME
  31.     MUIA_Prop_First -- (V4 ) [ISG], LONG
  32.  
  33.     FUNCTION
  34.     Set or get the number of the first entry.
  35.  
  36.     SEE ALSO
  37.     MUIA_Prop_Horiz, MUIA_Prop_Visible, MUIA_Prop_Entries
  38. Prop.mui/MUIA_Prop_Horiz
  39.  
  40.     NAME
  41.     MUIA_Prop_Horiz -- (V4 ) [I.G], BOOL
  42.  
  43.     FUNCTION
  44.     Determine if you want a horizontal or a vertical
  45.     prop gadget.
  46.  
  47.     Defaults to FALSE, i.e. vertical.
  48.  
  49.     SEE ALSO
  50.     MUIA_Prop_Entries, MUIA_Prop_Visible, MUIA_Prop_First
  51. Prop.mui/MUIA_Prop_Slider
  52.  
  53.     NAME
  54.     MUIA_Prop_Slider -- (V4 ) [ISG], BOOL
  55.  
  56.     FUNCTION
  57.     Indicate that this prop gadget is used in a slider. MUI might
  58.     then use different imagery. Since you really should use the
  59.     slider class when creating sliders, you normally don't need
  60.     to care about this attribute.
  61. Prop.mui/MUIA_Prop_UseWinBorder
  62.  
  63.     NAME
  64.     MUIA_Prop_UseWinBorder -- (V13) [I..], LONG
  65.  
  66.     SPECIAL INPUTS
  67.     MUIV_Prop_UseWinBorder_None
  68.     MUIV_Prop_UseWinBorder_Left
  69.     MUIV_Prop_UseWinBorder_Right
  70.     MUIV_Prop_UseWinBorder_Bottom
  71.  
  72.     FUNCTION
  73.     If you set this attribute to one of
  74.  
  75.     MUIV_Prop_UseWinBorder_Left,
  76.     MUIV_Prop_UseWinBorder_Right,
  77.     MUIV_Prop_UseWinBorder_Bottom,
  78.  
  79.     some very special magic will take place with this
  80.     proportional gadget. In fact, it will not eat
  81.     any display space at all or render anything, it
  82.     stays invisible in your windows GUI. Instead, the
  83.     gadgets control and display will be linked to one
  84.     of the scrollbars in the window border.
  85.  
  86.     There is no difference in talking to the object,
  87.     you can use all prop gadget attributes regardless
  88.     whether its a real prop gadget or just a window
  89.     border link. Of course, gadgets in window borders
  90.     will use the intuition look regardless what the
  91.     user has configured.
  92.  
  93.     NOTES
  94.     You *must* enable border scrollers for the parent window
  95.     with the corresponding attributes (see below)
  96.     before using MUIA_Prop_UseWinBorder.
  97.  
  98.     Obviously, you can only link exactly one prop gadget
  99.     to one window scroller. Linking more than one gadget
  100.     to the same window scroller will result in big
  101.     confusion.
  102.  
  103.     To simplify programming, the classes Scrollbar.mui
  104.     and Listview.mui also accept the MUIA_Prop_UseWinBorder
  105.     attribute and pass it on when creating their prop
  106.     gadgets. This allows you to do something like
  107.  
  108.     WindowObject,
  109.        MUIA_Window_UseRightBorderScroller, TRUE,
  110.        MUIA_Window_RootObject, VGroup,
  111.           Child, ListviewObject,
  112.              MUIA_Prop_UseWinBorder, MUIV_Prop_UseWinBorder_Right,
  113.              ...
  114.  
  115.     to create a listview thats controllable with a scrollbar in
  116.     the right window border.
  117.  
  118.     Scrollgroup class (for virtual groups) features another
  119.     attribute called MUIA_Scrollgroup_UseWinBorder, TRUE/FALSE
  120.     to allow control of virtual group from window borders.
  121.  
  122.     SEE ALSO
  123.     Window.mui/MUIA_Window_UseBottomBorderScroller,
  124.     Window.mui/MUIA_Window_UseLeftBorderScroller,
  125.     Window.mui/MUIA_Window_UseRightBorderScroller,
  126.     Scrollgroup.mui/MUIA_Scrollgroup_UseWinBorder
  127. Prop.mui/MUIA_Prop_Visible
  128.  
  129.     NAME
  130.     MUIA_Prop_Visible -- (V4 ) [ISG], LONG
  131.  
  132.     FUNCTION
  133.     Set or get the number of visible entries.
  134.  
  135.     SEE ALSO
  136.     MUIA_Prop_Horiz, MUIA_Prop_Entries, MUIA_Prop_First
  137. Prop.mui/MUIM_Prop_Decrease
  138.  
  139.     NAME
  140.     MUIM_Prop_Decrease (V16)
  141.  
  142.     SYNOPSIS
  143.     DoMethod(obj,MUIM_Prop_Decrease,LONG amount);
  144.  
  145.     FUNCTION
  146.     This method decreases the value of a proportional gadget by the
  147.     specified amount. Negative values are ok. Range checking is done
  148.     automatically.
  149.  
  150.     INPUTS
  151.     amount - amount to substract from the gadgets current position.
  152.  
  153.     SEE ALSO
  154.     MUIM_Prop_Increase, MUIA_Prop_First
  155. Prop.mui/MUIM_Prop_Increase
  156.  
  157.     NAME
  158.     MUIM_Prop_Increase (V16)
  159.  
  160.     SYNOPSIS
  161.     DoMethod(obj,MUIM_Prop_Increase,LONG amount);
  162.  
  163.     FUNCTION
  164.     This method increases the value of a proportional gadget by the
  165.     specified amount. Negative values are ok. Range checking is done
  166.     automatically.
  167.  
  168.     INPUTS
  169.     amount - amount to add to the gadgets current position.
  170.  
  171.     SEE ALSO
  172.     MUIM_Prop_Decrease, MUIA_Prop_First
  173.