InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
SnapTool Class Reference
Inheritance diagram for SnapTool:
CToolIToolIPMUnknown

Public Member Functions

 SnapTool (IPMUnknown *boss)
 
virtual void Init (RsrcID iconID, const PluginID &pluginID)
 
void DisplayOptions ()
 
virtual ScriptID GetScriptID () const
 
- Public Member Functions inherited from CTool
 CTool (IPMUnknown *boss)
 
 CTool (IPMUnknown *boss, int32 toolInfo, bool16 isCreation, bool16 isSelection)
 
virtual void ReadWrite (IPMStream *s, ImplementationID prop)
 
virtual void InitWidget (const WidgetID &widgetId, RsrcID iconID, const PluginID &pluginID, PMRect toolRect=kStandardToolRect)
 
virtual void Select ()
 
virtual void Deselect ()
 
virtual bool IsSelected ()
 
virtual ICursorProviderGetCursorProvider () const
 
virtual void SetCursorProvider (ICursorProvider *newProvider)
 
virtual bool16 IsCreationTool () const
 
virtual bool16 IsSelectionTool () const
 
virtual bool16 IsTextTool () const
 
virtual const PMStringGetName () const
 
virtual void SetName (const PMString &newName)
 
virtual const PMStringGetToolHint () const
 
virtual void SetToolHint (const PMString &newHint)
 
virtual const IDFileGetToolIconFile () const
 
virtual const ClassIDGetToolType () const
 
virtual void SetToolType (const ClassID &newToolType)
 
virtual ActionID GetActionID () const
 
virtual void SetActionID (ActionID action)
 
virtual void DisplayAltOptions ()
 
virtual bool16 IsToolOfType (ITool::ToolType toolInformation) const
 
virtual bool16 IsToolNone () const
 

Additional Inherited Members

- Public Types inherited from ITool
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
}
 
- Protected Member Functions inherited from CTool
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)
 
- Protected Attributes inherited from CTool
ICursorProviderfCursorProvider
 
bool16 fIsCreation
 
bool16 fIsSelection
 
ClassID fToolType
 
int32 fToolInformation
 
bool fSelected
 

Detailed Description

The SnapTool's ITool implementation based on the partial implementation of CTool.

Constructor & Destructor Documentation

SnapTool::SnapTool (IPMUnknownboss)

Constructor for the SnapTool

Member Function Documentation

void SnapTool::DisplayOptions ()
virtual

Display a dialog

Reimplemented from CTool.

ScriptID SnapTool::GetScriptID () const
virtual

Returns a ScriptID that identifies the tool.

Reimplemented from CTool.

void SnapTool::Init (RsrcID iconID,
const PluginIDpluginID 
)
virtual

Set the tool's name and initialise the tool's button widget

Reimplemented from CTool.