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

#include <INamedGridInfo.h>

Inheritance diagram for INamedGridInfo:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_INAMEDGRIDINFO }
 

Public Member Functions

virtual const PMString GetName () const =0
 
virtual void SetName (const PMString &s, bool16 translatable=kFalse)=0
 
virtual void SetKeyboardShortcut (uint16 virtualKey, int16 modifiers)=0
 
virtual uint16 GetKeyboardShortcut (int16 *modifiers) const =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

Data interface for the non grid data parts of a named grid.

Member Function Documentation

virtual uint16 INamedGridInfo::GetKeyboardShortcut (int16 * modifiers) const
pure virtual

Get the keyboard shortcut that triggers this named grid.

Parameters
modifiersMAY NOT BE NIL.
Returns
the key code.
virtual const PMString INamedGridInfo::GetName () const
pure virtual

Returns the name of the named grid.

virtual void INamedGridInfo::SetKeyboardShortcut (uint16 virtualKey,
int16 modifiers 
)
pure virtual

Set the keyboard shortcut that triggers this named grid.

Parameters
virtualKeyis the key code.
modifiersare the modifier keys.
See Also
KeyboardDefs.h
virtual void INamedGridInfo::SetName (const PMStrings,
bool16 translatable = kFalse 
)
pure virtual
Sets the name of the named grid.

Parameters
sIN The new name of the named grid.
translatableIN Is this string translatable.