1 /*

     2 * Copyright (c) 2002-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 "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: 

    15 *     This class defines the data model interface for CVRViewContainer.

    16 *

    17 */

    18 

    19 

    20 #ifndef __MVRDECORATORMODEL_H__

    21 #define __MVRDECORATORMODEL_H__

    22 

    23 // INCLUDES

    24 #include <e32def.h>

    25 #include <bldvariant.hrh>

    26 

    27 // FORWARD DECLARATIONS

    28 class MVRObserver;

    29 class TCoeHelpContext;

    30 

    31 // ENUMERATIONS

    32 enum TVRVolumeControlState{ EDisabled, EIhf, EEarPiece };

    33 

    34 // CLASS DEFINITION

    35 /**

    36 * This class defines the data model interface for CVRViewContainer.

    37 */

    38 class MVRDecoratorModel

    39 	{

    40 	public: // new methods

    41 

    42 		/**

    43 		* Returns the resource id for current softkeys

    44 		* @return Softkey resource identifier

    45 		*/

    46 		virtual TInt CbaResourceId() const = 0;

    47 

    48 		/**

    49 		* Returns the resource id for current menu bar

    50 		* @return Menu bar resource identifier.

    51 		*/

    52 		virtual TInt MenuBarResourceId() const = 0;

    53 

    54 		/**

    55 		* Used to get the state of the volume control component.

    56 		*/

    57 		virtual void GetVolumeControlState( TVRVolumeControlState& aState,

    58 											TInt& aVolume ) = 0;

    59 		/**

    60 		* Specifies the current help context.

    61 		* @param aContext the context IDs are placed here

    62 		*/

    63 		virtual void GetHelpContext( TCoeHelpContext& aContext ) const = 0;

    64 

    65 		/**

    66 		* Registers an observer for receiving

    67 		* update notifications from this interface.

    68 		* @param aObserver The observer object.

    69 		*/

    70 		virtual void SetDecoratorObserver( MVRObserver* aObserver ) = 0;

    71 		

    72 		/**

    73 		* Tells in return value if CBA Buttons should be enabled or not

    74 		* @return ETrue if buttons should be enabled, EFalse otherwise

    75 		*/

    76 		virtual TBool CBAEnabled() const = 0;

    77 

    78 	};

    79 

    80 #endif // __MVRDECORATORMODEL_H__