InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
IToolCmdData Class Referenceabstract

#include <IToolCmdData.h>

Inheritance diagram for IToolCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ITOOLCMDDATA }
 

Public Member Functions

virtual void Set (ITool *theTool, ClassID toolType)=0
 
virtual ITool * GetTool () const =0
 
virtual ClassID GetToolType () const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Interface responsible for maintaining data for tool cmds

Member Function Documentation

virtual ITool* IToolCmdData::GetTool () const
pure virtual

Get the tool for the command.

Returns
the tool for this command
virtual ClassID IToolCmdData::GetToolType () const
pure virtual

Get the tool type for the command. Tool type is used to identify mutually exclusive tools. The traditional tools in the toolbox are all of type 'kPointerToolBoss'

Returns
the tool type
virtual void IToolCmdData::Set (ITool * theTool,
ClassID toolType 
)
pure virtual

Set the data for the tool cmd

Parameters
theToolwhich tool to use for this command.
toolTypethe tool type for the command. Tool type is used to identify mutually exclusive tools. The traditional tools in the toolbox are all of type 'kPointerToolBoss'