Listview.mui Class Reference

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

Listview.mui

MUIA_Listview_ClickColumn

MUIA_Listview_ClickColumn -- (V7 ) [..G], LONG

Function

When using a multi column list, this attribute contains the number of the column where the user clicked.

See also

MUIA_Listview_DefClickColumn

MUIA_Listview_DefClickColumn

MUIA_Listview_DefClickColumn -- (V7 ) [ISG], LONG

Function

When the listview is controlled with the keyboard and the user presses RETURN, the value given here will be used as default for MUIA_Listview_ClickColumn.

See also

MUIA_Listview_ClickColumn

MUIA_Listview_DoubleClick

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

Function

This attribute is set to TRUE whenever the user double clicks on an entry in the list.

See also

MUIA_Listview_SelectChange

MUIA_Listview_DragType

MUIA_Listview_DragType -- (V11) [ISG], LONG — SPECIAL INPUTS — MUIV_Listview_DragType_None — MUIV_Listview_DragType_Immediate

Function

If you want the user to be able to drag items out of your list, you must set this for the listview class. Currently, only one drag type is defined.

MUIA_Listview_Input

MUIA_Listview_Input -- (V4 ) [I..], BOOL

Function

Setting this to FALSE will result in a read only list view. Defaults to TRUE.

See also

MUIA_Listview_MultiSelect

MUIA_Listview_List

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

Function

Every listview needs a list object as child. Specify it here. As every other child, it will get disposes when its parent object is disposed.

Example

ListviewObject,
MUIA_Listview_Input, FALSE,
MUIA_Listview_List , ListObject,
ReadListFrame,
MUIA_List_Format       , ",,",
End,
End;

See also

MUIA_Listview_Input

MUIA_Listview_MultiSelect

MUIA_Listview_MultiSelect -- (V7 ) [I..], LONG — SPECIAL INPUTS — MUIV_Listview_MultiSelect_None — MUIV_Listview_MultiSelect_Default — MUIV_Listview_MultiSelect_Shifted — MUIV_Listview_MultiSelect_Always

Function

Four possibilities exist for a listviews multi select capabilities: MUIV_Listview_MultiSelect_None: The listview cannot multiselect at all. MUIV_Listview_MultiSelect_Default: The multi select type (with or without shift) depends on the users preferences setting. MUIV_Listview_MultiSelect_Shifted: Overrides the users prefs, multi selecting only together with shift key. MUIV_Listview_MultiSelect_Always: Overrides the users prefs, multi selecting without shift key. Please do not override the users prefs unless you have a good reason!

See also

MUIA_List_MultiTestHook

MUIA_Listview_ScrollerPos

MUIA_Listview_ScrollerPos -- (V10) [I..], BOOL — SPECIAL INPUTS — MUIV_Listview_ScrollerPos_Default — MUIV_Listview_ScrollerPos_Left — MUIV_Listview_ScrollerPos_Right — MUIV_Listview_ScrollerPos_None

Function

Specifies the position of a listviews scrollbar. Don't use this tag unless it's absolutely required! If you specify MUIV_Listview_ScrollerPos_None, your listview wont get a scroller at all and look much like a list object alone. However, listviews without scroller are still more powerful than list objects as they feature e.g. drag&drop possibilities. Creating listviews without a scrollbar makes sense if you want to have the scrollbar somewhere else, e.g. outside of a horizontal virtual group where the listview resides. This technique allows the creation of horizontally scrollable listviews. When you create the scrollbar on your own, connect it to the list object (not listview object!) like this: DoMethod(sbar,MUIM_Notify,MUIA_Prop_First ,MUIV_EveryTime, list,3,MUIM_Set,MUIA_List_TopPixel,MUIV_TriggerValue); DoMethod(list,MUIM_Notify,MUIA_List_TotalPixel ,MUIV_EveryTime, sbar,3,MUIM_Set,MUIA_Prop_Entries ,MUIV_TriggerValue); DoMethod(list,MUIM_Notify,MUIA_List_VisiblePixel,MUIV_EveryTime, sbar,3,MUIM_Set,MUIA_Prop_Visible ,MUIV_TriggerValue); DoMethod(list,MUIM_Notify,MUIA_List_TopPixel ,MUIV_EveryTime, sbar,3,MUIM_Set,MUIA_Prop_First ,MUIV_TriggerValue);

MUIA_Listview_SelectChange

MUIA_Listview_SelectChange -- (V4 ) [..G], BOOL

Function

This attribute is set to TRUE whenever the selection state of one or more items in the list is changing. You can use this e.g. if you want to display the number of selected items in a status line.

See also

MUIA_Listview_MultiSelect