williamr@2: /*
williamr@2: * Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@2: * under the terms of the License "Eclipse Public License v1.0"
williamr@2: * which accompanies this distribution, and is available
williamr@2: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description:  Handle softkeys updates
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: #ifndef BRCTLSOFTKEYSOBSERVER_H
williamr@2: #define BRCTLSOFTKEYSOBSERVER_H
williamr@2: 
williamr@2: //  INCLUDES
williamr@2: #include <e32std.h>
williamr@2: #include <e32base.h>
williamr@2: 
williamr@2: /**
williamr@2: * Identifies which softkey is to be used
williamr@2: */
williamr@2: enum TBrCtlKeySoftkey
williamr@2:     {
williamr@2:     EKeyRight, ///< Use the right softkey
williamr@2:     EKeyLeft   ///< Use the left softkey
williamr@2:     };
williamr@2: 
williamr@2: enum TBrCtlSoftkeyChangeReason
williamr@2:     {
williamr@2:     EChangeReasonElementType,
williamr@2:     EChangeReasonLoad,
williamr@2:     EChangeReasonIdle
williamr@2:     };
williamr@2: 
williamr@2: /**
williamr@2: * The MBrCtlSoftkeysObserver class handles requests to change the softkeys. 
williamr@2: *
williamr@2: * Usage:
williamr@2: *
williamr@2: * @code
williamr@2: *  #include <BrCtlSoftkeysObserver.h>
williamr@2: *
williamr@2: *  
williamr@2: * @see S60 Platform: Browser Control API Developer's Guide Version 2.0
williamr@2: * @lib BrowserEngine.lib
williamr@2: * @file BrCtlSoftkeysObserver.h
williamr@2: * @endcode     *
williamr@2: */
williamr@2: class MBrCtlSoftkeysObserver
williamr@2:     {
williamr@2:     public: // New functions
williamr@2:         
williamr@2:         /**
williamr@2:         * Requests the host application to change a softkey. 
williamr@2:         * The host application may or may not change the softkey.
williamr@2:         * @since 2.8
williamr@2:         * @param aKeySoftkey Determines whether to update the left softkey or the right softkey.
williamr@2:         * Values:
williamr@2:         * EKeyRight to update the right softkey
williamr@2:         * EKeyLeft to update the left softkey
williamr@2:         * @param aLabel The label associated with the softkey update
williamr@2:         * @param aCommandId The command to use if the softkey is selected by the user
williamr@2:         * @param aBrCtlSoftkeyChangeReason Reason for the softkey change 
williamr@2:         * Value: EChangeReasonIdle (The other values are reserved for future use.)
williamr@2:         * @return void
williamr@2:         */
williamr@2:         virtual void UpdateSoftkeyL(TBrCtlKeySoftkey aKeySoftkey,
williamr@2:                                     const TDesC& aLabel,
williamr@2:                                     TUint32 aCommandId,
williamr@2:                                     TBrCtlSoftkeyChangeReason aBrCtlSoftkeyChangeReason) = 0;
williamr@2:     };
williamr@2: 
williamr@2: #endif      // BRCTLSOFTKEYSOBSERVER_H   
williamr@2:             
williamr@2: // End of File