Index Parent

NList class

The NList class is used to manipulate lists.

A NList object is not a NListview: it is the list that the NListview will render.

A NList object can only be added to a NListview object at NListview creation time.

NList class is a subclass of NList.mcc, so you must have NList.mmc in MUI:Libs/MUI to use it. Nlist.mcc is copyright of Gilles Masson.

See NListview.

 

Attributes
Name Type Class Note
Active M ISGN G2N A number or one of:
  • Off
  • Top
  • Bottom
  • Up
  • Down
  • PageUp
  • PageDown
ActiveEntry S N As Active, but represents the contents of the entry
ActiveEntry0 S N The contents of the column number 0 of the active entry
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  
Case B I Set comparation mode (0 is the default)
ClickColumn N G  
DefaultInsertPos M IS A number or one of:
  • Active
  • Default (Default)
  • Bottom
  • Sorted
  • Top
Entries supplied at Init time or via AddStem or ClearAddStem are inserted at this position. If this attribute is not supplied or its value is Default, entries are inserted:
  • Sorted - if DragSortable is 1
  • At the bottom - otherwise
DefaultObjectOnClick B IS  
DefClickColumn N ISG  
DoubleClick N GN  
DragColOnly N SG  
DragSortable B ISG  
DragSortInsert B GN  
DragType S ISG G2N One of:
  • None
  • Immediate
  • Borders
  • Qualifier
  • MultiSelect
  • None
  • Default
  • Shifted
  • Always
DropMark N G  
DropType N G  
Entries N GN  
EntryClick N GN  
First M ISGN G2N A number or one of:
  • Top
  • Bottom
  • Up
  • Down
  • PageUp
  • PageDown
ForcePen N ISGN  
Format S ISG  
HorizDeltaFactor N GN  
HorizEntries N GN  
HorizFirst N SGN  
HorizVisible N GN  
Image S I See Images in lists
Input B ISG  
InsertPosition N GN  
LineHeight N GN  
List S I A name of an ARexx stem where to read entries
ListviewTabSize N ISGN  
MinColCompare N I Specify the minimum column number that affects the sorting. It is specially usefull if the first column of the list contains an image specification.
MinColSortable N ISG  
MinLineHeight N IS  
MultiClick N GN  
MultiClickAlone N GN  
MultiSelect S I  
Names S I A string of entries separated by a ,
PropDeltaFactor N GN  
PropEntries N GN  
PropFirst N SGN  
PropVisible N GN  
Quiet B SG  
SelectChange B N  
ShowDropMark B ISG For compatibility reasons, use ShowDropMarks
ShowDropMarks B ISG  
SortType N ISGN A number or one of:
  • None
  • AddNone
  • Add2Values
  • Add4Values
SortType2 N ISGN  
Title S IS  
TitleClick N ISGN  
TitleClick2 N ISGN  
TitleMark N ISG  
TitleMark2 N ISG  
Visible N N  
WrapCol N I  

 

Methods
Name Parameters Note
AddStem <stemName/V>,[pos] Add the entries defined in stem to the list. mode is one of:
  • Active
  • Default
  • Bottom
  • Sorted
  • Top
See DefaultInsertPos
Clear   Clear the list
ClearAddStem <stemName/V>,[pos] As AddStem, but clear the list before adding the entries<./td> mode is one of:
  • Active
  • Default
  • Bottom
  • Sorted
  • Top
See DefaultInsertPos
Exchange <entry1>,<entry2> Exchange 2 entries

entry1 is a number or one of:

  • Top
  • Active
  • Bottom

entry2 is a number or one of:

  • Top
  • Active
  • Bottom
  • Next
  • Previous
GetEntries <stem> The method writes in stem.num the number of the entries and in stem.0,... stem.i (i=stem.num-1) the entries: 
    DoMethod("list","GetEntries","entries")
    do i=0 to entries.num-1
        say entries.i
    end
GetEntry <pos>,<var> Get an entry

pos is a number or Active
GetSelected <stem> The method writes in stem.num the number of the selected entries and in stem.0,... stem.i (i=stem.num-1) the entries: 
    do i=0 to sel.num-1
        say sel.i
    end
Insert <entry>, [pos] Insert an entry.

pos is a number or one of:

  • Active
  • Bottom (Default)
  • Sorted
  • Top
InsertWrap <entry>,[pos],[wrapcol],[align] Insert an entry.

pos is a number or one of:

  • Active
  • Bottom (Default)
  • Sorted
  • Top

wrapcol is a number or one of:

  • NoWrap
  • WrapCol0
  • WrapCol1
  • WrapCol2
  • WrapCol3
  • WrapCol4
  • WrapCol5
  • WrapCol6
  • Wrapped

align is a number or one of:

  • Center
  • Justify
  • Left
  • Right
Jump [pos] Jump to an entry, making it visible

pos is a number or one of:

  • Active (Default)
  • Bottom
  • Down
  • Top
  • Up
Remove [pos] Remove an entry

pos is a number or:

  • Active (Default)
  • First
  • Last
  • Selected
ReplaceCol <pos>,<col>,<value> Replace the col column of the pos entry with value

pos is a number or Active
Select [pos],[type],[var/S] Select entries.

pos is a number or one of:

  • Active (Default)
  • All

val is a number or one of:

  • Ask
  • On
  • Off
  • Toggle (Default)

If type is Ask the third argument must be supplied and must be a valid ARexx var name: it will contain the number of the selected entries.
Sort   Sort the entries of the list
Sort2 <type>,<add> Sort the entries of the list

add is a number or one of:

  • None
  • AddNone
  • Add2Values
  • Add4Values

Many times this method will be used to sort multicolumn list when the user click on title buttons:

    call Notify("list","TitleClick",
    "Everytime","list","Sort2","TriggerValue",
    "Add2Values")
Sort3 <type>,<add>,<which> Sort the entries of the list

add is a number or one of:

  • None
  • AddNone
  • Add2Values
  • Add4Values

which is a number or one of:

  • Type1
  • Type2
  • Both