ToolRecord.h

//========================================================================================
// 
// $File$
// 
// Owner: lance bushore
// 
// $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 __ToolRecord__
#define __ToolRecord__

class ITool;

class ToolRecord
{
 public: // note: holds a ref on the interface.
 typedef base_type data_type;
 ToolRecord(ITool* face, int32 groupNum, int32 toolNum, ClassID parentTool, int32 subToolNum, RsrcID iconID, const PluginID& pluginID);
 ToolRecord(const ToolRecord& rec);
 ToolRecord(); 
 ~ToolRecord();
 
 void ReadWrite(IPMStream *s);

 ITool* QueryTool();
 
 int32 GetGroupNum() const;

 int32 GetToolNum() const;

 ClassID GetParentTool() const;
 
 int32 GetSubToolNum() const;
 
 RsrcID GetIconID();

 PluginID GetIconPluginID();
 

 void SetGroupNum(int32 newGroup);
 
 friend bool16 operator ==(const ToolRecord& a, const ToolRecord& b);

 private:
 UID fToolUID;
 int32 fGroupNum;
 int32 fToolNum;
 ClassID fParentTool;
 int32 fSubToolNum;
 RsrcID fIconID;
 PluginID fIconPluginID;
 
};


 bool16 ToolRecordCompare(const ToolRecord &toolRec1, const ToolRecord &toolRec2);
 bool16 SubToolRecordCompare(const ToolRecord &toolRec1, const ToolRecord &toolRec2);

#endif