InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IKBSCData Class Referenceabstract

#include <IKBSCData.h>

Inheritance diagram for IKBSCData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IKBSCDATA }
 

Public Member Functions

virtual void SetKey (const PMString &context, const VirtualKey &key, int16 mods)=0
 
virtual PMString GetContext () const =0
 
virtual VirtualKey GetKey () const =0
 
virtual int16 GetMods () const =0
 
virtual void Clear ()=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Interface for maintaining info about a shortcut. This is used to pass data about a selected shortcut in the shortcut editor, so the delete button knows which shortcut to delete.

Member Function Documentation

virtual void IKBSCData::Clear ()
pure virtual

Clear out all the data

virtual PMString IKBSCData::GetContext () const
pure virtual

Get a copy of the context string

Returns
context string
virtual VirtualKey IKBSCData::GetKey () const
pure virtual

Get a copy of the key for this shortcut

Returns
key
virtual int16 IKBSCData::GetMods () const
pure virtual

Get the modifiers for this shortcut.

See Also
KBSCModifierDefs.h
Returns
modifiers
virtual void IKBSCData::SetKey (const PMStringcontext,
const VirtualKeykey,
int16 mods 
)
pure virtual

Set the new shortcut info

Parameters
contextwhich context this shortcut will be active in
See Also
IShortcutManager.h
Parameters
keythe key for this shortcut
modsthe modifier keys for this shortcut.
See Also
KBSCModifierDefs.h