1 /*

     2 * Copyright (c) 2004 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:   Defines class MNcnUI.

    15 *

    16 */

    17 

    18 

    19 

    20 #ifndef MNCNUI_H

    21 #define MNCNUI_H

    22 

    23 //  INCLUDES

    24 #include <e32base.h>

    25 #include <msvapi.h>

    26 #include "MNcnNotifier.h"

    27 

    28 // CLASS DECLARATION

    29 

    30 /**

    31  * Ncn UI interface.

    32  */

    33 class MNcnUI

    34     {         

    35     public: // New methods

    36         /**

    37          * Show the message to the user.

    38          * @param aEntry The Msv entry containing the message.

    39          */

    40         virtual void ShowMessageL( const TMsvEntry& aEntry ) = 0;

    41         

    42         /**

    43          * Opens the specified message in message centre.

    44          * @param aEntry The Msv entry to open.

    45          */

    46         virtual void OpenMessageL( const TMsvEntry& aEntry ) = 0;        

    47         

    48         /**

    49          * Shows the delivery note for an msv entry.

    50          * @param aEntry The Msv entry.

    51          */

    52         virtual void ShowDeliveryNoteL( const TMsvEntry& aEntry ) = 0;

    53         

    54         /**

    55          * Plays the message alert tone.

    56          */

    57         virtual void PlayMessageAlertToneL() = 0;

    58         

    59         /**

    60          * Plays the message alert tone. This method does not leave.

    61          */

    62         virtual void PlayMessageAlertTone() = 0;

    63         

    64         /**

    65          * Plays the email alert tone.

    66          */

    67         virtual void PlayEMailAlertToneL() = 0;

    68         

    69         /**

    70          * Plays the email alert tone. This method does not leave.

    71          */

    72         virtual void PlayEMailAlertTone() = 0;

    73         

    74         /**

    75          * Aborts current alert tone playback, if any.

    76          */

    77         virtual void AbortAlertTonePlayback() = 0;

    78         

    79         /**

    80          * Flashes the display.

    81          */

    82         virtual void FlashDisplay() = 0;

    83         

    84         /**

    85          * Sets UIs idle state. If UI is in idle state no notifications are shown.

    86          * @param aIdleState Idle state status.

    87          */

    88         virtual void SetIdleState( TBool aIdleState ) = 0;

    89         

    90         /**

    91          * Returns the current idle state status.

    92          */

    93         virtual TBool IdleState() = 0;

    94         

    95         /**

    96          * Sets UIs boot phase state. If UI is in boot phase audio notifications

    97          * are not played.

    98          * @param aBootPhase Boot phase status.

    99          */

   100         virtual void SetBootPhase( TBool aBootPhase ) = 0;

   101         

   102         /**

   103          * Returns the current boot phase status.

   104          */

   105         virtual TBool BootPhase() = 0;

   106         

   107         /**

   108          * Updates the specified soft notification.

   109          * @param aNotification The notification type.

   110          * @param aAmount The amount of messages for notification.

   111          */

   112         virtual void UpdateSoftNotification(

   113             MNcnNotifier::TNcnNotificationType aNotification,

   114             TUint aAmount ) = 0;

   115 

   116         /**

   117          * Returns ETrue if visual notifications are allowed.

   118          * EFalse when visual notifications are not allowed (when in SAP-profile

   119          * for example.

   120          * @return ETrue if visual notifications are allowed.

   121          */

   122         virtual TBool VisualNotificationsAllowed() = 0;

   123         

   124         /**

   125          * Returns ETrue if audio notifications are allowed.

   126          * EFalse when audio notifications are not allowed (when in boot phase

   127          * for example.

   128          * @return ETrue if audio notifications are allowed.

   129          */

   130         virtual TBool AudioNotificationsAllowed() = 0;

   131     };

   132     

   133 #endif // MNCNUI_H

   134 

   135 // End of File