voiceui/voiceuivoicerecognition/inc/vuicglobalnote.h
branchRCL_3
changeset 19 e36f3802f733
equal deleted inserted replaced
18:cad71a31b7fc 19:e36f3802f733
       
     1 /*
       
     2 * Copyright (c) 2006-2007 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:  Handle showing of global notes
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef VUICGLOBALNOTE_H
       
    20 #define VUICGLOBALNOTE_H
       
    21 
       
    22 // INCLUDES
       
    23 #include <e32base.h>
       
    24 #include <AknGlobalNote.h>
       
    25 
       
    26 #include <secondarydisplay/vuisecondarydisplayapi.h>
       
    27 
       
    28 #include "vuivoiceicondefs.h"
       
    29 
       
    30 // CLASS DECLARATION
       
    31 /**
       
    32 * Handle showing of global notes
       
    33 */
       
    34 NONSHARABLE_CLASS( CGlobalNote ) : public CBase
       
    35 {
       
    36     public:     // Constructors and destructor
       
    37        
       
    38         /**
       
    39         * Symbian two-phased constructor.
       
    40         */
       
    41         static CGlobalNote* NewL();
       
    42 
       
    43         /**
       
    44         * Destructor.
       
    45         */
       
    46         virtual ~CGlobalNote();
       
    47         
       
    48     public:     // Enumerations
       
    49     
       
    50         enum TGlobalNoteState
       
    51             {
       
    52             ECallInProgress,
       
    53             ESystemError,
       
    54             ENoTag,
       
    55             ENoMatchPermanent,
       
    56             ENotRecognizedPermanent,
       
    57             ENoMemory
       
    58             };
       
    59                                 
       
    60     public:     // New functions
       
    61     
       
    62         /**
       
    63         * Shows a message dialog
       
    64         * @param
       
    65         */
       
    66         void DisplayGlobalNoteL( TGlobalNoteState aState );
       
    67         
       
    68         /**
       
    69         * Shows a message dialog
       
    70         */
       
    71         void DismissGlobalNoteL();
       
    72         
       
    73     private:
       
    74 
       
    75         /**
       
    76         * C++ default constructor.
       
    77         */
       
    78         CGlobalNote();
       
    79         
       
    80         /**
       
    81         * Symbian OS 2nd phase constructor.
       
    82         */
       
    83         void ConstructL();
       
    84                 
       
    85         /**
       
    86         * Displays global note
       
    87         * @param aNoteType Type of note
       
    88         * @param aMsgId Message ID
       
    89         * @param aDialog Cover ui dialog type
       
    90         * @param aIcon Icon id
       
    91         * @param aIconMask Icon mask id
       
    92         */
       
    93         void DisplayGlobalNoteL( TAknGlobalNoteType aNoteType, TInt aMsgId,
       
    94                                  SecondaryDisplay::TVUISecondaryDisplayDialogs aDialog,
       
    95                                  TMifAvkon aIcon = (TMifAvkon) 0, TMifAvkon aIconMask = (TMifAvkon) 0 );
       
    96         /**
       
    97         * Displays global note
       
    98         * @param aNoteType Type of note
       
    99         * @param aNoteText Text of the note
       
   100         * @param aDialog Cover ui dialog type
       
   101         * @param aIcon Icon id
       
   102         * @param aIconMask Icon mask id
       
   103         */
       
   104         void DisplayGlobalNoteL( TAknGlobalNoteType aNoteType, HBufC* aNoteText,
       
   105                                  SecondaryDisplay::TVUISecondaryDisplayDialogs aDialog,
       
   106                                  TMifAvkon aIcon, TMifAvkon aIconMask );
       
   107         
       
   108     private:    // Data
       
   109 
       
   110         // Note
       
   111         CAknGlobalNote*         iNote;
       
   112         
       
   113         // Id of the currently shown note
       
   114         TInt                    iNoteId;
       
   115 };
       
   116 
       
   117 #endif  // VUICGLOBALNOTE_H
       
   118 
       
   119 // End of File