S60 3rd Edition SDK for Symbian OS
Example Applications Guide

BrCtlSampleAppSoftKeysObserver.h

00001 /*
00002 * ==============================================================================
00003 *  Name        : BrCtlSampleAppSoftkeysObserver.h
00004 *  Part of     : Browser Engine
00005 *  Interface   : Browser Control API
00006 *  Description : Handle soft key events
00007 *  Version     : 
00008 *
00009 *  Copyright (c) 2005-2006 Nokia Corporation.
00010 *  This material, including documentation and any related 
00011 *  computer programs, is protected by copyright controlled by 
00012 *  Nokia Corporation.
00013 * ==============================================================================
00014 */
00015 
00016 
00017 #ifndef BRCTLSAMPLEAPPSOFTKEYSOBSERVER_H
00018 #define BRCTLSAMPLEAPPSOFTKEYSOBSERVER_H
00019 
00020 // INCLUDES
00021 #include <BrCtlSoftkeysObserver.h>
00022 #include <BrCtlInterface.h>
00023 
00024 // FORWARD DECLARATIONS 
00025 class CBrCtlSampleAppContainer;
00026 
00027 // CLASS DECLARATION
00028 
00029 /**
00030 * CBrCtlSampleAppSoftkeysObserver class.
00031 * This class inherits from the MBrCtlSoftkeysObserver interface that handles requests 
00032 * from the Browser Control to change the softkeys. 
00033 */
00034 class CBrCtlSampleAppSoftkeysObserver : public CBase, public MBrCtlSoftkeysObserver
00035     {
00036     public:  // Constructors and destructor
00037 
00038         /**
00039         * Two-phased constructor.
00040         */
00041         static CBrCtlSampleAppSoftkeysObserver* NewL(CBrCtlSampleAppContainer* aContainer);
00042 
00043         /**
00044         * Destructor.
00045         */
00046         ~CBrCtlSampleAppSoftkeysObserver();
00047        
00048         /**
00049         * Browser Control requests to update a softkey
00050         * @since 2.8
00051         * @param aKeySoftkey Update the left softkey or the right softkey
00052         * @param aLabel The label associated with the softkey update
00053         * @param aCommandId The command to use if the softkey is selected by the user
00054         * @param aBrCtlSoftkeyChangeReason The reason for the softkey change
00055         * @return void
00056         */
00057         void UpdateSoftkeyL(TBrCtlKeySoftkey /*aKeySoftkey*/,
00058                             const TDesC& /*aLabel*/,
00059                             TUint32 /*aCommandId*/,
00060                             TBrCtlSoftkeyChangeReason /*aBrCtlSoftkeyChangeReason*/) ;
00061 
00062     private:
00063             /**
00064         * By default Symbian 2nd phase constructor is private.
00065         */
00066         void ConstructL(CBrCtlSampleAppContainer* aContainer);
00067 
00068 
00069     private:   // data
00070         // Pointer to the container class associated with this observer
00071         CBrCtlSampleAppContainer* iContainer;
00072     };
00073 
00074 #endif      // BRCTLSAMPLEAPPSOFTKEYSOBSERVER_H
00075             
00076 // End of File
00077 

© Nokia 2006

Back to top