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  
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  
Case B I Set comparation mode (0 is the default)
ClickColumn N G  
DefaultObjectOnClick B IS  
DefClickColumn   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  
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  
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 S  
SelectChange B N  
ShowDropMark B ISG For compatibility reasones, use ShowDropMarks
ShowDropMarks B ISG  
SortType N ISGN A number or one of:
  • None
  • AddNone
  • Add2Values
  • Add4Values
SortType2 N ISGN  
Title S I  
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> Add the entries defined in stem to the list
Clear    
ClearAddStem <stemName/V> As AddStem, but clear the list before adding the entries
Exchange <entry1>,<entry2> entry1 is a number or one of:
  • Top
  • Active
  • Bottom

entry2 is a number or one of:

  • Top
  • Active
  • Bottom
  • Next
  • Previous
GetEntries <varname>  
GetEntry <pos>,<var> 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] pos is a number or one of:
  • Top
  • Active
  • Sorted
  • Bottom
Jump <pos> pos is a number or one of:
  • Active
  • Top
  • Bottom
  • Up
  • Down
Remove <pos> pos is a number or:
  • First
  • Active
  • Selected
  • Last
ReplaceCol <pos>,<col>,<value>  
Select <pos>,<val> pos is a number or one of:
  • Active
  • All

val is a number or one of:

  • On
  • Off
  • None
  • Toggle
Sort    
Sort2 <type>,<add> 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> add is a number or one of:
  • None
  • AddNone
  • Add2Values
  • Add4Values

which is a number or one of:

  • Type1
  • Type2
  • Both