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 __TPHONECMDPARAMGLOBALNOTE_H

    21 #define __TPHONECMDPARAMGLOBALNOTE_H

    22 

    23 //  INCLUDES

    24 

    25 #include <w32std.h>

    26 #include <AknGlobalNote.h> // for CAknGlobalNote

    27 #include "tphonecommandparam.h"

    28 

    29 // DATA TYPES

    30 

    31 // CLASS DECLARATION

    32 

    33 /**

    34 *  A parameter class for global note information.

    35 */

    36 class TPhoneCmdParamGlobalNote : public TPhoneUICommandParam

    37     {   

    38     public:  

    39         

    40         /**

    41         * C++ default constructor.

    42         */

    43         IMPORT_C TPhoneCmdParamGlobalNote();

    44 

    45     public: 

    46         

    47         /**

    48         * Sets the global note type.

    49         * @param aType is the global note type

    50         */

    51         IMPORT_C void SetType( TAknGlobalNoteType aType );

    52 

    53         /**

    54         * Sets the text resource ID for the global note

    55         * @param aResourceId is the global note resource ID

    56         */

    57         IMPORT_C void SetTextResourceId( TInt aTextResourceId );

    58 

    59         /**

    60         * Sets the text for the global note.

    61         * @param aText is the global note text

    62         */

    63         IMPORT_C void SetText( const TDesC& aText );

    64 

    65         /**

    66         * Sets the global note tone.

    67         * @param aTone is the note tone

    68         */

    69         IMPORT_C void SetTone( TInt aTone );

    70        

    71         /**

    72         * Sets the global note wait status.

    73         * @param aStatus Wait for completed or not

    74         */

    75         IMPORT_C void SetWaitForReady( TBool aStatus );

    76         

    77         /**

    78         * Sets the global note softkeys.

    79         * @param aTone is the note softkeys

    80         */

    81         IMPORT_C void SetSoftkeys( TInt aSoftkeys );

    82 

    83         /**

    84         * Sets timeout for a note.

    85         * @param    aTimeout    Timeout in milliseconds. If timeout == 0 then 

    86         * default timeout is used. If timeout < 0 the note is not closed 

    87         * automatically.

    88         */

    89         IMPORT_C void SetTimeout( TInt aTimeout );

    90         

    91         /**

    92         * Returns the global note type

    93         * @return Returns the type

    94         */

    95         IMPORT_C TAknGlobalNoteType Type() const;

    96 

    97         /**

    98         * Returns the global note text resource ID.

    99         * @return Returns the global note text resource ID.

   100         */

   101         IMPORT_C TInt TextResourceId() const;

   102 

   103         /**

   104         * Returns the global note text

   105         * @return Returns the text

   106         */

   107         IMPORT_C const TDesC& Text() const;

   108 

   109         /**

   110         * Returns the global note tone.

   111         * @return Returns the global note tone

   112         */

   113         IMPORT_C TInt Tone() const;

   114         

   115         /**

   116         * Gets the global note wait status

   117         * @return  ETrue if wait for completed

   118         */

   119         IMPORT_C TBool WaitForReady() const;

   120         

   121         /**

   122         * Returns the global note softkeys.

   123         * @return Returns the global note softkeys

   124         */

   125         IMPORT_C TInt Softkeys() const;

   126         

   127         /**

   128          * Returns the timeout value.

   129          * @return   Timeout value.

   130          */

   131         IMPORT_C TInt Timeout() const;

   132     

   133     private:    

   134         

   135         /**

   136         * Global note type

   137         */

   138         TAknGlobalNoteType iType;

   139 

   140         /**

   141         * Global note text resource ID

   142         */

   143         TInt iTextResourceId;

   144 

   145         /**

   146         * Global note text

   147         */

   148         TPtrC iText;

   149 

   150         /**

   151         * Global note tone

   152         */

   153         TInt iTone;

   154         

   155         /**

   156         * Wait for ready status

   157         */

   158         TBool iWaitforReady;

   159         

   160         /**

   161         * Global note softkeys

   162         */

   163         TInt iSoftkeys;

   164         

   165         /**

   166         * Timeout for a note.

   167         */

   168         TInt iTimeout;

   169     };

   170 

   171 #endif // __TPHONECMDPARAMGLOBALNOTE_H

   172             

   173 // End of File