List of frame lists.
List of frame lists.
static ItemListList alloc()
Create a new empty list. The list may be again deleted using release.
| Name | Type | Default | Description |
| Return | ItemListList | pointer to a new empty list |
static void clear(ItemListList pl)
Clear all entries of a ItemListList. The entries itself aer not deleted.
| Name | Type | Default | Description |
| pl | ItemListList | - | pointer to a valid ItemListList |
static void release(ItemListList pl)
Delete a list from the active store.
| Name | Type | Default | Description |
| pl | ItemListList | - | pointer to a valid ItemListList |
static int length(ItemListList pl)
Current length of the list
| Name | Type | Default | Description |
| Return | int | Number of list elements | |
| pl | ItemListList | - | pointer to a valid ItemListList |
static ItemList get(ItemListList pl, int index)
Get the list element
| Name | Type | Default | Description |
| Return | ItemList | found object. In case of error the call returns 0. | |
| pl | ItemListList | - | Pointer to a valid ItemListList |
| index | int | - | 0-based list index |
static int get_pos(ItemListList pl, ItemList p)
Define the index which has an object in the list.
| Name | Type | Default | Description |
| Return | int | 0-based list position of the object. If the object is not found, the call returns -1. | |
| pl | ItemListList | - | Pointer to a valid ItemListList |
| p | ItemList | - | Pointer to a valid product |
static int append(ItemListList pl, ItemList p)
Insert an object to the list.
| Name | Type | Default | Description |
| Return | int | 0 or ErrorCode | |
| pl | ItemListList | - | pointer to a valid ItemListList |
| p | ItemList | - | pointer to a valid product |
static int insert(
ItemListList pl,
ItemList p,
int index,
int allowDoubles = 1)
Insert an object in the list.
| Name | Type | Default | Description |
| Return | int | 0 or ErrorCode | |
| pl | ItemListList | - | pointer to a valid ItemListList |
| p | ItemList | - | pointer to a valid product |
| ix | int | - | Insert in front of this position. The position is 0-based. To insert an object to the list, use append or the Index -1. |
static int remove_pos(ItemListList pl, int index)
Remove an object from the list. The object at the defined list position will be removed from the list. It will not be automatically deleted upon removal from the list. To release the removed list, use itemlist::release.
| Name | Type | Default | Description |
| Return | ItemList | The removed object 0 - no object is to be removed from the list |
|
| pl | ItemListList | - | pointer to a valid ItemListList |
| ix | int | - | 0-based list index |
static int remove(ItemListList pl, ItemList p)
Delete an object from the list. The object will be removed from the list. It will not be automatically deleted upon removal from the list. To release the removed list, use itemlist::release.
| Name | Type | Default | Description |
| Return | ItemList | The removed object 0 - the object was not found in the list |
|
| pl | ItemListList | - | pointer to a valid ItemListList |
| p | ItemList | - | pointer to a valid product |
static ItemList first(ItemListList pl)
Get the first object of the list and define the current list pointer at the list start.
| Name | Type | Default | Description |
| Return | ItemList | First object in the list 0 - Empty list |
|
| pl | ItemListList | - | Pointer to a valid ItemListList |
static ItemList next(ItemListList pl)
Move the current list pointer one position onwards and get the next object of the list. The call is dependent on either first or last and some prev calls.
| Name | Type | Default | Description |
| Return | ItemList | Next object of the list 0 - List end not reached |
|
| pl | ItemListList | - | Pointer to a valid ItemListList |
static ItemList prev(ItemListList pl)
Move the current list pointer one position onwards and get the next object of the list. The call is dependent on either first or last and some next calls.
| Name | Type | Default | Description |
| Return | ItemList | Next object of the list 0 - List start reached |
|
| pl | ItemListList | - | Pointer to a valid ItemListList |
static ItemList last(ItemListList pl)
Get the last object of the list and define the current list pointer at the list end.
| Name | Type | Default | Description |
| Return | ItemList | Last object of the list 0 - List empty |
|
| pl | ItemListList | - | Pointer to a valid ItemListList |
Alphabetic index HTML hierarchy of classes or Java