1 /*

     2 * Copyright (c) 2002 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 *       Manager for the statuspane, include navi pane and title pane

    16 *

    17 */

    18 

    19 

    20 #ifndef MPHONESTATUSPANE_H

    21 #define MPHONESTATUSPANE_H

    22 

    23 // INCLUDES

    24 

    25 // CONSTANTS

    26 

    27 // FORWARD DECLARATIONS

    28 class MPhoneStatusPaneObserver;

    29 class CAknTitlePane;

    30 

    31 // CLASS DECLARATION

    32 

    33 /**

    34 *  Manager for the statuspane, include navi pane and title pane

    35 *  Usage:

    36 *  Every client in phone application that will change the title pane should

    37 *  use status pane manager, to avoid confliction. 

    38 *  - Always use iStatusPaneManager.TitlePane() to get the reference of status 

    39 *    pane.

    40 *  - in ConstructL() insert a new handler to status pane manager by 

    41 *    AddTitlePaneHandlerL( *this )

    42 *  - Reserve the title pane before you change the title pane by 

    43 *    ReserveTitlePane( *this )

    44 *  - Before changing the status pane, always check if I'm the topmost handler

    45 *    of the manager, by iStatusPaneManager->IsTitlePaneVisible()

    46 *  - release the title pane after the change

    47 *  

    48 */

    49 class MPhoneStatusPane

    50     {

    51     public:

    52 

    53         /**

    54         * Destructor

    55         */

    56         virtual ~MPhoneStatusPane(){};

    57 

    58         /**

    59         * Returns ETrue if status pane is visible.

    60         */

    61         virtual TBool IsVisible() const = 0;

    62 

    63         /**

    64         * Get the reference of the title pane

    65         * @return the reference of the title pane

    66         */

    67         virtual CAknTitlePane& TitlePane() const = 0;

    68 

    69         /**

    70         * Add title pane handler, returns reserve id

    71         * @return reservatoin id

    72         */

    73         virtual void AddTitlePaneHandlerL(

    74             MPhoneStatusPaneObserver& aObserver ) = 0;

    75 

    76         /**

    77         * Reserve the title pane

    78         * @param the reserve id for release and get the visibility status

    79         */

    80         virtual void ReserveTitlePane(

    81             MPhoneStatusPaneObserver& aObserver ) = 0;

    82 

    83         /**

    84         * Release title pane that has been reserved

    85         * @param aReserveId the reserve id

    86         */

    87         virtual void ReleaseTitlePane( 

    88             MPhoneStatusPaneObserver& aObserver ) = 0;

    89 

    90         /**

    91         * Remove the handler

    92         */

    93         virtual void RemoveTitlePaneHandler( 

    94             MPhoneStatusPaneObserver& aObserver ) = 0;

    95 

    96         /**

    97         * Check if the title pane is visible

    98         * @param aReserveId the reservation id

    99         * @return ETrue if the title pane is visible

   100         */

   101         virtual TBool IsTitlePaneVisible( 

   102             MPhoneStatusPaneObserver& aObserver ) const = 0;

   103     };

   104 

   105 #endif      // MPhoneStatusPane_H   

   106             

   107 // End of File