list.h File Reference

(r1785/r751)

#include "ensure.h"
#include "listitem.h"

Go to the source code of this file.

Classes

class  List
class  ListItemIdx
 A ListItem that points to another ListItem. Used to created list indexes. More...
class  ListListItem
 A ListItem with a 'list' in it. Useful for lists of lists. The destructor deletes all items in its List. More...

Typedefs

typedef INT32 LISTPOS
 The member functions are based on the MFC CObList class, though the implementation differs greatly. In particular no exceptions are thrown as all new items are allocated by someone else and some of the types have changed. An instance of the list class will be something like a list of fonts, and list of undo records etc. Remove functions don't actually de-allocate anything, they just remove items from the list.

Variables

const LISTPOS NOT_IN_LIST = -1
const LISTPOS EMPTY_LIST = -2
const LISTPOS INVALID_LISTPOS = -3
const LISTPOS INVALID_NEWITEM = -4


Typedef Documentation

typedef INT32 LISTPOS
 

The member functions are based on the MFC CObList class, though the implementation differs greatly. In particular no exceptions are thrown as all new items are allocated by someone else and some of the types have changed. An instance of the list class will be something like a list of fonts, and list of undo records etc. Remove functions don't actually de-allocate anything, they just remove items from the list.

Author:
Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com>
Date:
13/4/1993 Base Class: CObject Friends: ListItem
Notes: Two ways of using a list item are provided: by pointer-to-item, and by item-index. The latter is very slow on average compared to the former because the list must be scanned each time to find a LISTPOS. Thus, use the pointer method where possible.

Returns:
Errors: None.

Definition at line 144 of file list.h.


Variable Documentation

const LISTPOS EMPTY_LIST = -2
 

Definition at line 152 of file list.h.

const LISTPOS INVALID_LISTPOS = -3
 

Definition at line 154 of file list.h.

const LISTPOS INVALID_NEWITEM = -4
 

Definition at line 156 of file list.h.

const LISTPOS NOT_IN_LIST = -1
 

Definition at line 150 of file list.h.


Generated on Sat Nov 10 03:49:12 2007 for Camelot by  doxygen 1.4.4