IShortcutUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Bernd Paradies
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __IShortcutUtils__
#define __IShortcutUtils__

#include "AppFrameworkID.h"
#include "IPMUnknown.h"
#include "Utils.h"

#include "VirtualKey.h"

class IWorkspace;
class IShortcutContext;
class IEvent;

class IShortcutUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ISHORTCUTUTILS };


 virtual PMString GetShortcutString(ActionID id, bool16 bAddContextStr = kFalse, const bool bGetOnlyOne = false) = 0;
 virtual PMString GetShortcutString(const VirtualKey& key, int16 mods, const bool& shouldTranslate = true) = 0;

 virtual void ParseShortcutString(const PMString& shortcutStr, VirtualKey *keyOut, int16 *modsOut, const bool& shouldTranslate = false) = 0; 
 
 virtual UID FindShortcutStyle(IWorkspace *ws, const VirtualKey& key, int16 mods, ClassID *whichStrand) = 0;

 virtual int16 GetEventModifiersForKBSC(const IEvent* pEvent, VirtualKey& vkey) = 0;

 virtual IShortcutContext* QueryCurrentContext() = 0;
 
 virtual bool16 IsEnabledShortcut(const IEvent* e) = 0; 
 
 virtual bool16 GetNumLockStatus() const= 0;

 virtual void SetNumLockStatus(bool16 bStatus) = 0;
};


#endif // __IShortcutUtils__