CursorSpec.h

//========================================================================================
// 
// $File$
// 
// Owner: Dave Burnard
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __CursorSpec__
#define __CursorSpec__

#include "PMTypes.h"
#include "PMString.h"
#include "GetPlugIn.h"
#include "IPlugIn.h"
#include "CursorDefs.h"

typedef void (*CreateCursorBitmapProc)(uchar* bitmapBuffer,uint32* width, uint32* height, bool16 *hasAlpha, bool16 hiRes);

class CursorSpec
{
 public:
 typedef object_type data_type;
 
 CursorSpec() : fID(kCrsrNone), fPlugInID(kInvalidPlugin),fCustomCursorBitmapCallback(nil), fDynamicBitmap(kFalse)
 {
 }
 
 CursorSpec(CreateCursorBitmapProc customDrawCallback,CursorID id) : 
 fCustomCursorBitmapCallback(customDrawCallback), 
 fDynamicBitmap(kFalse),
 fID(id), 
 fPlugInID(kInvalidPlugin)
 {
 }

 CursorSpec(CursorID id) : fID(id), fPlugInID(kInvalidPlugin),fCustomCursorBitmapCallback(nil), fDynamicBitmap(kFalse)
 {
 }
 
 CursorSpec(const PluginID& plugInId, CursorID id) :
 fPlugInID(plugInId), fID(id),fCustomCursorBitmapCallback(nil), fDynamicBitmap(kFalse)
 {
 }
 
 CursorSpec(const IDFile& resFile, CursorID id) :
 fResourceFile(resFile), fID(id), fPlugInID(kInvalidPlugin),fCustomCursorBitmapCallback(nil), fDynamicBitmap(kFalse)
 {
 }
 
 CursorSpec(const CursorSpec& spec) :
 fPlugInID(spec.fPlugInID), fID(spec.fID), fResourceFile(spec.fResourceFile),
 fCustomCursorBitmapCallback(spec.fCustomCursorBitmapCallback), fDynamicBitmap(spec.fDynamicBitmap)
 {
 }
 
 CursorSpec(const PluginID& plugInId, const IDFile& resFile, CursorID id,CreateCursorBitmapProc customDrawCallback, bool32 bDynamicBitmap = kFalse) :
 fPlugInID(plugInId), fID(id), fResourceFile(resFile),fCustomCursorBitmapCallback(customDrawCallback),fDynamicBitmap(bDynamicBitmap)
 {
 }

 CursorSpec& operator=(const CursorSpec& spec)
 {
 if (this != &spec)
 {
 fID = spec.fID;
 fPlugInID = spec.fPlugInID;
 fResourceFile = spec.fResourceFile;
 fCustomCursorBitmapCallback = spec.fCustomCursorBitmapCallback;
 fDynamicBitmap = spec.fDynamicBitmap;
 }
 return *this;
 }
 
 bool operator==(const CursorSpec& spec) const
 {
 if (this == &spec)
 return kTrue;
 else if ((fID == spec.fID) && (fPlugInID == spec.fPlugInID) && (fCustomCursorBitmapCallback == spec.fCustomCursorBitmapCallback)
 && (fDynamicBitmap == spec.fDynamicBitmap))
 return kTrue;
 else
 return kFalse;
 }
 
 PluginID GetPlugInID() const { return fPlugInID; }
 IDFile GetResourceFile() const { return fResourceFile; }
 CursorID GetID() const { return fID; }
 CreateCursorBitmapProc GetCustomBitmapCreationProc() const { return fCustomCursorBitmapCallback; }
 bool32 GetDynamicCallback() const { return fDynamicBitmap; }
 
 private:
 CursorID fID;
 PluginID fPlugInID;
 IDFile fResourceFile;
 CreateCursorBitmapProc fCustomCursorBitmapCallback;
 bool32 fDynamicBitmap;
};

#define PluginCursorSpec(cursorID) CursorSpec(GetPlugIn()->GetPluginID(), cursorID)

#endif