CTool.h

//========================================================================================
// 
// $File$
// 
// Owner: EricM
// 
// $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.
// 
// 
// Updated: Frits - Rewrite for widget architecture
// 
// Helper class for implementing the ITool interface.
// 
//========================================================================================

#ifndef __CTool__
#define __CTool__

#include "ITool.h"
#include "HelperInterface.h"
#include "PMString.h"
#include "PMRect.h"
#include "ScriptingDefs.h"
#include "IControlView.h"

#ifdef WIDGET_BUILD
#endif
const PMReal kOneToolIconWidth = 30.0;
const PMReal koneToolIconHeight = 24.0;
const PMRect kStandardToolRect(0,0,kOneToolIconWidth,koneToolIconHeight);
const PMRect kMiniToolRect(0,0, 20,20);
const PMRect kMiddleMiniToolRect(0,0,20,20);


class CTool: public ITool
{
 public:
 CTool(IPMUnknown *boss);
 CTool(IPMUnknown *boss, int32 toolInfo, bool16 isCreation, bool16 isSelection);
 ~CTool();
 
 virtual void ReadWrite(IPMStream* s, ImplementationID prop);
 
 virtual void Init(RsrcID iconID, const PluginID& pluginID);
 
 virtual void InitWidget(const WidgetID& widgetId, RsrcID iconID, const PluginID& pluginID, PMRect toolRect = kStandardToolRect);
 
 virtual void Select();

 virtual void Deselect();

 virtual bool IsSelected();

 virtual ICursorProvider* GetCursorProvider() const;

 virtual void SetCursorProvider(ICursorProvider* newProvider);
 
 virtual bool16 IsCreationTool() const;

 virtual bool16 IsSelectionTool() const;

 virtual bool16 IsTextTool() const;

 virtual const PMString& GetName() const;

 virtual void SetName(const PMString& newName);
 
 virtual const PMString& GetToolHint() const;

 virtual void SetToolHint(const PMString& newHint);
 
 virtual const IDFile& GetToolIconFile() const;

 virtual const ClassID& GetToolType() const;

 virtual void SetToolType(const ClassID& newToolType);

 virtual ActionID GetActionID() const; 

 virtual void SetActionID(ActionID action);
 
 virtual void DisplayOptions();

 virtual void DisplayAltOptions();

 virtual bool16 IsToolOfType(ITool::ToolType toolInformation) const;
 
 virtual ScriptID GetScriptID() const { ASSERT_UNIMPLEMENTED(); return en_None; }

 virtual bool16 IsToolNone() const;
 
 protected:
 ICursorProvider* fCursorProvider;
 bool16 fIsCreation;
 bool16 fIsSelection;
 ClassID fToolType;
 int32 fToolInformation; // bit field containing the information about what tool type this is
 bool fSelected;
 virtual PMString BuildHintString(PMString& theDescriptionString, PMString& theShiftHint, PMString& theCommandCtrlHint, PMString& theOptionAltHint, PMString& theArrowsHint, PMString& extrasString);
 virtual PMString BuildHintString(PMString& theDescriptionString, PMString& theShiftHint, PMString& theCommandCtrlHint, PMString& theOptionAltHint, PMString& theArrowsHint, K2Vector<PMString>& theExtraModifiersHint, PMString& extrasString);
 
 private:
 ActionID fActionID;
 PMString fName;
 PMString fToolHint;
 IDFile fToolIconFile;
 int32 fIconID;


};


#endif