<--- Cannot embed stylesheet: [Errno 2] No such file or directory: '../../../../aros.css' --->

Listview.mui

MUIA_Listview_ClickColumn

Function

Read the column recorded by the child list for its latest relevant
input.

Inputs

Get, LONG; initially zero in a new AROS List. Getter and notification
registration are redirected to List.

Notes

A valid interactive mouse entry press stores the TestPos column and
notifies before DoubleClick and before the later active-entry update.
Keyboard Press stores DefClickColumn and notifies before DoubleClick.
Keyboard Toggle also stores DefClickColumn but does not emit the same
ClickColumn tag. This is cached input context, not a continuous
pointer-position query. Read Active with care during mouse double-click
callbacks: the new active-entry assignment occurs later in the event
handler.

MUIA_Listview_DefClickColumn

Function

Choose the column used for keyboard activation and selection toggling.

Inputs

Initialize, set and get, LONG. Default zero in a new AROS List. Listview
forwards the constructor/set value and the getter.

Notes

No column-range validation is performed. List copies this value into
ClickColumn on keyboard Press before sending ClickColumn and DoubleClick
notifications; Toggle also stores it when multiselection is enabled.
Notifications registered for DefClickColumn itself remain on the wrapper
rather than being redirected to the child.

MUIA_Listview_DoubleClick

Function

Report interactive double-click or keyboard activation events from the
child list.

Inputs

Get and notification trigger, BOOL. Initially FALSE. Although the header
also marks initialize, Listview does not forward this constructor tag
and List does not parse it during construction.

Notes

List internally sets TRUE for two timed mouse presses on the same valid
entry, or keyboard Press in input-enabled mode. Keyboard Press does not
require an active entry. The stored value remains TRUE until explicitly
changed; it is not automatically reset or consumed by Get. Repeated TRUE
tags can deliver repeated notifications. Use notifications for events,
not polling for a fresh transition.
AROS List also accepts this tag in Set, despite its nonpublic setter
role; normal Group forwarding can reach it. Setting a value does not
simulate an actual input event or update ClickColumn. Read-only input
remaps Press to scrolling. Mouse activation notifies before the event
handler performs its later Active update.

MUIA_Listview_DragType

Function

Control whether dragging uses an entry drag image.

Inputs

Initialize, set and get, LONG. Declared values: None (0, default) and
Immediate (1).

Notes

AROS List treats any nonzero value as entry dragging and enables
MUIA_Draggable when this attribute is set; zero disables that flag
through this setter. With drag type None, the drag-image method
delegates to its superclass, allowing whole-list dragging if Draggable
is enabled separately. DragSortable is a separate List attribute and is
not enabled by DragType. The correct identifier is
MUIA_List_DragSortable. Listview forwards the getter, but notifications
on DragType itself remain on the wrapper.

MUIA_Listview_Input

Function

Enable selection-oriented user input or read-only scrolling.

Inputs

Initialize, BOOL; default TRUE for a new AROS List. Listview forwards it
to the child. No dedicated getter in Listview or List.

Notes

FALSE sets List read_only. Mouse entry presses then do not select or
double-click entries. Keyboard Up/Down, Top/Bottom, Press and page keys
use scrolling paths instead of the normal selection/activation paths.
Programmatic selection and list mutation remain possible; this is not a
disabled-object or data-protection flag.
AROS List has an internal setter, and Group forwarding also permits
later changes through Listview. That setter only updates read_only; it
does not cancel an already active drag-selection event sequence or clear
existing selections. Prefer initialization or change it while input
processing is idle.

MUIA_Listview_List

Function

Supply or obtain the list object owned by the wrapper.

Inputs

Initialize and get, Object pointer. Required and non-NULL; no default or
local replacement setter.

Notes

Use a live, unattached List-compatible child. Successful Group
attachment transfers disposal responsibility to the wrapper. Get returns
the same borrowed pointer with TRUE; do not free it or dispose it
separately. Missing/NULL List returns NULL before superclass
construction. If later Group construction fails, follow Group
child-ownership rules; failure does not promise that the supplied child
remains undisposed.

MUIA_Listview_MultiSelect

Function

Choose the child list multiselection policy.

Inputs

Initialize, LONG. None (0, default), Default (1), Shifted (2) or Always
(3). No dedicated getter in Listview or List.

Notes

