phoneapp/phoneuiview/inc/mphonedisplayprovider.h
changeset 0 5f000ab63145
equal deleted inserted replaced
-1:000000000000 0:5f000ab63145
       
     1 /*
       
     2 * Copyright (c) 2002-2005 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:  Interface between ringing tone player and ui controls. 
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef MPHONEDISPLAYPROVIDER_H
       
    21 #define MPHONEDISPLAYPROVIDER_H
       
    22 
       
    23 // CLASS DECLARATION
       
    24 
       
    25 /**
       
    26 *  Interface between ringing tone player and ui controls.
       
    27 *  Ringing tone player uses this interface to get display access for
       
    28 *  video ringing tone playback. 
       
    29 *
       
    30 *  @lib Phone.lib
       
    31 *  @since Series 60 3.0
       
    32 */
       
    33 class MPhoneDisplayProvider
       
    34     {
       
    35     public:
       
    36 
       
    37         enum TPhoneDisplayType
       
    38             {
       
    39             EIncomingCallQcifVideo,
       
    40             EIncomingCallSubQcifVideo
       
    41             };
       
    42 
       
    43     public: // New functions
       
    44 
       
    45         /**
       
    46         * Activates a display. There can be one display active at time.
       
    47         * This method may be called also to change display type.
       
    48         * @since Series 60 3.0
       
    49         * @param aDisplayType Type of the display requested.
       
    50         * @param aClientWindow Window for client's use.
       
    51         * @param aUncropPane Rectangle for cropping control, relative to screen.
       
    52         * @return KErrNone If activation succeeded.                  
       
    53         */
       
    54         virtual TInt ActivateDisplay( 
       
    55             TPhoneDisplayType aDisplayType,
       
    56             RWindow& aClientWindow,
       
    57             TRect& aUncropPane ) = 0;
       
    58         
       
    59         /**
       
    60         * Deactivates the display active.
       
    61         * @since Series 60 3.0
       
    62         */
       
    63         virtual void DeactivateDisplay() = 0;
       
    64     };
       
    65 
       
    66 #endif      // MPHONEDISPLAYPROVIDER_H   
       
    67             
       
    68 // End of File