author | hgs |
Mon, 04 Oct 2010 16:06:10 +0300 | |
changeset 76 | cfea66083b62 |
parent 53 | 22cc52eade9b |
permissions | -rw-r--r-- |
37 | 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> |
|
53 | 26 |
//#include <AknGlobalNote.h> // for CAknGlobalNote |
27 |
||
37 | 28 |
#include "tphonecommandparam.h" |
29 |
||
30 |
// DATA TYPES |
|
76 | 31 |
enum TPhoneNotificationType |
32 |
{ |
|
53 | 33 |
EPhoneNotificationDialog = 0, // notify of a state change that does not require user input. |
34 |
EPhoneMessageBoxInformation, |
|
35 |
EPhoneMessageBoxWarning |
|
76 | 36 |
}; |
37 |
||
38 |
enum TPhoneNotificationToneType |
|
39 |
{ |
|
40 |
EPhoneNoTone = 0, |
|
41 |
EPhoneInformationTone, |
|
42 |
EPhoneWarningTone, |
|
43 |
EPhoneConfirmationTone, |
|
44 |
EPhoneErrorTone |
|
45 |
}; |
|
37 | 46 |
// CLASS DECLARATION |
47 |
||
48 |
/** |
|
49 |
* A parameter class for global note information. |
|
50 |
*/ |
|
51 |
class TPhoneCmdParamGlobalNote : public TPhoneUICommandParam |
|
52 |
{ |
|
53 |
public: |
|
54 |
||
55 |
/** |
|
56 |
* C++ default constructor. |
|
57 |
*/ |
|
58 |
IMPORT_C TPhoneCmdParamGlobalNote(); |
|
59 |
||
60 |
public: |
|
61 |
||
62 |
/** |
|
63 |
* Sets the global note type. |
|
64 |
* @param aType is the global note type |
|
65 |
*/ |
|
76 | 66 |
IMPORT_C void SetType( TPhoneNotificationType aType ); |
37 | 67 |
|
68 |
/** |
|
69 |
* Sets the text resource ID for the global note |
|
70 |
* @param aResourceId is the global note resource ID |
|
71 |
*/ |
|
72 |
IMPORT_C void SetTextResourceId( TInt aTextResourceId ); |
|
73 |
||
74 |
/** |
|
75 |
* Sets the text for the global note. |
|
76 |
* @param aText is the global note text |
|
77 |
*/ |
|
78 |
IMPORT_C void SetText( const TDesC& aText ); |
|
79 |
||
53 | 80 |
/** |
37 | 81 |
* Sets timeout for a note. |
82 |
* @param aTimeout Timeout in milliseconds. If timeout == 0 then |
|
83 |
* default timeout is used. If timeout < 0 the note is not closed |
|
84 |
* automatically. |
|
85 |
*/ |
|
86 |
IMPORT_C void SetTimeout( TInt aTimeout ); |
|
87 |
||
88 |
/** |
|
45
6b911d05207e
Revision: 201023
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
37
diff
changeset
|
89 |
* Sets notification dialog flag. |
6b911d05207e
Revision: 201023
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
37
diff
changeset
|
90 |
* @param aNotificationDialog True if notification dialog |
6b911d05207e
Revision: 201023
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
37
diff
changeset
|
91 |
* should be used. |
6b911d05207e
Revision: 201023
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
37
diff
changeset
|
92 |
*/ |
6b911d05207e
Revision: 201023
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
37
diff
changeset
|
93 |
IMPORT_C void SetNotificationDialog( TBool aNotificationDialog ); |
6b911d05207e
Revision: 201023
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
37
diff
changeset
|
94 |
|
6b911d05207e
Revision: 201023
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
37
diff
changeset
|
95 |
/** |
46
bc5a64e5bc3c
Revision: 201025
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
45
diff
changeset
|
96 |
* Sets cause code. |
bc5a64e5bc3c
Revision: 201025
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
45
diff
changeset
|
97 |
* @param aCauseCode Cause code. |
bc5a64e5bc3c
Revision: 201025
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
45
diff
changeset
|
98 |
*/ |
bc5a64e5bc3c
Revision: 201025
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
45
diff
changeset
|
99 |
IMPORT_C void SetCauseCode( TInt aCauseCode ); |
bc5a64e5bc3c
Revision: 201025
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
45
diff
changeset
|
100 |
|
bc5a64e5bc3c
Revision: 201025
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
45
diff
changeset
|
101 |
/** |
76 | 102 |
* Sets tone type. |
103 |
* @param aToneType Type of tone. |
|
104 |
*/ |
|
105 |
IMPORT_C void SetToneType( TPhoneNotificationToneType aCauseCode ); |
|
106 |
||
107 |
/** |
|
108 |
* Returns tone type. |
|
109 |
* @return Type of tone. |
|
110 |
*/ |
|
111 |
IMPORT_C TPhoneNotificationToneType ToneType() const; |
|
112 |
||
113 |
/** |
|
37 | 114 |
* Returns the global note type |
115 |
* @return Returns the type |
|
116 |
*/ |
|
76 | 117 |
IMPORT_C TPhoneNotificationType Type() const; |
37 | 118 |
|
119 |
/** |
|
120 |
* Returns the global note text resource ID. |
|
121 |
* @return Returns the global note text resource ID. |
|
122 |
*/ |
|
123 |
IMPORT_C TInt TextResourceId() const; |
|
124 |
||
125 |
/** |
|
126 |
* Returns the global note text |
|
127 |
* @return Returns the text |
|
128 |
*/ |
|
129 |
IMPORT_C const TDesC& Text() const; |
|
130 |
||
131 |
/** |
|
132 |
* Returns the timeout value. |
|
133 |
* @return Timeout value. |
|
134 |
*/ |
|
135 |
IMPORT_C TInt Timeout() const; |
|
45
6b911d05207e
Revision: 201023
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
37
diff
changeset
|
136 |
|
6b911d05207e
Revision: 201023
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
37
diff
changeset
|
137 |
/** |
6b911d05207e
Revision: 201023
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
37
diff
changeset
|
138 |
* Returns the notification dialog flag. |
6b911d05207e
Revision: 201023
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
37
diff
changeset
|
139 |
* @return Notification dialog flag. |
6b911d05207e
Revision: 201023
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
37
diff
changeset
|
140 |
*/ |
6b911d05207e
Revision: 201023
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
37
diff
changeset
|
141 |
IMPORT_C TBool NotificationDialog() const; |
46
bc5a64e5bc3c
Revision: 201025
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
45
diff
changeset
|
142 |
|
bc5a64e5bc3c
Revision: 201025
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
45
diff
changeset
|
143 |
/** |
bc5a64e5bc3c
Revision: 201025
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
45
diff
changeset
|
144 |
* Returns cause code. |
bc5a64e5bc3c
Revision: 201025
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
45
diff
changeset
|
145 |
* @return Cause code. |
bc5a64e5bc3c
Revision: 201025
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
45
diff
changeset
|
146 |
*/ |
bc5a64e5bc3c
Revision: 201025
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
45
diff
changeset
|
147 |
IMPORT_C TInt CauseCode() const; |
37 | 148 |
|
149 |
private: |
|
150 |
||
151 |
/** |
|
152 |
* Global note type |
|
153 |
*/ |
|
76 | 154 |
TPhoneNotificationType iType; |
53 | 155 |
|
37 | 156 |
/** |
157 |
* Global note text resource ID |
|
158 |
*/ |
|
159 |
TInt iTextResourceId; |
|
160 |
||
161 |
/** |
|
162 |
* Global note text |
|
163 |
*/ |
|
164 |
TPtrC iText; |
|
165 |
||
166 |
/** |
|
167 |
* Timeout for a note. |
|
168 |
*/ |
|
169 |
TInt iTimeout; |
|
45
6b911d05207e
Revision: 201023
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
37
diff
changeset
|
170 |
|
6b911d05207e
Revision: 201023
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
37
diff
changeset
|
171 |
/** |
6b911d05207e
Revision: 201023
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
37
diff
changeset
|
172 |
* Notification Dialog flag. |
6b911d05207e
Revision: 201023
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
37
diff
changeset
|
173 |
*/ |
6b911d05207e
Revision: 201023
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
37
diff
changeset
|
174 |
TBool iNotificationDialog; |
6b911d05207e
Revision: 201023
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
37
diff
changeset
|
175 |
|
46
bc5a64e5bc3c
Revision: 201025
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
45
diff
changeset
|
176 |
/** |
bc5a64e5bc3c
Revision: 201025
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
45
diff
changeset
|
177 |
* Cause code. |
bc5a64e5bc3c
Revision: 201025
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
45
diff
changeset
|
178 |
*/ |
bc5a64e5bc3c
Revision: 201025
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
45
diff
changeset
|
179 |
TInt iCauseCode; |
76 | 180 |
|
181 |
/** |
|
182 |
* Notification tone type |
|
183 |
*/ |
|
184 |
TPhoneNotificationToneType iToneType; |
|
37 | 185 |
}; |
186 |
||
187 |
#endif // __TPHONECMDPARAMGLOBALNOTE_H |
|
188 |
||
189 |
// End of File |