ITool.h

//========================================================================================
// 
// $File$
// 
// Owner: EricM,Frits
// 
// $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 __ITOOL__
#define __ITOOL__

#include "PMTypes.h"
#include "IPMUnknown.h"
#include "ShuksanID.h"

class IEventHandler;
class PMString;
class IPanelControlData;
class ICursorProvider;

class ITool: public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_ITOOL };
 
 enum ToolType
 { 
 kNone = 0,
 kLayoutSelectionTool = 1,
 kTextSelectionTool = 2,
 kTableSelectionTool = 4,
 kLayoutManipulationTool = 8,
 kTextManipulationTool = 16,
 kTableManipulationTool = 32,
 kLayoutCreationTool = 64,
 kTextCreationTool = 128,
 kTableCreationTool = 256,
 kPathManipulationTool = 512,
 kViewModificationTool = 1024,
 kJGridTool = 2048,
 kPageSelectionTool = 4096
 };

 virtual void Init(RsrcID iconID, const PluginID& pluginID) = 0;
 
 virtual void Select() = 0;
 
 virtual void Deselect() = 0;

 virtual bool IsSelected() = 0;
 
 
 virtual ICursorProvider* GetCursorProvider() const = 0;

 virtual void SetCursorProvider(ICursorProvider* newProvider) = 0;
 
 virtual const PMString& GetName() const = 0;
 virtual void SetName(const PMString& newName) = 0;
 
 virtual const PMString& GetToolHint() const = 0;
 virtual void SetToolHint(const PMString& newHint) = 0;
 
 virtual const IDFile& GetToolIconFile() const = 0;

 //
 virtual ActionID GetActionID() const = 0; 
 
 virtual void SetActionID(ActionID actionID) = 0;
 
 virtual const ClassID& GetToolType() const= 0;

 virtual void SetToolType(const ClassID& newToolType) = 0;

 
 virtual void DisplayOptions() = 0;
 
 virtual void DisplayAltOptions() = 0;
 
 
 virtual bool16 IsCreationTool() const = 0;
 
 
 virtual bool16 IsSelectionTool() const = 0;

 
 virtual bool16 IsTextTool() const = 0;

 
 virtual bool16 IsToolOfType(ITool::ToolType type) const = 0;
 
 virtual ScriptID GetScriptID() const = 0;

 virtual bool16 IsToolNone() const = 0;
};


#endif