listview.gadget Reference¶

Comprehensive function reference for listview.gadget, synthesised from the AmigaOS NDK 3.2 Release 4 (Autodocs/listview).

This page documents 2 functions of listview.gadget. Each function entry follows the canonical autodoc format. struct Name, union Name, enum Name are clickable links to the type definition in the types reference.

Function index¶

• listview_gc()
• LISTVIEW_GetClass()

---

listview_gc()¶

**listview_gc -- For browsing linked lists in various ways.

SUPERCLASS
    gadgetclass

REQUIRES
    None

DESCRIPTION
    This gadget is very similar to the LISTVIEW_KIND gadget in
    gadtools.library, with numerous enhancements.  It displays a list in
    a scrolling view so that you can browse through it an select items
    in various ways.

    listbrowser.gadget is a better alternative to this gadget.

ATTRIBUTES
    LISTVIEW_Labels (struct List *)
        Pointer to the list of listview items. The type of the items
        is ListLabelNode. You are responsible for allocating and
        freeing the memory for these items yourself.

        Applicability is OM_NEW, OM_SET, OM_GET

    LISTVIEW_Top (ULONG)
        Ordinal number of the topmost visible item.

        Applicability is OM_NEW, OM_SET, OM_GET

    LISTVIEW_Visible (ULONG)
        Number of visible items.

        Applicability is OM_GET

    LISTVIEW_Total (ULONG)
        Total number of items.

        Applicability is OM_GET

    LISTVIEW_MakeVisible (ULONG)
        Ensure the item with this ordinal number is visible.

        Applicability is OM_NEW, OM_SET

    LISTVIEW_MultiSelect (BOOL)
        Whether to allow selection of multiple items.

        Applicability is OM_NEW, OM_SET

    LISTVIEW_ItemHeight (ULONG)
        Height of each item, in pixels.

        Applicability is OM_NEW, OM_SET, OM_GET

    LISTVIEW_CallHook (struct Hook *)
        Render hook.

        Applicability is OM_NEW, OM_SET

    LISTVIEW_ScrollUp (ULONG)
        Scroll view up by the specified number of items.

        Applicability is OM_NEW, OM_SET

    LISTVIEW_ScrollDown (ULONG)
        Scroll view down by the specified number of items.

        Applicability is OM_NEW, OM_SET

    These tags are not currently implemented:

    LISTVIEW_ShowSelected
    LISTVIEW_Selected
    LISTVIEW_SelectedNode
    LISTVIEW_ScrollLeft
    LISTVIEW_ScrollRight
    LISTVIEW_Spacing**

---

LISTVIEW_GetClass()¶

LISTVIEW_GetClass -- Gets the pointer to the listview class.

Synopsis

listview_class = LISTVIEW_GetClass();
D0

Class * LISTVIEW_GetClass(VOID);

Function

    Obtains the pointer to the ListView gadget class for use with
    NewObject().  This function always returns a valid pointer so
    you do not need to check it.  The reason is that if the library
    opens fine, then the pointer returned is already setup.  (Of course
    this implies that if opening the library fails, you shouldn't be
    calling this.)

    Note that this function does not create the class, that is done
    when the class library is opened.

Inputs

    Nothing.

RESULT
    listview_class - Pointer to the ListView gadget class.

---