Scrollgroup.mui Class Reference

BOOPSI custom class Scrollgroup.mui (MUI 3.8 dev). Each ### sub-section below documents one of the class's attributes or methods. Sub-classes of Scrollgroup.mui are listed at the end under Sub-classes; the class hierarchy itself is documented in the MUI classes index.

Function index

Class definition

Attributes

Scrollgroup.mui

MUIA_Scrollgroup_Contents

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

Function

You have to specify an object of Virtgroup class here.

MUIA_Scrollgroup_FreeHoriz

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

Function

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

MUIA_Scrollgroup_FreeVert

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

Function

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

MUIA_Scrollgroup_HorizBar

**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

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

**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