FLT_FilterHandler Class Reference

Search for all occurrences

#include <filters.h>

Inheritance diagram for FLT_FilterHandler:

---

Class Description

See also:

Class ImageFilter, Class ClassDesc, ImageFilter Capability Flags.

Description:

This class provides methods that access properties of the image filter plug-in. All methods of this class are implemented by the system.

Public Member Functions
	FLT_FilterHandler ()
const MCHAR *	Description (const MCHAR *d=NULL)
void	SetCD (ClassDesc *dll)
ClassDesc *	GetCD ()
void	SetCapabilities (DWORD cap)
DWORD	GetCapabilities ()
BOOL	TestCapabilities (DWORD cap)
bool	operator== (const FLT_FilterHandler &b) const

---

Constructor & Destructor Documentation

FLT_FilterHandler

(

)

Remarks:

Constructor. The capability flags are set to 0, the description string is set to NULL, and the class descriptor is set to NULL.

---

Member Function Documentation

const MCHAR* Description

(

const MCHAR *

d = NULL

)

Search for all occurrences

Remarks:

Sets the description string associated with a ImageFilter plug-in.

Parameters:

const MCHAR *d = NULL

The string to set.

Returns:

The string that was set.

void SetCD

(

ClassDesc *

dll

)

[inline]

Search for all occurrences

Remarks:

Sets the class descriptor associated with the ImageFilter.

Parameters:

ClassDesc *dll

The class descriptor to set.

{ cd = dll;}

ClassDesc* GetCD

(

)

[inline]

Search for all occurrences

Remarks:

Returns a pointer to the class descriptor.

{ return    cd;}

void SetCapabilities

(

DWORD

cap

)

[inline]

Search for all occurrences

Remarks:

Sets the capability flag. The flags passed are ORed into the existing flags.

Parameters:

DWORD cap

The flags to set.

{ fltCapability |= cap;}

DWORD GetCapabilities

(

)

[inline]

Search for all occurrences

Remarks:

Returns the capability flags.

{ return    (fltCapability);}

BOOL TestCapabilities

(

DWORD

cap

)

[inline]

Search for all occurrences

Remarks:

Tests the flags passed to see if they are set in the capability flags.

Parameters:

DWORD cap

The flags to test.

Returns:

TRUE if the flags are set; otherwise FALSE.

{ return    (fltCapability  & cap);}

bool operator==

(

const FLT_FilterHandler &

b

)

const [inline]

Remarks:

Compares this class instance to another one

                {
                        return fltCapability == b.fltCapability && cd == b.cd && ::_tcscmp( fltDescription, b.fltDescription ) == 0;
                }