FilterList Class Reference

Take out some of the functionality from filters. More...

#include <filtrmgr.h>

Inheritance diagram for FilterList:

List CCObject SimpleCCObject List of all members.

Public Member Functions

 FilterList ()
 Initialises a list.
BOOL AddFilter (Filter *const pFilter, const UINT32 ID)
 Add a new item to the compatible filter list, which points to the given filter, and stores the given compatibility rating in the list entry. The list is kept in sorted order, i.e. the list item is added to the list according to its compatibility rating; the higher the rating, the closer it is to the head of the list.

Detailed Description

Take out some of the functionality from filters.

Author:
Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com>
Date:
Today

Definition at line 118 of file filtrmgr.h.


Constructor & Destructor Documentation

FilterList::FilterList  ) 
 

Initialises a list.

Author:
Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from Tim)
Date:
28/03/94

Definition at line 639 of file filtrmgr.cpp.

00640 {
00641 }


Member Function Documentation

BOOL FilterList::AddFilter Filter *const   pFilter,
const UINT32  ID
 

Add a new item to the compatible filter list, which points to the given filter, and stores the given compatibility rating in the list entry. The list is kept in sorted order, i.e. the list item is added to the list according to its compatibility rating; the higher the rating, the closer it is to the head of the list.

Author:
Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from Tim)
Date:
28/03/94
Parameters:
pEntry,: the FilterEntry to add to the list. [INPUTS]
Returns:
TRUE if the filter was added to the list ok; FALSE if not.

Errors: Out of memory.

See also:
ComaptibleFilterList; CompatibleFilter

Definition at line 681 of file filtrmgr.cpp.

00682 {
00683     // Make a new list item for this filter.
00684     FilterEntry* pEntry = new FilterEntry(pFilter, ID);
00685     if (pEntry == NULL)
00686     {
00687         return FALSE;
00688     }
00689 
00690     AddTail(pEntry);    // can't fail
00691 
00692     // All ok
00693     return TRUE;
00694 }


The documentation for this class was generated from the following files:
Generated on Sat Nov 10 03:54:19 2007 for Camelot by  doxygen 1.4.4