ToolInfo.h

//========================================================================================
// 
// $File$
// 
// Owner: Yeming Liu
// 
// $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 __TOOLINFO__
#define __TOOLINFO__

typedef enum { kNonePriority = -1, kLowPriority = 0, kMediumPriority, kHighPriority } ToolInfoPriority;

class NonSelectionToolInfo
{
 public:
 typedef object_type data_type;

 NonSelectionToolInfo() : fPriority(kNonePriority) {}

 /* Contruct object with given values.
 @param toolType IN ClassID for tool.
 @param protocol IN protocol when there is no selection.
 @param widgetID IN widgetID for the panel when there is no selection.
 @param priority IN determine which panel should be loaded if one tool has multiple panels associated with. 
 */
 NonSelectionToolInfo
 (
 const ClassID& toolType, 
 const PMIID& protocol, 
 const WidgetID& widgetID, 
 const ToolInfoPriority priority
 ):fToolType(toolType),
 fProtocol(protocol),
 fWidgetID(widgetID), 
 fPriority(priority) { }
 
 bool16 operator==(const NonSelectionToolInfo& other) const
 { 
 return ( (fToolType == other.fToolType) && 
 (fProtocol == other.fProtocol) && 
 (fWidgetID == other.fWidgetID) && 
 (fPriority == other.fPriority) ); 
 }

 ClassID fToolType;

 PMIID fProtocol;

 WidgetID fWidgetID;

 ToolInfoPriority fPriority;
};

class SelectionToolInfo
{
 public:
 typedef object_type data_type;

 SelectionToolInfo() : fSelectionPriority(kNonePriority), fNonSelectionPriority(kNonePriority) {}

 SelectionToolInfo
 (
 const ClassID& toolType, // class ID for tool
 const PMIID& selectionProtocol, // protocol when there is selection
 const PMIID& nonSelectionProtocol, // protocol when there is no selection
 const WidgetID& selectionWidgetID, // widgetID for the panel when there is selection
 const WidgetID& nonSelectionWidgetID, // widgetID for the panel when there is no selection
 const ToolInfoPriority selectionPriority, // priority as to display the panel when there is selection
 const ToolInfoPriority nonSelectionPriority // priority as to display the panel when there is no selection
 ):fToolType(toolType),
 fSelectionProtocol(selectionProtocol),
 fNonSelectionProtocol(nonSelectionProtocol),
 fSelectionWidgetID(selectionWidgetID),
 fNonSelectionWidgetID(nonSelectionWidgetID), 
 fSelectionPriority(selectionPriority),
 fNonSelectionPriority(nonSelectionPriority) { }
 
 bool16 operator==(const SelectionToolInfo& other) const
 { 
 return ( (fToolType == other.fToolType) && 
 (fSelectionProtocol == other.fSelectionProtocol) &&
 (fNonSelectionProtocol == other.fNonSelectionProtocol) && 
 (fSelectionWidgetID == other.fSelectionWidgetID) && 
 (fNonSelectionWidgetID == other.fNonSelectionWidgetID) && 
 (fSelectionPriority == other.fSelectionPriority) && 
 (fNonSelectionPriority == other.fNonSelectionPriority) ); 
 }

 ClassID fToolType;
 PMIID fSelectionProtocol;
 PMIID fNonSelectionProtocol;
 WidgetID fSelectionWidgetID;
 WidgetID fNonSelectionWidgetID;
 ToolInfoPriority fSelectionPriority;
 ToolInfoPriority fNonSelectionPriority;
};

#endif //__TOOLINFO__