FilterBase Class Reference
[Version 4.1]

A Base Class for Implementing Bitmap Filters. More...

Inheritance diagram for FilterBase:
Inheritance graph
[legend]
Collaboration diagram for FilterBase:
Collaboration graph
[legend]

List of all members.

Public Types

typedef IFilter *(* CreateFunction )(IdStringPtr name)

Public Member Functions

virtual bool run (bool replaceInputBitmap=false)=0
Reference Counting Methods



virtual void forget ()
 decrease refcount and delete object if refcount == 0
virtual void remember ()
 increase refcount
virtual int32_t getNbReference () const
 get refcount
Message Methods



virtual CMessageResult notify (CBaseObject *sender, IdStringPtr message)

Protected Member Functions

 FilterBase (UTF8StringPtr description)
bool registerProperty (IdStringPtr name, const Property &defaultProperty)
CBitmapgetInputBitmap () const
virtual UTF8StringPtr getDescription () const
virtual bool setProperty (IdStringPtr name, const Property &property)
virtual const PropertygetProperty (IdStringPtr name) const
virtual uint32_t getNumProperties () const
virtual IdStringPtr getPropertyName (uint32_t index) const
virtual Property::Type getPropertyType (uint32_t index) const
virtual Property::Type getPropertyType (IdStringPtr name) const

Detailed Description

A Base Class for Implementing Bitmap Filters.


Member Typedef Documentation

typedef IFilter*(* CreateFunction)(IdStringPtr name) [inherited]

Constructor & Destructor Documentation

FilterBase ( UTF8StringPtr  description  )  [protected]

Member Function Documentation

virtual void forget (  )  [inline, virtual, inherited]

decrease refcount and delete object if refcount == 0

virtual UTF8StringPtr getDescription (  )  const [protected, virtual]

Implements IFilter.

CBitmap* getInputBitmap (  )  const [protected]
virtual int32_t getNbReference (  )  const [inline, virtual, inherited]

get refcount

virtual uint32_t getNumProperties (  )  const [protected, virtual]

Implements IFilter.

virtual const Property& getProperty ( IdStringPtr  name  )  const [protected, virtual]

Implements IFilter.

virtual IdStringPtr getPropertyName ( uint32_t  index  )  const [protected, virtual]

Implements IFilter.

virtual Property::Type getPropertyType ( IdStringPtr  name  )  const [protected, virtual]

Implements IFilter.

virtual Property::Type getPropertyType ( uint32_t  index  )  const [protected, virtual]

Implements IFilter.

virtual CMessageResult notify ( CBaseObject sender,
IdStringPtr  message 
) [inline, virtual, inherited]
bool registerProperty ( IdStringPtr  name,
const Property defaultProperty 
) [protected]
virtual void remember (  )  [inline, virtual, inherited]

increase refcount

virtual bool run ( bool  replaceInputBitmap = false  )  [pure virtual, inherited]
virtual bool setProperty ( IdStringPtr  name,
const Property property 
) [protected, virtual]

Implements IFilter.


The documentation for this class was generated from the following file:

Generated on Fri Nov 22 11:10:05 2013 for VSTGUI by  doxygen 1.6.1