1 /*

     2 * Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of the License "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  Handle softkeys updates

    15 *

    16 */

    17 

    18 

    19 #ifndef BRCTLSOFTKEYSOBSERVER_H

    20 #define BRCTLSOFTKEYSOBSERVER_H

    21 

    22 //  INCLUDES

    23 #include <e32std.h>

    24 #include <e32base.h>

    25 

    26 /**

    27 * Identifies which softkey is to be used

    28 */

    29 enum TBrCtlKeySoftkey

    30     {

    31     EKeyRight, ///< Use the right softkey

    32     EKeyLeft   ///< Use the left softkey

    33     };

    34 

    35 enum TBrCtlSoftkeyChangeReason

    36     {

    37     EChangeReasonElementType,

    38     EChangeReasonLoad,

    39     EChangeReasonIdle

    40     };

    41 

    42 /**

    43 * The MBrCtlSoftkeysObserver class handles requests to change the softkeys. 

    44 *

    45 * Usage:

    46 *

    47 * @code

    48 *  #include <BrCtlSoftkeysObserver.h>

    49 *

    50 *  

    51 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0

    52 * @lib BrowserEngine.lib

    53 * @file BrCtlSoftkeysObserver.h

    54 * @endcode     *

    55 */

    56 class MBrCtlSoftkeysObserver

    57     {

    58     public: // New functions

    59         

    60         /**

    61         * Requests the host application to change a softkey. 

    62         * The host application may or may not change the softkey.

    63         * @since 2.8

    64         * @param aKeySoftkey Determines whether to update the left softkey or the right softkey.

    65         * Values:

    66         * EKeyRight to update the right softkey

    67         * EKeyLeft to update the left softkey

    68         * @param aLabel The label associated with the softkey update

    69         * @param aCommandId The command to use if the softkey is selected by the user

    70         * @param aBrCtlSoftkeyChangeReason Reason for the softkey change 

    71         * Value: EChangeReasonIdle (The other values are reserved for future use.)

    72         * @return void

    73         */

    74         virtual void UpdateSoftkeyL(TBrCtlKeySoftkey aKeySoftkey,

    75                                     const TDesC& aLabel,

    76                                     TUint32 aCommandId,

    77                                     TBrCtlSoftkeyChangeReason aBrCtlSoftkeyChangeReason) = 0;

    78     };

    79 

    80 #endif      // BRCTLSOFTKEYSOBSERVER_H   

    81             

    82 // End of File