Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Search for 

PlugInItem Class Reference

Provides the minimum requirement to store details on a plug-in. More...

#include <plugin.h>

Inheritance diagram for PlugInItem:

ListItem CCObject SimpleCCObject BfxPlugIn BfxBrightnessContrast BfxColourDepth BfxFlipAndRotate BfxResize BfxSpecialEffects List of all members.

Public Member Functions

 PlugInItem ()
 Constructor for a PlugInItem.
virtual String_32 GetUniqueID () const =0
virtual TypeOfPlugIn GetTypeOfPlugIn () const =0
INT32 GetPathNameID ()
const String_32 & GetModuleName ()
const String_32 & GetFilterName ()
const String_32 & GetFamilyName ()
const String_32 & GetPlugInName ()
const void SetPathNameID (const INT32 NewID)
void SetModuleName (const String_32 &NewName)
void SetFilterName (const String_32 &NewName)
void SetFamilyName (const String_32 &NewName)
void SetPlugInName (const String_32 &NewName)
virtual BOOL About ()
 Find out about a plug-in.
virtual BOOL Apply (KernelBitmap *pInputBitmap, Document *pDocument, KernelBitmap **ppOutputBitmap=NULL)
 Applies a plug-in's bitmap effect to the specified bitmap.
virtual BOOL ApplyLastFilter (KernelBitmap *pInputBitmap, Document *pDocument, KernelBitmap **ppOutputBitmap=NULL)
 Applies a plug-in's bitmap effect to the specified bitmap using the last applied parameters. Assumes that Apply for this plug-in has been called already.
virtual BOOL IsBitmapModeOk (INT32 ColourDepth, BOOL GreyScale)
 Checks to see if a plug-in can cope with the specified colour depth.

Protected Attributes

INT32 m_PathNameID
String_32 m_ModuleName
String_32 m_FilterName
String_32 m_FamilyName
String_32 m_PlugInName

Private Member Functions

 CC_DECLARE_DYNAMIC (PlugInItem)

Detailed Description

Provides the minimum requirement to store details on a plug-in.

Author:
Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
Date:
10/12/96

Definition at line 140 of file plugin.h.

Constructor & Destructor Documentation

PlugInItem::PlugInItem (   ) 
 

Constructor for a PlugInItem.

Author:
Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
Date:
10/12/96

Definition at line 127 of file plugin.cpp.

00128 {
00129     // Set up the class variables to known states
00130     m_PathNameID = -1;
00131     m_ModuleName.Empty();
00132     m_FilterName.Empty();
00133     m_FamilyName.Empty();
00134     m_PlugInName.Empty();
00135 }

Member Function Documentation

BOOL PlugInItem::About (   )  [virtual]
 

Find out about a plug-in.

Author:
Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
Date:
11/12/96
Returns:
True if works ok, False otherwise.

Definition at line 148 of file plugin.cpp.

00149 {
00150     ERROR3("PlugInItem::About baseclass invoked!");
00151     return TRUE;
00152 }

BOOL PlugInItem::Apply (  KernelBitmap *  pInputBitmap,
Document *  pDocument,
KernelBitmap **  ppOutputBitmap = NULL
)  [virtual]
 

Applies a plug-in's bitmap effect to the specified bitmap.

Author:
Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
Date:
17/12/96
Parameters:
pInputBitmap the bitmap to apply the effect to [INPUTS] pDocument document the bitmap is in
ppOutputBitmap if specified, a pointer to the output bitmap generated [OUTPUTS]
Returns:
True if works ok, False otherwise.

Reimplemented in BfxPlugIn.

Definition at line 169 of file plugin.cpp.

00171 {
00172     ERROR3("PlugInItem::Apply baseclass invoked!");
00173     return TRUE;
00174 }

BOOL PlugInItem::ApplyLastFilter (  KernelBitmap *  pInputBitmap,
Document *  pDocument,
KernelBitmap **  ppOutputBitmap = NULL
)  [virtual]
 