None disables interactive multiselection without disabling the active
entry. Shifted clears existing selections on an unshifted entry press
and toggles with Shift; Always toggles without requiring Shift. Drag
selection extends the current selection operation. A MultiTestHook on
List can further restrict selection.
Default is resolved during List Setup from its preferences to Shifted or
Always, replacing the stored mode. It is not automatically re-resolved
on later setups unless reset to Default. AROS accepts later values
through its internal setter, reached by Group forwarding, but that
setter does not itself resolve Default. Avoid unknown values: nonzero
tests and exact Shifted comparisons do not validate the enumeration.

MUIA_Listview_ScrollerPos

Function

Choose the vertical scroller placement inside the child List.

Inputs

Initialize; enumeration despite the header BOOL annotation. Default (0),
Left (1), Right (2) or None (3). No dedicated getter in Listview or
List.

Notes

AROS List places Default and Right on the right; Left precedes the list
area and None removes the scroller. Other values follow the right-hand
default branch, not a preference lookup.
Listview forwards initialization using a setter before normal setup. The
List internal setter can rearrange children only while List is not set
up. After Setup it stores the new value but the arrangement helper
returns without rearranging; Setup itself does not retry that helper. A
later pre-setup setter is required to apply a changed arrangement. Use
the constructor tag for normal operation.

MUIA_Listview_SelectChange

Function

Notify that input processing may have changed selected entries.

Inputs

Get and notification trigger, BOOL. Listview redirects both to List.

Notes

The List getter always returns FALSE. The event handler emits TRUE after
operations that may alter multiselection, based on its
clear/toggle/select decisions rather than a comparison of the final
selection set. A TRUE notification does not guarantee that membership
actually changed. This is not a stored dirty flag, not an Active-change
notification and not a universal notification for every programmatic
MUIM_List_Select call.

MUIC_Listview

Superclass

Group.mui

Description

Wrap a supplied List-compatible object in a horizontal Group. Listview
requires List and takes child ownership through Group; it creates
neither a default list nor a separate scroller. The AROS List class owns
and arranges its own scroller. Listview defaults horizontal inner
spacing and group spacing to zero.
The constructor forwards DefClickColumn, DragType, Input, MultiSelect
and ScrollerPos to the list using setters, in tag order. Other
list-specific initialization belongs in the supplied list's constructor.
There is no local Set override: ordinary Group forwarding carries later
tags to children unless disabled by Group_Forward. There is no local
replacement setter for List.
The attribute behavior below describes an ordinary AROS List child.
Subclasses can change the forwarded operations and their return values.
Keep the owned list alive while the wrapper uses it; dispose the wrapper
through its normal Group lifecycle rather than separately disposing the
attached list.

Methods

The dispatcher forwards these methods directly to List and returns its
result: MUIM_List_Clear, CreateImage, DeleteImage, Exchange, GetEntry,
Insert, InsertSingle, Jump, NextSelected, Redraw, Remove, Select, Sort
and TestPos. The abbreviated names begin with MUIM_List followed by an
underscore. Other messages use Group; there is no blanket forwarding of
all List or custom methods.
Get forwards List_CompareHook, ConstructHook, DestructHook, DisplayHook,
VertProp_First, Format, VertProp_Entries, VertProp_Visible, Active,
First, Visible, Entries and Quiet, plus Listview_ClickColumn,
DefClickColumn, DoubleClick, DragType and SelectChange. The child getter
result is returned unchanged; listing an attribute here does not
guarantee that the child's getter implements it.
Notify, KillNotify and KillNotifyObj use the same attribute routing
table. They target the child for List_Active, AutoVisible, CompareHook,
ConstructHook, DestructHook, DisplayHook, DragSortable, DropMark,
Entries, First, Format, InsertPosition, MultiTestHook, Quiet,
ShowDropMarks, Title, VertProp_Entries, VertProp_First, VertProp_Visible
and Visible; also Listview_ClickColumn, DoubleClick and SelectChange.
Other trigger attributes use Group/Notify on the wrapper. The
abbreviated names begin with MUIA followed by an underscore.
Notify and KillNotifyObj replace MUIV_Notify_Self with the actual
wrapper pointer in the caller's writable message before routing. Self
therefore remains the Listview even when the notification record belongs
to List. Registration/removal results come from the selected receiver.
Notification callbacks are synchronous; do not remove an active record
or dispose its source/destination during dispatch.