phoneapp/phoneuiutils/inc/tphonecmdparamglobalnote.h
changeset 56 5bcb308bd24d
parent 46 bc5a64e5bc3c
equal deleted inserted replaced
46:bc5a64e5bc3c 56:5bcb308bd24d
    21 #define __TPHONECMDPARAMGLOBALNOTE_H
    21 #define __TPHONECMDPARAMGLOBALNOTE_H
    22 
    22 
    23 //  INCLUDES
    23 //  INCLUDES
    24 
    24 
    25 #include <w32std.h>
    25 #include <w32std.h>
    26 #include <AknGlobalNote.h> // for CAknGlobalNote
    26 //#include <AknGlobalNote.h> // for CAknGlobalNote
       
    27 
    27 #include "tphonecommandparam.h"
    28 #include "tphonecommandparam.h"
    28 
    29 
    29 // DATA TYPES
    30 // DATA TYPES
    30 
    31 enum PhoneNotificationType{
       
    32     EPhoneNotificationDialog = 0, // notify of a state change that does not require user input.
       
    33     EPhoneMessageBoxInformation,
       
    34     EPhoneMessageBoxWarning
       
    35 };
    31 // CLASS DECLARATION
    36 // CLASS DECLARATION
    32 
    37 
    33 /**
    38 /**
    34 *  A parameter class for global note information.
    39 *  A parameter class for global note information.
    35 */
    40 */
    46         
    51         
    47         /**
    52         /**
    48         * Sets the global note type.
    53         * Sets the global note type.
    49         * @param aType is the global note type
    54         * @param aType is the global note type
    50         */
    55         */
    51         IMPORT_C void SetType( TAknGlobalNoteType aType );
    56         IMPORT_C void SetType( PhoneNotificationType aType );
    52 
    57 
    53         /**
    58         /**
    54         * Sets the text resource ID for the global note
    59         * Sets the text resource ID for the global note
    55         * @param aResourceId is the global note resource ID
    60         * @param aResourceId is the global note resource ID
    56         */
    61         */
    60         * Sets the text for the global note.
    65         * Sets the text for the global note.
    61         * @param aText is the global note text
    66         * @param aText is the global note text
    62         */
    67         */
    63         IMPORT_C void SetText( const TDesC& aText );
    68         IMPORT_C void SetText( const TDesC& aText );
    64 
    69 
    65         /**
    70        /**
    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.
    71         * Sets timeout for a note.
    85         * @param    aTimeout    Timeout in milliseconds. If timeout == 0 then 
    72         * @param    aTimeout    Timeout in milliseconds. If timeout == 0 then 
    86         * default timeout is used. If timeout < 0 the note is not closed 
    73         * default timeout is used. If timeout < 0 the note is not closed 
    87         * automatically.
    74         * automatically.
    88         */
    75         */
   103         
    90         
   104         /**
    91         /**
   105         * Returns the global note type
    92         * Returns the global note type
   106         * @return Returns the type
    93         * @return Returns the type
   107         */
    94         */
   108         IMPORT_C TAknGlobalNoteType Type() const;
    95         IMPORT_C PhoneNotificationType Type() const;
   109 
    96 
   110         /**
    97         /**
   111         * Returns the global note text resource ID.
    98         * Returns the global note text resource ID.
   112         * @return Returns the global note text resource ID.
    99         * @return Returns the global note text resource ID.
   113         */
   100         */
   117         * Returns the global note text
   104         * Returns the global note text
   118         * @return Returns the text
   105         * @return Returns the text
   119         */
   106         */
   120         IMPORT_C const TDesC& Text() const;
   107         IMPORT_C const TDesC& Text() const;
   121 
   108 
   122         /**
       
   123         * Returns the global note tone.
       
   124         * @return Returns the global note tone
       
   125         */
       
   126         IMPORT_C TInt Tone() const;
       
   127         
       
   128         /**
       
   129         * Gets the global note wait status
       
   130         * @return  ETrue if wait for completed
       
   131         */
       
   132         IMPORT_C TBool WaitForReady() const;
       
   133         
       
   134         /**
       
   135         * Returns the global note softkeys.
       
   136         * @return Returns the global note softkeys
       
   137         */
       
   138         IMPORT_C TInt Softkeys() const;
       
   139         
       
   140         /**
   109         /**
   141          * Returns the timeout value.
   110          * Returns the timeout value.
   142          * @return   Timeout value.
   111          * @return   Timeout value.
   143          */
   112          */
   144         IMPORT_C TInt Timeout() const;
   113         IMPORT_C TInt Timeout() const;
   158     private:    
   127     private:    
   159         
   128         
   160         /**
   129         /**
   161         * Global note type
   130         * Global note type
   162         */
   131         */
   163         TAknGlobalNoteType iType;
   132         PhoneNotificationType iType;
   164 
   133         
   165         /**
   134         /**
   166         * Global note text resource ID
   135         * Global note text resource ID
   167         */
   136         */
   168         TInt iTextResourceId;
   137         TInt iTextResourceId;
   169 
   138 
   170         /**
   139         /**
   171         * Global note text
   140         * Global note text
   172         */
   141         */
   173         TPtrC iText;
   142         TPtrC iText;
   174 
       
   175         /**
       
   176         * Global note tone
       
   177         */
       
   178         TInt iTone;
       
   179         
       
   180         /**
       
   181         * Wait for ready status
       
   182         */
       
   183         TBool iWaitforReady;
       
   184         
       
   185         /**
       
   186         * Global note softkeys
       
   187         */
       
   188         TInt iSoftkeys;
       
   189         
   143         
   190         /**
   144         /**
   191         * Timeout for a note.
   145         * Timeout for a note.
   192         */
   146         */
   193         TInt iTimeout;
   147         TInt iTimeout;