Applies a plug-in's bitmap effect to the specified bitmap using the last applied parameters. Assumes that Apply for this plug-in has been called already.

Author:
Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
Date:
17/12/96
Parameters:
pInputBitmap the bitmap to apply the effect to [INPUTS] pDocument document the bitmap is in
ppOutputBitmap if specified, a pointer to the output bitmap generated [OUTPUTS]
Returns:
True if works ok, False otherwise.

Definition at line 193 of file plugin.cpp.

00195 {
00196     ERROR3("PlugInItem::ApplyLastFilter baseclass invoked!");
00197     return TRUE;
00198 }

PlugInItem::CC_DECLARE_DYNAMIC (  PlugInItem   )  [private]
 

const String_32& PlugInItem::GetFamilyName (   )  [inline]
 

Definition at line 159 of file plugin.h.

00159 { return m_FamilyName; } const

const String_32& PlugInItem::GetFilterName (   )  [inline]
 

Definition at line 158 of file plugin.h.

00158 { return m_FilterName; } const

const String_32& PlugInItem::GetModuleName (   )  [inline]
 

Definition at line 157 of file plugin.h.

00157 { return m_ModuleName; } const

INT32 PlugInItem::GetPathNameID (   )  [inline]
 

Definition at line 156 of file plugin.h.

00156 { return m_PathNameID; } const

const String_32& PlugInItem::GetPlugInName (   )  [inline]
 

Definition at line 160 of file plugin.h.

00160 { return m_PlugInName; } const

virtual TypeOfPlugIn PlugInItem::GetTypeOfPlugIn (   )  const [pure virtual]
 

Implemented in BfxPlugIn.

virtual String_32 PlugInItem::GetUniqueID (   )  const [pure virtual]
 

Implemented in BfxPlugIn.

BOOL PlugInItem::IsBitmapModeOk (  INT32  ColourDepth,
BOOL  GreyScale
)  [virtual]
 

Checks to see if a plug-in can cope with the specified colour depth.

Author:
Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
Date:
6/1/97
Parameters:
ColourDepth the colour depth or bits per pixel of the bitmap [INPUTS] GreyScale only relevent if bitmap is 8bpp, True if greyscale
Returns:
True if the bitmap is compatible and False otherwise.

Reimplemented in BfxPlugIn.

Definition at line 213 of file plugin.cpp.

00214 {
00215     return FALSE;
00216 }

void PlugInItem::SetFamilyName (  const String_32 &  NewName  )  [inline]
 

Definition at line 167 of file plugin.h.

00167 { m_FamilyName = NewName; }

void PlugInItem::SetFilterName (  const String_32 &  NewName  )  [inline]
 

Definition at line 166 of file plugin.h.

00166 { m_FilterName = NewName; }

void PlugInItem::SetModuleName (  const String_32 &  NewName  )  [inline]
 

Definition at line 165 of file plugin.h.

00165 { m_ModuleName = NewName; }

const void PlugInItem::SetPathNameID (  const INT32  NewID  )  [inline]
 

Definition at line 164 of file plugin.h.

00164 { m_PathNameID = NewID; }

void PlugInItem::SetPlugInName (  const String_32 &  NewName  )  [inline]
 

Definition at line 168 of file plugin.h.

00168 { m_PlugInName = NewName; }

Member Data Documentation

String_32 PlugInItem::m_FamilyName [protected]
 

Definition at line 175 of file plugin.h.

String_32 PlugInItem::m_FilterName [protected]
 

Definition at line 174 of file plugin.h.

String_32 PlugInItem::m_ModuleName [protected]
 

Definition at line 173 of file plugin.h.

INT32 PlugInItem::m_PathNameID [protected]
 

Definition at line 172 of file plugin.h.

String_32 PlugInItem::m_PlugInName [protected]
 

Definition at line 176 of file plugin.h.

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