Index | Parent | List class |
The List class is used to manipulate lists.
A list object is not a Listview: It is the object a Listview renders.
A List object can only be added to a Listview object at Listview creation time.
See Listview
Attributes | |||
---|---|---|---|
Name | Type | Class | Note |
Active | M | ISGN G2N | A number or one of:
|
ActiveEntry | S | GN | As Active, but as the value of the active entry |
ActiveEntry0 | S | GN | The value of the columun number 0 of the active entry |
ActiveEntry1 | S | GN | |
ActiveEntry2 | S | GN | |
ActiveEntry3 | S | GN | |
ActiveEntry4 | S | GN | |
ActiveEntry5 | S | GN | |
ActiveEntry6 | S | GN | |
ActiveEntry7 | S | GN | |
ActiveEntry8 | S | GN | |
ActiveEntry9 | S | GN | |
AdjustHeight | B | I | |
AdjustWidth | B | I | |
AutoVisible | B | ISG | |
Case | B | I | Sets case comparation mode (0 is the default) |
DefaultInsertPos | M | IS | A number or one of:
|
DragSortable | B | ISG | |
DropMark | N | G | |
Entries | S | I | |
First | N | ISGN | |
Format | S | ISG | |
Image | S | I | See Images in lists |
InsertPosition | N | GN | |
List | S | I | A name of an ARexx stem where to read entries |
MinLineHeight | N | I | |
Names | S | I | A string of entries separated by a , |
NumSelected | N | G | The number of the selected entries |
NumSort | B | ISGN | Sets numeric comparation mode (0 is the default) |
Quiet | B | SG | |
Separator | C | I | The char to be used as columns separator in a multi column list. Default: | |
ShowDropMarks | B | ISG | |
SortFormat | S | ISG | Here you may specify a sort Format String to control some
sorting options. The string may contain one entry for each
column of the list. Entries are seperated by commas: each entry is parsed via dos.library/ReadArgs().
The template for a single entry is C=COL/K/N,NUM/S,CASE/S where:
Let's suppose you created a List with 3 col, First, Second and Third, where First is to be nocase-sorted, Second is to be case-sorted and Third is to be num-sorted, just set (init) SortFormat to "CASE,,NUM" |
SortType | M G2N | ISGN | Specify the sort type and order. When set, it is a string to parse with the
template OFF/S,COL/K/N,REV/S, where
|
Title | S | I | |
Visible | N | N |
Methods | ||
---|---|---|
Name | Parameters | Note |
AddStem | <stemName/V>,[pos] | Add the entries defined in stem to the list. mode is one of:
|
Clear | Clear the list. | |
ClearAddStem | <stemName/V>,[pos] | As AddStem, but clear the list before adding the entries<./td> mode is one of:
|
Exchange | <entry1>,<entry2> | Exchange 2 entries. entry1 is a number or one of:
entry2 is a number or one of:
|
GetEntries | <stemName> | The method writes in stem.num the number of the entries and in stem.0,... stem.i
(i=stem.num-1) the entries: call 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 |
GetSortType | <var/V> | Get the human form of SortType value. If you read SortType, you get an integral number, the format of which is not even compatible with ARexx integral numbers. This methods writes in var the SortType string. See Insertion and Sorting |
Insert | <entry>, [pos] | Insert an entry in a list. pos is a number or one of:
|
Jump | [pos] | Jump to an entry, making it visible. pos is a number or one of
|
Remove | [pos] | Remove an entry. pos is a number or one of
|
ReplaceCol | <pos>,<col>,<value> | Replace the contents of the col column of the pos entry with value.
pos is a number of Active. |
Select | [pos],[type],[var/S] | Select entries. pos is a number or one of:
type is a number or one of:
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. See Insertion and Sorting |
Insertion means adding entries at init time and adding entries with AddStem and ClearAddStem methods.
Insertion is ruled by the following attributes:
At init time, if DefaultInsertPos is specified and it is not Default, entries are inserted at the position specified, otherwise: if DragSortable is 1, entries are inserted Sorted, otherwise entries are inserted at the bottom.
The above applies also when adding entries with AddStem and ClearAddStem.
Sorting is ruled by SortType and SortFormat; SortType specifies the sorting criterium: no sort, the number of the column that rules the sort, reverse order; SortFormat specifies options for each column of the List.
Note that SortType default value is OFF. It means that no sorting applies so that entries are inserted not sorted (usually at the bottom).