IKeyBoard.h

//========================================================================================
// 
// $File$
// 
// Owner: Robin_Briggs
// 
// $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.
// 
// 
// The keyboard is the keeper of the key focus. An event handler must
// aquire the key focus in order to get key events.
// 
//========================================================================================

#ifndef __IKEYBOARD__
#define __IKEYBOARD__

#include "IPMUnknown.h"

class IEventHandler;
class IWindow;

class IKeyBoard : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IKEYBOARD };

 virtual bool16 AcquireKeyFocus(IEventHandler *newKeyFocus, bool16 validate = kTrue) = 0;
 
 virtual bool16 RelinquishKeyFocus(bool16 validate = kTrue) = 0;
 
 virtual bool16 RelinquishKeyFocusForWindow(IWindow* window, bool16 validate = kTrue) = 0;
 
 virtual void RemoveEventHandlersForWindow(IWindow* window) = 0;

 virtual IEventHandler* GetKeyFocus() const = 0;

 virtual void RememberLastEditboxKeyFocusInPalette(IEventHandler* eh) = 0;

 virtual bool16 RestoreLastEditboxKeyFocusInPalette() = 0;

 virtual void AppSuspend() = 0;

 virtual void AppResume() = 0;

 virtual bool16 ValidateCurrentKeyFocus() = 0;

 virtual void OpenExternalModalWindow(bool isDVAOwnedWindow = false) = 0;

 virtual void ExternalModalWindowClosed() = 0;

#ifdef WINDOWS 

 virtual void GetScriptAndCodePage(int32& outWritingScript, int32& outCodePage) const = 0;
#endif

};

#endif // __IKEYBOARD__