sl@0: // Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies). sl@0: // All rights reserved. sl@0: // This component and the accompanying materials are made available sl@0: // under the terms of "Eclipse Public License v1.0" sl@0: // which accompanies this distribution, and is available sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html". sl@0: // sl@0: // Initial Contributors: sl@0: // Nokia Corporation - initial contribution. sl@0: // sl@0: // Contributors: sl@0: // sl@0: // Description: sl@0: // Key Event Routing Plug-in API sl@0: sl@0: /** sl@0: @file sl@0: @publishedPartner sl@0: @prototype sl@0: */ sl@0: sl@0: #ifndef WSKEYROUTER_H sl@0: #define WSKEYROUTER_H sl@0: sl@0: #include sl@0: #include sl@0: sl@0: /** sl@0: Interface Uid sl@0: */ sl@0: const TUid KKeyRouterPluginUid = { 0x102872e1 }; sl@0: sl@0: /** sl@0: Key Capture Type sl@0: */ sl@0: enum TKeyCaptureType sl@0: { sl@0: ECaptureTypeKey = 0, sl@0: ECaptureTypeLongKey = 1, sl@0: ECaptureTypeKeyUpDown = 2 sl@0: }; sl@0: sl@0: /** sl@0: Key Capture Request sl@0: */ sl@0: struct TKeyCaptureRequest sl@0: { sl@0: /** Capture type */ sl@0: TKeyCaptureType iType; sl@0: sl@0: /** Keycode or scancode to be captured */ sl@0: TUint iInputCode; sl@0: sl@0: /** Output keycode or scancode. When iInputCode is captured, RouteKey() sl@0: places iOutputCode in TKeyEventRouterOutput.iKeyEvent */ sl@0: TUint iOutputCode; sl@0: sl@0: /** Bitmask of modifier keys of interest. Key events are captured only sl@0: when the modifier keys specified by iModifierMask are in the states sl@0: specified by iModifiers */ sl@0: TUint iModifierMask; sl@0: sl@0: /** Bitmask of modifier key states */ sl@0: TUint iModifiers; sl@0: sl@0: /** Opaque handle for this request */ sl@0: TAny* iHandle; sl@0: sl@0: /** Opaque handle to window group through which request was made */ sl@0: TAny* iWindowGroup; sl@0: sl@0: /** Identifier of the window group through which request was made */ sl@0: TInt iWindowGroupId; sl@0: sl@0: /** UID of application that made the capture request */ sl@0: TUid iAppUid; sl@0: sl@0: /** Capture priority for this request. If more than one window group has sl@0: requested capture for the same key event, the one with the highest sl@0: priority will capture it (unless overridden by application specific sl@0: rules). */ sl@0: TInt iPriority; sl@0: sl@0: /** Reserved for future use */ sl@0: TInt iReserved[2]; sl@0: }; sl@0: sl@0: /** sl@0: Input parameters for RouteKey() sl@0: */ sl@0: struct TKeyEventRouterInput sl@0: { sl@0: inline TKeyEventRouterInput(TKeyCaptureType aType, const TKeyEvent& aKeyEvent, TAny* aFocusWindowGroup, TUid aFocusAppUid); sl@0: sl@0: /** Capture type */ sl@0: TKeyCaptureType iType; sl@0: sl@0: /** Input key event */ sl@0: TKeyEvent iKeyEvent; sl@0: sl@0: /** Opaque handle to current focussed window group */ sl@0: TAny* iFocusWindowGroup; sl@0: sl@0: /** UID of client application with current focussed window group */ sl@0: TUid iFocusAppUid; sl@0: sl@0: /** Reserved for future use */ sl@0: TInt iReserved[2]; sl@0: }; sl@0: sl@0: /** sl@0: Result codes for RouteKey() sl@0: */ sl@0: enum TKeyEventRouterResult sl@0: { sl@0: /** Key routed, no capture */ sl@0: ERouted = 0, sl@0: sl@0: /** Key captured and routed */ sl@0: ECaptured = 1, sl@0: sl@0: /** Key consumed, do not deliver event */ sl@0: EConsumed = 2 sl@0: }; sl@0: sl@0: /** sl@0: Output parameters for RouteKey() sl@0: */ sl@0: struct TKeyEventRouterOutput sl@0: { sl@0: /** Result code */ sl@0: TKeyEventRouterResult iResult; sl@0: sl@0: /** Output key event as translated by plug-in. Key code may be set by sl@0: RWindowGroup::CaptureLongKey() via TKeyCaptureRequest.iOutputCode **/ sl@0: TKeyEvent iKeyEvent; sl@0: sl@0: /** Opaque handle to destination window group or NULL if captured by WServ sl@0: (hotkey). Plug-in must set this to either the window group from the sl@0: matching capture request or to TKeyEventRouterInput.iFocusWindowGroup */ sl@0: TAny* iWindowGroup; sl@0: sl@0: /** Opaque handle from matching capture request or NULL if none */ sl@0: TAny* iCaptureHandle; sl@0: sl@0: /** Reserved for future use */ sl@0: TInt iReserved[2]; sl@0: }; sl@0: sl@0: /** sl@0: Key Event Router Interface sl@0: sl@0: This class is implemented by a plug-in DLL in order to perform customised sl@0: routing of window server key events. sl@0: sl@0: The Key Event Routing plug-in is a polymorphic DLL that implements the sl@0: CKeyEventRouter interface. Its UID1 and UID2 must be KDynamicLibraryUid and sl@0: KKeyRouterPluginUid respectively. UID3 identifies a particular implementation sl@0: of the plug-in. The first and only exported function should create and return sl@0: an object of the CKeyEventRouter sub-class. sl@0: */ sl@0: class CKeyEventRouter : public CBase sl@0: { sl@0: public: sl@0: /** sl@0: Create and return an instance of CKeyEventRouter sl@0: sl@0: @return Pointer to new router instance sl@0: */ sl@0: IMPORT_C static CKeyEventRouter* NewL(); sl@0: sl@0: /** sl@0: Add a new key capture request sl@0: sl@0: @param aRequest Capture request details sl@0: */ sl@0: virtual void AddCaptureKeyL(const TKeyCaptureRequest& aRequest) = 0; sl@0: sl@0: /** sl@0: Update an existing key capture request sl@0: sl@0: @param aRequest Updated capture request details sl@0: */ sl@0: virtual void UpdateCaptureKeyL(const TKeyCaptureRequest& aRequest) = 0; sl@0: sl@0: /** sl@0: Cancel a key capture request sl@0: sl@0: @param aType Capture type sl@0: @param aHandle Opaque handle of request to be cancelled sl@0: */ sl@0: virtual void CancelCaptureKey(TKeyCaptureType aType, TAny* aHandle) = 0; sl@0: sl@0: /** sl@0: Route the key event described by aInput and return its destination sl@0: in iOutput. sl@0: sl@0: @param aInput Input data with key event to be routed sl@0: @param aOutput Output key event and routing results sl@0: */ sl@0: virtual void RouteKey(const TKeyEventRouterInput& aInput, sl@0: TKeyEventRouterOutput& aOutput) = 0; sl@0: sl@0: /** sl@0: Reserved for future use sl@0: */ sl@0: private: sl@0: virtual void Reserved1() {}; sl@0: virtual void Reserved2() {}; sl@0: }; sl@0: sl@0: inline TKeyEventRouterInput::TKeyEventRouterInput(TKeyCaptureType aType, const TKeyEvent& aKeyEvent, TAny* aFocusWindowGroup, TUid aFocusAppUid) : iType(aType), iKeyEvent(aKeyEvent), iFocusWindowGroup(aFocusWindowGroup), iFocusAppUid(aFocusAppUid) sl@0: { sl@0: } sl@0: sl@0: #endif // WSKEYROUTER_H