home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 13 / amigaformatcd13.iso / mui / mui_developer / autodocs / mui_scrollgroup.doc < prev    next >
Text File  |  1997-03-10  |  3KB  |  97 lines
  1. TABLE OF CONTENTS
  2.  
  3. Scrollgroup.mui/Scrollgroup.mui
  4. Scrollgroup.mui/MUIA_Scrollgroup_Contents
  5. Scrollgroup.mui/MUIA_Scrollgroup_FreeHoriz
  6. Scrollgroup.mui/MUIA_Scrollgroup_FreeVert
  7. Scrollgroup.mui/MUIA_Scrollgroup_HorizBar
  8. Scrollgroup.mui/MUIA_Scrollgroup_UseWinBorder
  9. Scrollgroup.mui/MUIA_Scrollgroup_VertBar
  10. Scrollgroup.mui/Scrollgroup.mui
  11.  
  12.     Scrollgroup objects can be used to supply virtual groups with
  13.     scrollbars. These scrollbars automatically adjust according
  14.     to the virtual and display sizes of the underlying virtual
  15.     group. When scrolling is unnecessary (i.e. the virtual group
  16.     is completely visible), the scrollers might get disabled
  17.     or even disappear completely, depending on the users 
  18.     preferences settings.
  19. Scrollgroup.mui/MUIA_Scrollgroup_Contents
  20.  
  21.     NAME
  22.     MUIA_Scrollgroup_Contents -- (V4 ) [I.G], Object *
  23.  
  24.     FUNCTION
  25.     You have to specify an object of Virtgroup class here.
  26. Scrollgroup.mui/MUIA_Scrollgroup_FreeHoriz
  27.  
  28.     NAME
  29.     MUIA_Scrollgroup_FreeHoriz -- (V9 ) [I..], BOOL
  30.  
  31.     FUNCTION
  32.     Specify if a scroll group should be horizontally moveable.
  33.     Defaults to TRUE.
  34. Scrollgroup.mui/MUIA_Scrollgroup_FreeVert
  35.  
  36.     NAME
  37.     MUIA_Scrollgroup_FreeVert -- (V9 ) [I..], BOOL
  38.  
  39.     FUNCTION
  40.     Specify if a scroll group should be vertically moveable.
  41.     Defaults to TRUE.
  42. Scrollgroup.mui/MUIA_Scrollgroup_HorizBar
  43.  
  44.     NAME
  45.     MUIA_Scrollgroup_HorizBar -- (V16) [..G], Object *
  46.  
  47.     FUNCTION
  48.     Returns the object pointer of a scrollgroups scrollbar object
  49.     for horizontal scrolling. Can be NULL in a vertical only
  50.     scrollgroup.
  51.  
  52.     SEE ALSO
  53.     MUIA_Scrollgroup_VertBar, 
  54.     MUIA_Scrollgroup_FreeHoriz, MUIA_Scrollgroup_FreeVert
  55. Scrollgroup.mui/MUIA_Scrollgroup_UseWinBorder
  56.  
  57.     NAME
  58.     MUIA_Scrollgroup_UseWinBorder -- (V13) [I..], BOOL
  59.  
  60.     FUNCTION
  61.     If you set this to TRUE, MUI will automatically make this
  62.     scrollgroup controllable from gadgets in the window border.
  63.     MUI will use the right border scroller if the virtual
  64.     groups is allowed to move vertically and the bottom
  65.     border scroller if the virtual group is allowed to move
  66.     horizontally.
  67.  
  68.     NOTES
  69.     You must set the corresponding window attributes
  70.     (see below) for your parent window to use this feature.
  71.  
  72.     This attribute is not the same as MUIA_Prop_UseWinBorder.
  73.     The latter one allows to specify a border directly whereas
  74.     MUIA_Scrollgroup_UseWinBorder is just a BOOLEAN. MUI will
  75.     decide which borders to use according to the FreeHoriz and
  76.     FreeVert settings.
  77.  
  78.     SEE ALSO
  79.     Window.mui/MUIA_Window_UseBottomBorderScroller,
  80.     Window.mui/MUIA_Window_UseLeftBorderScroller,
  81.     Window.mui/MUIA_Window_UseRightBorderScroller,
  82.     Prop.mui/MUIA_Prop_UseWinBorder,
  83.     MUIA_Scrollgroup_FreeHoriz, MUIA_Scrollgroup_FreeVert
  84. Scrollgroup.mui/MUIA_Scrollgroup_VertBar
  85.  
  86.     NAME
  87.     MUIA_Scrollgroup_VertBar -- (V16) [..G], Object *
  88.  
  89.     FUNCTION
  90.     Returns the object pointer of a scrollgroups scrollbar object
  91.     for vertical scrolling. Can be NULL in a horizontall only
  92.     scrollgroup.
  93.  
  94.     SEE ALSO
  95.     MUIA_Scrollgroup_HorizBar,
  96.     MUIA_Scrollgroup_FreeHoriz, MUIA_Scrollgroup_FreeVert
  97.