phoneapp/phoneuiutils/inc/tphonecmdparamglobalnote.h
changeset 53 22cc52eade9b
parent 52 a49bfe5190e4
child 76 cfea66083b62
equal deleted inserted replaced
52:a49bfe5190e4 53:22cc52eade9b
    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 // ##### QT CHANGE begin
    26 //#include <AknGlobalNote.h> // for CAknGlobalNote
    27 // #include <AknGlobalNote.h> // for CAknGlobalNote
    27 
    28 // ##### QT CHANGE end
       
    29 #include "tphonecommandparam.h"
    28 #include "tphonecommandparam.h"
    30 
    29 
    31 // DATA TYPES
    30 // DATA TYPES
    32 
    31 enum PhoneNotificationType{
    33 // ##### QT CHANGE begin
    32     EPhoneNotificationDialog = 0, // notify of a state change that does not require user input.
    34 // Note: as AknGlobalNote API is removed, the enumeration is temporarily copied here
    33     EPhoneMessageBoxInformation,
    35 // to avoid compile break. The API needs to be changed though.
    34     EPhoneMessageBoxWarning
    36 enum TAknGlobalNoteType {
    35 };
    37     EAknGlobalInformationNote = 1,
       
    38     EAknGlobalWarningNote,
       
    39     EAknGlobalConfirmationNote,
       
    40     EAknGlobalErrorNote,
       
    41     EAknGlobalWaitNote
       
    42     };
       
    43 // ##### QT CHANGE end
       
    44 
       
    45 // CLASS DECLARATION
    36 // CLASS DECLARATION
    46 
    37 
    47 /**
    38 /**
    48 *  A parameter class for global note information.
    39 *  A parameter class for global note information.
    49 */
    40 */
    60         
    51         
    61         /**
    52         /**
    62         * Sets the global note type.
    53         * Sets the global note type.
    63         * @param aType is the global note type
    54         * @param aType is the global note type
    64         */
    55         */
    65         IMPORT_C void SetType( TAknGlobalNoteType aType );
    56         IMPORT_C void SetType( PhoneNotificationType aType );
    66 
    57 
    67         /**
    58         /**
    68         * Sets the text resource ID for the global note
    59         * Sets the text resource ID for the global note
    69         * @param aResourceId is the global note resource ID
    60         * @param aResourceId is the global note resource ID
    70         */
    61         */
    74         * Sets the text for the global note.
    65         * Sets the text for the global note.
    75         * @param aText is the global note text
    66         * @param aText is the global note text
    76         */
    67         */
    77         IMPORT_C void SetText( const TDesC& aText );
    68         IMPORT_C void SetText( const TDesC& aText );
    78 
    69 
    79         /**
    70        /**
    80         * Sets the global note tone.
       
    81         * @param aTone is the note tone
       
    82         */
       
    83         IMPORT_C void SetTone( TInt aTone );
       
    84        
       
    85         /**
       
    86         * Sets the global note wait status.
       
    87         * @param aStatus Wait for completed or not
       
    88         */
       
    89         IMPORT_C void SetWaitForReady( TBool aStatus );
       
    90         
       
    91         /**
       
    92         * Sets the global note softkeys.
       
    93         * @param aTone is the note softkeys
       
    94         */
       
    95         IMPORT_C void SetSoftkeys( TInt aSoftkeys );
       
    96 
       
    97         /**
       
    98         * Sets timeout for a note.
    71         * Sets timeout for a note.
    99         * @param    aTimeout    Timeout in milliseconds. If timeout == 0 then 
    72         * @param    aTimeout    Timeout in milliseconds. If timeout == 0 then 
   100         * 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 
   101         * automatically.
    74         * automatically.
   102         */
    75         */
   117         
    90         
   118         /**
    91         /**
   119         * Returns the global note type
    92         * Returns the global note type
   120         * @return Returns the type
    93         * @return Returns the type
   121         */
    94         */
   122         IMPORT_C TAknGlobalNoteType Type() const;
    95         IMPORT_C PhoneNotificationType Type() const;
   123 
    96 
   124         /**
    97         /**
   125         * Returns the global note text resource ID.
    98         * Returns the global note text resource ID.
   126         * @return Returns the global note text resource ID.
    99         * @return Returns the global note text resource ID.
   127         */
   100         */
   131         * Returns the global note text
   104         * Returns the global note text
   132         * @return Returns the text
   105         * @return Returns the text
   133         */
   106         */
   134         IMPORT_C const TDesC& Text() const;
   107         IMPORT_C const TDesC& Text() const;
   135 
   108 
   136         /**
       
   137         * Returns the global note tone.
       
   138         * @return Returns the global note tone
       
   139         */
       
   140         IMPORT_C TInt Tone() const;
       
   141         
       
   142         /**
       
   143         * Gets the global note wait status
       
   144         * @return  ETrue if wait for completed
       
   145         */
       
   146         IMPORT_C TBool WaitForReady() const;
       
   147         
       
   148         /**
       
   149         * Returns the global note softkeys.
       
   150         * @return Returns the global note softkeys
       
   151         */
       
   152         IMPORT_C TInt Softkeys() const;
       
   153         
       
   154         /**
   109         /**
   155          * Returns the timeout value.
   110          * Returns the timeout value.
   156          * @return   Timeout value.
   111          * @return   Timeout value.
   157          */
   112          */
   158         IMPORT_C TInt Timeout() const;
   113         IMPORT_C TInt Timeout() const;
   172     private:    
   127     private:    
   173         
   128         
   174         /**
   129         /**
   175         * Global note type
   130         * Global note type
   176         */
   131         */
   177         TAknGlobalNoteType iType;
   132         PhoneNotificationType iType;
   178 
   133         
   179         /**
   134         /**
   180         * Global note text resource ID
   135         * Global note text resource ID
   181         */
   136         */
   182         TInt iTextResourceId;
   137         TInt iTextResourceId;
   183 
   138 
   184         /**
   139         /**
   185         * Global note text
   140         * Global note text
   186         */
   141         */
   187         TPtrC iText;
   142         TPtrC iText;
   188 
       
   189         /**
       
   190         * Global note tone
       
   191         */
       
   192         TInt iTone;
       
   193         
       
   194         /**
       
   195         * Wait for ready status
       
   196         */
       
   197         TBool iWaitforReady;
       
   198         
       
   199         /**
       
   200         * Global note softkeys
       
   201         */
       
   202         TInt iSoftkeys;
       
   203         
   143         
   204         /**
   144         /**
   205         * Timeout for a note.
   145         * Timeout for a note.
   206         */
   146         */
   207         TInt iTimeout;
   147         TInt iTimeout;