@database "NLISTCLASS"
@WIDTH 72

@Node "MAIN"
@Title "NList class"

    The NList class is used to manipulate lists.
    NList class is a subclass of NList.mcc .
    You must have NList.mmc in mui:lib/mui to use it.

    A list object is NOT a listview .
    It is only the list that the listview will render.

    A NList object can be adde ONLY to a NListview object
    at listview object creation time.

    ATTRIBUTES

    Name                    Type    Class           Note

    ENTRIES                 S       I
    ACTIVE                  M       ISGN G2N
    ACTIVEENTRY             S       N
    ACTIVEENTRY0            S       N
    ACTIVEENTRY1            S       N
    ACTIVEENTRY2            S       N
    ACTIVEENTRY3            S       N
    ACTIVEENTRY4            S       N
    ACTIVEENTRY5            S       N
    ACTIVEENTRY6            S       N
    ACTIVEENTRY7            S       N
    ACTIVEENTRY8            S       N
    ACTIVEENTRY9            S       N
    ADJUSTHEIGHT            B       I
    ADJUSTWIDTH             B       I
    AUTOCOPYTOCLIP          B       IS
    AUTOVISIBLE             B       ISG
    BUTTONCLICK             N       GN
    CLICKCOLUMN             N       G
    DEFAULTOBJECTONCLICK    B       IS
    DEFCLICKCOLUMN          N       ISG
    DOUBLECLICK             N       GN
    DRAGCOLONLY             N       ISG
    DRAGSORTABLE            B       ISG
    DRAGSORTINSERT          B       GN
    DRAGTYPE                S       ISG G2N
    DROPTYPE                N       G
    DROPMARK                N       G
    ENTRIES                 N       GN
    ENTRYCLICK              N       GN
    FIRST                   M       ISGN G2N
    FORMAT                  S       ISG
    INPUT                   B       ISG
    INSERTPOSITION          N       GN
    MINCOLSORTABLE          N       ISG
    MINLINEHEIGHT           N       IS
    MULTICLICK              N       GN
    MULTICLICKALONE         N       GN
    MULTISELECT             S       I
    SELECTCHANGE            B       N
    SHOWDROPMARK            B       ISG
    SORTTYPE                N       ISGN
    SORTTYPE2               N       ISGN
    LISTVIEWTABSIZE         N       ISGN
    TITLE                   S       I
    TITLECLICK              N       ISGN
    TITLECLICK2             N       ISGN
    TITLEMARK               N       ISG
    TITLEMARK2              N       ISG
    VISIBLE                 N       N
    WRAPCOL                 N       I

    SORTTYPE is a number or one of
    NONE
    ADDNONE
    ADD2VALUES
    ADD4VALUES

    ACTIVE is a number or one of
    OFF
    TOP
    BOTTOM
    UP
    DOWN
    PAGEUP
    PAGEDOWN

    DRAGTYPE is one of
    NONE
    DEFAULT
    IMMEDIATE
    BORDERS
    QUALIFIER

    MULTISELECT is on of (multiselect is not yet implemented)
    NONE
    DEFAULT
    SHIFTED
    ALWAYS

    FIRST is a number or one of
    TOP
    BOTTOM
    UP
    DOWN
    PAGEUP
    PAGEDOWN



    METHODS

    Name                parameters
    SET                 <attr> , <value>
    INSERT              <entry> , [pos]
    CLEAR               -
    EXCHANGE            <entry1> , <entry2>
    GETENTRIES          <varname>
    REPLACECOL          <pos> <col> <value>
    GETENTRY            <pos> <var>
    REMOVE              <pos>
    SORT                -
    SORT2               <type> <add>
    SORT3               <type> <add>,<which>
    JUMP                <pos>
    GETSELECTED         <stem>

    pos for INSERT is a numer or one of
    TOP
    ACTIVE
    SORTED
    BOTTOM

    pos for GENTRY is a number or
    ACTIVE

    pos for REMOVE is a number or
    FIRST
    ACTIVE
    SELECTED
    LAST

    entry1 in EXCHANGE is a numer or one of
    TOP
    ACTIVE
    BOTTOM
    entry2 in EXCHANGE is a numer or one of
    TOP
    ACTIVE
    BOTTOM
    NEXT
    PREVIOUS

    add in SORT1 and SORT2 is a number or one of
    NONE
    ADDNONE
    ADD2VALUES
    ADD4VALUES

    which in SORT3 is a number or one of
    TYPE1
    TYPE2
    BOTH

    GETSELECTED will write in stem.0 ... the number of the selected entries
    and in stem.num the totla number so you can cycle with a
    do i=0 to sel.num-1
     say sel.i
    end
@EndNode
