1 /*

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

    15 *   See class description.

    16 *

    17 */

    18 

    19 

    20 #ifndef __TPHONECMDPARAMNOTE_H

    21 #define __TPHONECMDPARAMNOTE_H

    22 

    23 //  INCLUDES

    24 

    25 #include <w32std.h>

    26 #include <aknnotedialog.h> 

    27 #include "tphonecommandparam.h"

    28 

    29 // DATA TYPES

    30 

    31 /**

    32 * Enumerates note types

    33 *

    34 * EPhoneNoteError - error note

    35 * EPhoneNoteWarning - warning note

    36 * EPhoneNoteInformation - information note

    37 * EPhoneNoteConfirmation - confirmation note

    38 * EPhoneNoteCustom - custom note

    39 * EPhoneNotePermanent - custom permanent note

    40 * EPhoneNoteDtmfSending - Dtmf sending note

    41 * EPhoneNoteSecurity - security note

    42 */

    43 enum TPhoneNoteType

    44 {

    45     EPhoneNoteError,

    46     EPhoneNoteWarning,

    47     EPhoneNoteInformation,

    48     EPhoneNoteConfirmation,

    49     EPhoneNoteCustom,

    50     EPhoneNotePermanent,

    51     EPhoneNoteDtmfSending,

    52     EPhoneNoteSecurity,

    53     EPhoneNoteUIDisabled

    54 };

    55 

    56 // CLASS DECLARATION

    57 

    58 /**

    59 *  A parameter class for note dialog information.

    60 */

    61 class TPhoneCmdParamNote : public TPhoneUICommandParam

    62     {   

    63     public:  

    64         

    65         /**

    66         * C++ default constructor.

    67         */

    68         IMPORT_C TPhoneCmdParamNote();

    69 

    70     public: 

    71         

    72         /**

    73         * Sets the note type

    74         * @param aType is the note type

    75         */

    76         IMPORT_C void SetType( TPhoneNoteType aType );

    77 

    78         /**

    79         * Sets the resource ID for the note

    80         * @param aResourceId is the note resource ID

    81         */

    82         IMPORT_C void SetResourceId( TInt aResourceId );

    83 

    84         /**

    85         * Sets the text resource ID for the note

    86         * @param aResourceId is the note resource ID

    87         */

    88         IMPORT_C void SetTextResourceId( TInt aTextResourceId );

    89 

    90         /**

    91         * Sets the text for the note

    92         * @param aText is the note text

    93         */

    94         IMPORT_C void SetText( const TDesC& aText );

    95 

    96         /**

    97         * Sets the note tone.

    98         * @param aTone is the note tone

    99         */

   100         IMPORT_C void SetTone( CAknNoteDialog::TTone aTone );

   101        

   102         /**

   103         * Sets the note timeout.

   104         * @param aTimeout is the note timeout

   105         */

   106         IMPORT_C void SetTimeout( CAknNoteDialog::TTimeout aTimeout );

   107 

   108         /**

   109         * Returns the note type

   110         * @return Returns the type

   111         */

   112         IMPORT_C TPhoneNoteType Type() const;

   113 

   114         /**

   115         * Returns the note resource ID.

   116         * @return Returns the note resource ID.

   117         */

   118         IMPORT_C TInt ResourceId() const;

   119 

   120         /**

   121         * Returns the note text resource ID.

   122         * @return Returns the note text resource ID.

   123         */

   124         IMPORT_C TInt TextResourceId() const;

   125 

   126         /**

   127         * Returns the note text.

   128         * @return Returns the note text.

   129         */

   130         IMPORT_C const TDesC& Text() const;

   131 

   132         /**

   133         * Returns the note tone.

   134         * @return Returns the note tone

   135         */

   136         IMPORT_C CAknNoteDialog::TTone Tone() const;

   137 

   138         /**

   139         * Returns the note timeout.

   140         * @return Returns the note timeout 

   141         */

   142         IMPORT_C CAknNoteDialog::TTimeout Timeout() const;

   143 

   144     private:    

   145         

   146         /**

   147         * Note type

   148         */

   149         TPhoneNoteType iType;

   150 

   151         /**

   152         * Note resource ID

   153         */

   154         TInt iResourceId;

   155 

   156         /**

   157         * Note text resource ID

   158         */

   159         TInt iTextResourceId;

   160 

   161         /**

   162         * Note text

   163         */

   164         TPtrC iText;

   165 

   166         /**

   167         * Note tone

   168         */

   169         CAknNoteDialog::TTone iTone;

   170 

   171         /**

   172         * Note timeout

   173         */

   174         CAknNoteDialog::TTimeout iTimeout;

   175     };

   176 

   177 #endif // __TPHONECMDPARAMNOTE_H   

   178             

   179 // End of File