IShortcutManager.h

//========================================================================================
// 
// $File$
// 
// Owner: lance bushore
// 
// $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 __IShortcutManager__
#define __IShortcutManager__

#include "IPMUnknown.h"
#include "VirtualKey.h"
#include "PMString.h"
#include "ActionID.h"
#include "IKBSCSetsManager.h"

class IShortcutContext;
class IShortcutManager : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_ISHORTCUTMANAGER };

 virtual void AddShortcut(ActionID actionToAddTo, const PMString & contextStr, const VirtualKey& key, int16 mods) = 0;

 virtual void RemoveAllShortcutsForAction(ActionID id) = 0;
 
 virtual void RemoveShortcut(const PMString& context, const VirtualKey& key, int16 mods) = 0;

 virtual void PerformShortcut(const IShortcutContext* context, const VirtualKey& key, int16 mods) = 0;
 
 virtual bool16 IsEnabledShortcut(const IShortcutContext* context, const VirtualKey& key, int16 mods) = 0;

 virtual ActionID GetActionIDOfShortcut(const PMString& contextString, const VirtualKey& key, int16 mods) const = 0;
 
 virtual ActionID GetActionIDInContextChain(const IShortcutContext* context, const VirtualKey& key, int16 mods) const = 0;

 virtual void ClearShortcuts() = 0;

 virtual int32 GetNumShortcutsForAction(ActionID actionID) const = 0;
 
 virtual void GetNthShortcutForAction(ActionID actionID, int32 index, PMString* contextStrOut, VirtualKey* keyOut, int16* modsOut) const = 0;

 virtual int32 GetNumShortcutContexts() const = 0;
 
 virtual IShortcutContext* QueryNthShortcutContext(int32 index) const = 0;
 
 virtual IShortcutContext* QueryShortcutContextByName(const PMString& contextName) const = 0;

 virtual PMString GetShortcutSetFilename() const = 0;

 virtual IKBSCSetsManager::KBSCArea GetShortcutKBSCArea() const = 0;

 typedef enum {
 kKBSCFileNoError = 0, 
 kKBSCFileNotFound, 
 kKBSCFileWrongPlatform, 
 kKBSCFileFormatWrongOrCorrupt, 
 kKBSCFileFormatIncompatible,
 kKBSCFileWriteError
 } ShortcutFileError; 
 
 virtual ShortcutFileError ChangeShortcutSetFile(const PMString& filename, IKBSCSetsManager::KBSCArea area) = 0;
 
 virtual ShortcutFileError SaveCurrentShortcutSetFile() = 0;

 virtual ShortcutFileError LoadDefaultShortcutSetFile(const PMLocaleId& locale) = 0;

 virtual void GetCurrentShortcut(PMString* contextOut, VirtualKey* keyOut, int16* modsOut) const = 0;

 virtual const PMString& GetPersistedActionName( const ActionID& actionID ) const = 0 ;

 virtual bool16 Startup(const PMLocaleId& locale) = 0;
 
 virtual void Shutdown(const PMLocaleId& locale) = 0;

#ifdef DEBUG
 typedef enum { contextInfo, allShortcutInfo, shortcutsMissingActions} ShortcutInfoType;
 virtual void DumpShortcutInfo(ShortcutInfoType infoType) = 0;
 virtual void RemoveAllShortcutsForUnregisteredActionIDs() = 0;
#endif
};

#endif // __IShortcutManager__