FLT_FilterList Class Reference

Search for all occurrences

#include <filters.h>

Inheritance diagram for FLT_FilterList:

---

Class Description

See also:

Class FilterHandler, Template Class Tab, ImageFilter Capability Flags.

Description:

This class provides methods to access the table of image filters. Methods are provided to find the index in the table of the filter using it description string, check the capabilities of any filter in the table, and to create instances of any filters in the table. All methods of this class are implemented by the system.

Public Member Functions
	FLT_FilterList ()
BOOL	Listed (BOOL f)
BOOL	Listed ()
FLTExport int	FindFilter (const MCHAR *name)
FLTExport DWORD	GetFilterCapabilities (const MCHAR *name)
FLTExport ImageFilter *	CreateFilterInstance (const MCHAR *d)

---

Constructor & Destructor Documentation

FLT_FilterList

(

)

[inline]

Remarks:

Constructor. The flag that indicates the list of filters has been built is set to FALSE.

: listed(FALSE)          {    }

---

Member Function Documentation

BOOL Listed

(

BOOL

f

)

[inline]

Search for all occurrences

Remarks:

Sets the state to indicate the list of filter plug-ins has been built.

Parameters:

BOOL f

TRUE indicates the list has been built; FALSE indicates this list has not been built.

Returns:

The state that was set is returned.

{ listed    = f; return (listed);};

BOOL Listed

(

)

[inline]

Search for all occurrences

Remarks:

Returns TRUE if the list of filter plug-ins has been built; otherwise FALSE.

{ return    (listed);};

FLTExport int FindFilter

(

const MCHAR *

name

)

Search for all occurrences

Remarks:

Returns the index in the filter table of the image filter whose description string is passed.

Parameters:

const MCHAR *name

The Description string of the filter to find.

Returns:

If found, the index in the table is returned; otherwise -1.

FLTExport DWORD GetFilterCapabilities

(

const MCHAR *

name

)

Search for all occurrences

Remarks:

Returns the capability flags associated with the image filter whose description is passed.

Parameters:

const MCHAR *name

The Description string of the filter.

Returns:

The capability flags. If not found, 0 is returned.

FLTExport ImageFilter* CreateFilterInstance

(

const MCHAR *

d

)

Search for all occurrences

Remarks:

This method creates an instance of the ImageFilter class. This method will call Create() on the class descriptor. Make sure to delete this instance after use.

Parameters:

const MCHAR *d

The Description string of the filter to create.

Returns:

An instance of the ImageFilter class. The developer is responsible for deleting this instance.