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 |
|
28 #include "tphonecommandparam.h" |
27 #include "tphonecommandparam.h" |
29 |
28 |
30 // DATA TYPES |
29 // DATA TYPES |
31 enum PhoneNotificationType{ |
30 |
32 EPhoneNotificationDialog = 0, // notify of a state change that does not require user input. |
|
33 EPhoneMessageBoxInformation, |
|
34 EPhoneMessageBoxWarning |
|
35 }; |
|
36 // CLASS DECLARATION |
31 // CLASS DECLARATION |
37 |
32 |
38 /** |
33 /** |
39 * A parameter class for global note information. |
34 * A parameter class for global note information. |
40 */ |
35 */ |
51 |
46 |
52 /** |
47 /** |
53 * Sets the global note type. |
48 * Sets the global note type. |
54 * @param aType is the global note type |
49 * @param aType is the global note type |
55 */ |
50 */ |
56 IMPORT_C void SetType( PhoneNotificationType aType ); |
51 IMPORT_C void SetType( TAknGlobalNoteType aType ); |
57 |
52 |
58 /** |
53 /** |
59 * Sets the text resource ID for the global note |
54 * Sets the text resource ID for the global note |
60 * @param aResourceId is the global note resource ID |
55 * @param aResourceId is the global note resource ID |
61 */ |
56 */ |
65 * Sets the text for the global note. |
60 * Sets the text for the global note. |
66 * @param aText is the global note text |
61 * @param aText is the global note text |
67 */ |
62 */ |
68 IMPORT_C void SetText( const TDesC& aText ); |
63 IMPORT_C void SetText( const TDesC& aText ); |
69 |
64 |
70 /** |
65 /** |
71 * Sets timeout for a note. |
66 * Sets the global note tone. |
72 * @param aTimeout Timeout in milliseconds. If timeout == 0 then |
67 * @param aTone is the note tone |
73 * default timeout is used. If timeout < 0 the note is not closed |
|
74 * automatically. |
|
75 */ |
68 */ |
76 IMPORT_C void SetTimeout( TInt aTimeout ); |
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 ); |
77 |
76 |
78 /** |
77 /** |
79 * Sets notification dialog flag. |
78 * Sets the global note softkeys. |
80 * @param aNotificationDialog True if notification dialog |
79 * @param aTone is the note softkeys |
81 * should be used. |
|
82 */ |
80 */ |
83 IMPORT_C void SetNotificationDialog( TBool aNotificationDialog ); |
81 IMPORT_C void SetSoftkeys( TInt aSoftkeys ); |
84 |
82 |
85 /** |
|
86 * Sets cause code. |
|
87 * @param aCauseCode Cause code. |
|
88 */ |
|
89 IMPORT_C void SetCauseCode( TInt aCauseCode ); |
|
90 |
83 |
91 /** |
84 /** |
92 * Returns the global note type |
85 * Returns the global note type |
93 * @return Returns the type |
86 * @return Returns the type |
94 */ |
87 */ |
95 IMPORT_C PhoneNotificationType Type() const; |
88 IMPORT_C TAknGlobalNoteType Type() const; |
96 |
89 |
97 /** |
90 /** |
98 * Returns the global note text resource ID. |
91 * Returns the global note text resource ID. |
99 * @return Returns the global note text resource ID. |
92 * @return Returns the global note text resource ID. |
100 */ |
93 */ |
105 * @return Returns the text |
98 * @return Returns the text |
106 */ |
99 */ |
107 IMPORT_C const TDesC& Text() const; |
100 IMPORT_C const TDesC& Text() const; |
108 |
101 |
109 /** |
102 /** |
110 * Returns the timeout value. |
103 * Returns the global note tone. |
111 * @return Timeout value. |
104 * @return Returns the global note tone |
112 */ |
105 */ |
113 IMPORT_C TInt Timeout() const; |
106 IMPORT_C TInt Tone() const; |
114 |
107 |
115 /** |
108 /** |
116 * Returns the notification dialog flag. |
109 * Gets the global note wait status |
117 * @return Notification dialog flag. |
110 * @return ETrue if wait for completed |
118 */ |
111 */ |
119 IMPORT_C TBool NotificationDialog() const; |
112 IMPORT_C TBool WaitForReady() const; |
120 |
113 |
121 /** |
114 /** |
122 * Returns cause code. |
115 * Returns the global note softkeys. |
123 * @return Cause code. |
116 * @return Returns the global note softkeys |
124 */ |
117 */ |
125 IMPORT_C TInt CauseCode() const; |
118 IMPORT_C TInt Softkeys() const; |
126 |
119 |
127 private: |
120 private: |
128 |
121 |
129 /** |
122 /** |
130 * Global note type |
123 * Global note type |
131 */ |
124 */ |
132 PhoneNotificationType iType; |
125 TAknGlobalNoteType iType; |
133 |
126 |
134 /** |
127 /** |
135 * Global note text resource ID |
128 * Global note text resource ID |
136 */ |
129 */ |
137 TInt iTextResourceId; |
130 TInt iTextResourceId; |
138 |
131 |
139 /** |
132 /** |
140 * Global note text |
133 * Global note text |
141 */ |
134 */ |
142 TPtrC iText; |
135 TPtrC iText; |
|
136 |
|
137 /** |
|
138 * Global note tone |
|
139 */ |
|
140 TInt iTone; |
143 |
141 |
144 /** |
142 /** |
145 * Timeout for a note. |
143 * Wait for ready status |
146 */ |
144 */ |
147 TInt iTimeout; |
145 TBool iWaitforReady; |
148 |
146 |
149 /** |
147 /** |
150 * Notification Dialog flag. |
148 * Global note softkeys |
151 */ |
149 */ |
152 TBool iNotificationDialog; |
150 TInt iSoftkeys; |
153 |
151 |
154 /** |
|
155 * Cause code. |
|
156 */ |
|
157 TInt iCauseCode; |
|
158 }; |
152 }; |
159 |
153 |
160 #endif // __TPHONECMDPARAMGLOBALNOTE_H |
154 #endif // __TPHONECMDPARAMGLOBALNOTE_H |
161 |
155 |
162 // End of File |
156 // End of File |