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

#include <IToolToggleBehavior.h>

Inheritance diagram for IToolToggleBehavior:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ITOOLTOGGLEBEHAVIOR }
 

Public Member Functions

virtual bool16 IsPointerToolToggleEnabled (uint16 currentModifiers) 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 to allow a plugin to override the toggling of a third party tool to the pointer tool. By default, all tools will toggle to the most recent selection tool (pointer tool or direct select tool) if the Cmd key is down. By implementing this interface for your tool, you can disable this behavior.

Member Function Documentation

virtual bool16 IToolToggleBehavior::IsPointerToolToggleEnabled (uint16 currentModifiers) const
pure virtual

IsPointerToolToggleEnabled Does this tool toggle to the most recent selection tool?

Parameters
currentModifierswhich modifier keys are currently pressed.
See Also
KBSCModifierDefs.h
Returns
True if the tool toggles to the pointer selection tool if the Cmd key is down.