home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 5 / amigaformatcd05.iso / mui / developer / autodocs / mui_prop.doc < prev    next >
Encoding:
Text File  |  1996-08-13  |  3.7 KB  |  135 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/Prop.mui
  11.  
  12. Prop class generates the well known proportional gadgets.
  13. It offers the same attributes as a usual boopsi gadget
  14. of propgclass. However, MUI's prop gadgets allow using
  15. any imagery for the knob and for the background.
  16. Prop.mui/MUIA_Prop_Entries
  17.  
  18.     NAME
  19.     MUIA_Prop_Entries -- (V4 ) [ISG], LONG
  20.  
  21.     FUNCTION
  22.     Set or get the total number of entries.
  23.  
  24.     SEE ALSO
  25.     MUIA_Prop_Horiz, MUIA_Prop_Visible, MUIA_Prop_First
  26. Prop.mui/MUIA_Prop_First
  27.  
  28.     NAME
  29.     MUIA_Prop_First -- (V4 ) [ISG], LONG
  30.  
  31.     FUNCTION
  32.     Set or get the number of the first entry.
  33.  
  34.     SEE ALSO
  35.     MUIA_Prop_Horiz, MUIA_Prop_Visible, MUIA_Prop_Entries
  36. Prop.mui/MUIA_Prop_Horiz
  37.  
  38.     NAME
  39.     MUIA_Prop_Horiz -- (V4 ) [I.G], BOOL
  40.  
  41.     FUNCTION
  42.     Determine if you want a horizontal or a vertical
  43.     prop gadget.
  44.  
  45.     Defaults to FALSE, i.e. vertical.
  46.  
  47.     SEE ALSO
  48.     MUIA_Prop_Entries, MUIA_Prop_Visible, MUIA_Prop_First
  49. Prop.mui/MUIA_Prop_Slider
  50.  
  51.     NAME
  52.     MUIA_Prop_Slider -- (V4 ) [ISG], BOOL
  53.  
  54.     FUNCTION
  55.     Indicate that this prop gadget is used in a slider. MUI might
  56.     then use different imagery. Since you really should use the
  57.     slider class when creating sliders, you normally don't need
  58.     to care about this attribute.
  59. Prop.mui/MUIA_Prop_UseWinBorder
  60.  
  61.     NAME
  62.     MUIA_Prop_UseWinBorder -- (V13) [I..], LONG
  63.  
  64.     SPECIAL INPUTS
  65.     MUIV_Prop_UseWinBorder_None
  66.     MUIV_Prop_UseWinBorder_Left
  67.     MUIV_Prop_UseWinBorder_Right
  68.     MUIV_Prop_UseWinBorder_Bottom
  69.  
  70.     FUNCTION
  71.     If you set this attribute to one of
  72.  
  73.     MUIV_Prop_UseWinBorder_Left,
  74.     MUIV_Prop_UseWinBorder_Right,
  75.     MUIV_Prop_UseWinBorder_Bottom,
  76.  
  77.     some very special magic will take place with this
  78.     proportional gadget. In fact, it will not eat
  79.     any display space at all or render anything, it
  80.     stays invisible in your windows GUI. Instead, the
  81.     gadgets control and display will be linked to one
  82.     of the scrollbars in the window border.
  83.  
  84.     There is no difference in talking to the object,
  85.     you can use all prop gadget attributes regardless
  86.     whether its a real prop gadget or just a window
  87.     border link. Of course, gadgets in window borders
  88.     will use the intuition look regardless what the
  89.     user has configured.
  90.  
  91.     NOTES
  92.     You *must* enable border scrollers for the parent window
  93.     with the MUIA_Window_UseXXXBorderScroller attributes
  94.     before using MUIA_Pop_UseWinBorder.
  95.  
  96.     Obviously, you can only link exactly one prop gadget
  97.     to one window scroller. Linking more than one gadget
  98.     to the same window scroller will result in big
  99.     confusion.
  100.  
  101.     To simplify programming, the classes Scrollbar.mui
  102.     and Listview.mui also accept the MUIA_Prop_UseWinBorder
  103.     attribute and pass it on when creating their prop
  104.     gadgets. This allows you to do something like
  105.  
  106.     WindowObject,
  107.        MUIA_Window_UseRightBorderScroller, TRUE,
  108.        MUIA_Window_Contents, VGroup,
  109.           Child, ListviewObject,
  110.              MUIA_Prop_UseWinBorder, MUIV_Prop_UseWinBorder_Right,
  111.              ...
  112.  
  113.     to create a listview thats controllable with a scrollbar in
  114.     the right window border.
  115.  
  116.     Scrollgroup class (for virtual groups) features another
  117.     attribute called MUIA_Scrollgroup_UseWinBorder, TRUE/FALSE
  118.     to allow control of virtual group from window borders.
  119.  
  120.     SEE ALSO
  121.     Window.mui/MUIA_Window_UseBottomBorderScroller,
  122.     Window.mui/MUIA_Window_UseLeftBorderScroller,
  123.     Window.mui/MUIA_Window_UseRightBorderScroller,
  124.     Scrollgroup.mui/MUIA_Scrollgroup_UseWinBorder
  125. Prop.mui/MUIA_Prop_Visible
  126.  
  127.     NAME
  128.     MUIA_Prop_Visible -- (V4 ) [ISG], LONG
  129.  
  130.     FUNCTION
  131.     Set or get the number of visible entries.
  132.  
  133.     SEE ALSO
  134.     MUIA_Prop_Horiz, MUIA_Prop_Entries, MUIA_Prop_First
  135.