Prop.mui Class Reference

BOOPSI custom class Prop.mui (MUI 3.8 dev). Each ### sub-section below documents one of the class's attributes or methods. Sub-classes of Prop.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

Methods

Prop.mui

MUIA_Prop_Entries

MUIA_Prop_Entries -- (V4 ) [ISG], LONG

Function

Set or get the total number of entries.

See also

MUIA_Prop_Horiz, MUIA_Prop_Visible, MUIA_Prop_First

MUIA_Prop_First

MUIA_Prop_First -- (V4 ) [ISG], LONG

Function

Set or get the number of the first entry.

See also

MUIA_Prop_Horiz, MUIA_Prop_Visible, MUIA_Prop_Entries

MUIA_Prop_Horiz

MUIA_Prop_Horiz -- (V4 ) [I.G], BOOL

Function

Determine if you want a horizontal or a vertical prop gadget. Defaults to FALSE, i.e. vertical.

See also

MUIA_Prop_Entries, MUIA_Prop_Visible, MUIA_Prop_First

MUIA_Prop_Slider

MUIA_Prop_Slider -- (V4 ) [ISG], BOOL

Function

Indicate that this prop gadget is used in a slider. MUI might then use different imagery. Since you really should use the slider class when creating sliders, you normally don't need to care about this attribute.

MUIA_Prop_UseWinBorder

MUIA_Prop_UseWinBorder -- (V13) [I..], LONG — SPECIAL INPUTS — MUIV_Prop_UseWinBorder_None — MUIV_Prop_UseWinBorder_Left — MUIV_Prop_UseWinBorder_Right — MUIV_Prop_UseWinBorder_Bottom

Function

If you set this attribute to one of MUIV_Prop_UseWinBorder_Left, MUIV_Prop_UseWinBorder_Right, MUIV_Prop_UseWinBorder_Bottom, some very special magic will take place with this proportional gadget. In fact, it will not eat any display space at all or render anything, it stays invisible in your windows GUI. Instead, the gadgets control and display will be linked to one of the scrollbars in the window border. There is no difference in talking to the object, you can use all prop gadget attributes regardless whether its a real prop gadget or just a window border link. Of course, gadgets in window borders will use the intuition look regardless what the user has configured.

Notes

You must enable border scrollers for the parent window with the corresponding attributes (see below) before using MUIA_Prop_UseWinBorder. Obviously, you can only link exactly one prop gadget to one window scroller. Linking more than one gadget to the same window scroller will result in big confusion. To simplify programming, the classes Scrollbar.mui and Listview.mui also accept the MUIA_Prop_UseWinBorder attribute and pass it on when creating their prop gadgets. This allows you to do something like WindowObject, MUIA_Window_UseRightBorderScroller, TRUE, MUIA_Window_RootObject, VGroup, Child, ListviewObject, MUIA_Prop_UseWinBorder, MUIV_Prop_UseWinBorder_Right, ... to create a listview thats controllable with a scrollbar in the right window border. Scrollgroup class (for virtual groups) features another attribute called MUIA_Scrollgroup_UseWinBorder, TRUE/FALSE to allow control of virtual group from window borders.

See also

Window.mui/MUIA_Window_UseBottomBorderScroller, Window.mui/MUIA_Window_UseLeftBorderScroller, Window.mui/MUIA_Window_UseRightBorderScroller,

MUIA_Scrollgroup_UseWinBorder

MUIA_Prop_Visible

MUIA_Prop_Visible -- (V4 ) [ISG], LONG

Function

Set or get the number of visible entries.

See also

MUIA_Prop_Horiz, MUIA_Prop_Entries, MUIA_Prop_First

MUIM_Prop_Decrease

MUIM_Prop_Decrease (V16) — SYNOPSIS — DoMethod(obj,MUIM_Prop_Decrease,LONG amount);

Function

This method decreases the value of a proportional gadget by the specified amount. Negative values are ok. Range checking is done automatically.

Inputs

amount - amount to substract from the gadgets current position.

See also

MUIM_Prop_Increase, MUIA_Prop_First

MUIM_Prop_Increase

MUIM_Prop_Increase (V16) — SYNOPSIS — DoMethod(obj,MUIM_Prop_Increase,LONG amount);

Function

This method increases the value of a proportional gadget by the specified amount. Negative values are ok. Range checking is done automatically.

Inputs

amount - amount to add to the gadgets current position.

See also

MUIM_Prop_Decrease, MUIA_Prop_First