1.1 --- a/epoc32/include/mw/brctlsoftkeysobserver.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/mw/brctlsoftkeysobserver.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,82 @@
     1.4 -brctlsoftkeysobserver.h
     1.5 +/*
     1.6 +* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* under the terms of the License "Eclipse Public License v1.0"
    1.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description:  Handle softkeys updates
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +
    1.23 +#ifndef BRCTLSOFTKEYSOBSERVER_H
    1.24 +#define BRCTLSOFTKEYSOBSERVER_H
    1.25 +
    1.26 +//  INCLUDES
    1.27 +#include <e32std.h>
    1.28 +#include <e32base.h>
    1.29 +
    1.30 +/**
    1.31 +* Identifies which softkey is to be used
    1.32 +*/
    1.33 +enum TBrCtlKeySoftkey
    1.34 +    {
    1.35 +    EKeyRight, ///< Use the right softkey
    1.36 +    EKeyLeft   ///< Use the left softkey
    1.37 +    };
    1.38 +
    1.39 +enum TBrCtlSoftkeyChangeReason
    1.40 +    {
    1.41 +    EChangeReasonElementType,
    1.42 +    EChangeReasonLoad,
    1.43 +    EChangeReasonIdle
    1.44 +    };
    1.45 +
    1.46 +/**
    1.47 +* The MBrCtlSoftkeysObserver class handles requests to change the softkeys. 
    1.48 +*
    1.49 +* Usage:
    1.50 +*
    1.51 +* @code
    1.52 +*  #include <BrCtlSoftkeysObserver.h>
    1.53 +*
    1.54 +*  
    1.55 +* @see S60 Platform: Browser Control API Developer's Guide Version 2.0
    1.56 +* @lib BrowserEngine.lib
    1.57 +* @file BrCtlSoftkeysObserver.h
    1.58 +* @endcode     *
    1.59 +*/
    1.60 +class MBrCtlSoftkeysObserver
    1.61 +    {
    1.62 +    public: // New functions
    1.63 +        
    1.64 +        /**
    1.65 +        * Requests the host application to change a softkey. 
    1.66 +        * The host application may or may not change the softkey.
    1.67 +        * @since 2.8
    1.68 +        * @param aKeySoftkey Determines whether to update the left softkey or the right softkey.
    1.69 +        * Values:
    1.70 +        * EKeyRight to update the right softkey
    1.71 +        * EKeyLeft to update the left softkey
    1.72 +        * @param aLabel The label associated with the softkey update
    1.73 +        * @param aCommandId The command to use if the softkey is selected by the user
    1.74 +        * @param aBrCtlSoftkeyChangeReason Reason for the softkey change 
    1.75 +        * Value: EChangeReasonIdle (The other values are reserved for future use.)
    1.76 +        * @return void
    1.77 +        */
    1.78 +        virtual void UpdateSoftkeyL(TBrCtlKeySoftkey aKeySoftkey,
    1.79 +                                    const TDesC& aLabel,
    1.80 +                                    TUint32 aCommandId,
    1.81 +                                    TBrCtlSoftkeyChangeReason aBrCtlSoftkeyChangeReason) = 0;
    1.82 +    };
    1.83 +
    1.84 +#endif      // BRCTLSOFTKEYSOBSERVER_H   
    1.85 +            
    1.86 +// End of File