MUI Autodocs: Scrollgroup.mui

Copyright © 1997, Stefan Stuntz




Scrollgroup.mui Background

        Scrollgroup objects can be used to supply virtual groups with
        scrollbars. These scrollbars automatically adjust according
        to the virtual and display sizes of the underlying virtual
        group. When scrolling is unnecessary (i.e. the virtual group
        is completely visible), the scrollers might get disabled
        or even disappear completely, depending on the users 
        preferences settings.



Scrollgroup.mui Attributes

    Attribute                           Ver ISG Type
    ----------------------------------- --- --- --------------------
    MUIA_Scrollgroup_Contents           V4  I.G Object *
    MUIA_Scrollgroup_FreeHoriz          V9  I.. BOOL
    MUIA_Scrollgroup_FreeVert           V9  I.. BOOL
    MUIA_Scrollgroup_HorizBar           V16 ..G Object *
    MUIA_Scrollgroup_UseWinBorder       V13 I.. BOOL
    MUIA_Scrollgroup_VertBar            V16 ..G Object *


MUIA_Scrollgroup_Contents


    NAME
        MUIA_Scrollgroup_Contents -- (V4 ) [I.G], Object *

    FUNCTION
        You have to specify an object of Virtgroup class here.


MUIA_Scrollgroup_FreeHoriz


    NAME
        MUIA_Scrollgroup_FreeHoriz -- (V9 ) [I..], BOOL

    FUNCTION
        Specify if a scroll group should be horizontally moveable.
        Defaults to TRUE.


MUIA_Scrollgroup_FreeVert


    NAME
        MUIA_Scrollgroup_FreeVert -- (V9 ) [I..], BOOL

    FUNCTION
        Specify if a scroll group should be vertically moveable.
        Defaults to TRUE.


MUIA_Scrollgroup_HorizBar


    NAME
        MUIA_Scrollgroup_HorizBar -- (V16) [..G], Object *

    FUNCTION
        Returns the object pointer of a scrollgroups scrollbar object
        for horizontal scrolling. Can be NULL in a vertical only
        scrollgroup.

    SEE ALSO
        MUIA_Scrollgroup_VertBar, 
        MUIA_Scrollgroup_FreeHoriz, MUIA_Scrollgroup_FreeVert


MUIA_Scrollgroup_UseWinBorder


    NAME
        MUIA_Scrollgroup_UseWinBorder -- (V13) [I..], BOOL

    FUNCTION
        If you set this to TRUE, MUI will automatically make this
        scrollgroup controllable from gadgets in the window border.
        MUI will use the right border scroller if the virtual
        groups is allowed to move vertically and the bottom
        border scroller if the virtual group is allowed to move
        horizontally.

    NOTES
        You must set the corresponding window attributes
        (see below) for your parent window to use this feature.

        This attribute is not the same as MUIA_Prop_UseWinBorder.
        The latter one allows to specify a border directly whereas
        MUIA_Scrollgroup_UseWinBorder is just a BOOLEAN. MUI will
        decide which borders to use according to the FreeHoriz and
        FreeVert settings.

    SEE ALSO
        Window.mui/MUIA_Window_UseBottomBorderScroller,
        Window.mui/MUIA_Window_UseLeftBorderScroller,
        Window.mui/MUIA_Window_UseRightBorderScroller,
        Prop.mui/MUIA_Prop_UseWinBorder,
        MUIA_Scrollgroup_FreeHoriz, MUIA_Scrollgroup_FreeVert


MUIA_Scrollgroup_VertBar


    NAME
        MUIA_Scrollgroup_VertBar -- (V16) [..G], Object *

    FUNCTION
        Returns the object pointer of a scrollgroups scrollbar object
        for vertical scrolling. Can be NULL in a horizontall only
        scrollgroup.

    SEE ALSO
        MUIA_Scrollgroup_HorizBar,
        MUIA_Scrollgroup_FreeHoriz, MUIA_Scrollgroup_FreeVert





© 1997, Stefan Stuntz [MUI Homepage] [Autodoc Index] [Feedback] Updated: 29-Mar-97