|
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 /** |
|
85 * Returns the global note type |
|
86 * @return Returns the type |
|
87 */ |
|
88 IMPORT_C TAknGlobalNoteType Type() const; |
|
89 |
|
90 /** |
|
91 * Returns the global note text resource ID. |
|
92 * @return Returns the global note text resource ID. |
|
93 */ |
|
94 IMPORT_C TInt TextResourceId() const; |
|
95 |
|
96 /** |
|
97 * Returns the global note text |
|
98 * @return Returns the text |
|
99 */ |
|
100 IMPORT_C const TDesC& Text() const; |
|
101 |
|
102 /** |
|
103 * Returns the global note tone. |
|
104 * @return Returns the global note tone |
|
105 */ |
|
106 IMPORT_C TInt Tone() const; |
|
107 |
|
108 /** |
|
109 * Gets the global note wait status |
|
110 * @return ETrue if wait for completed |
|
111 */ |
|
112 IMPORT_C TBool WaitForReady() const; |
|
113 |
|
114 /** |
|
115 * Returns the global note softkeys. |
|
116 * @return Returns the global note softkeys |
|
117 */ |
|
118 IMPORT_C TInt Softkeys() const; |
|
119 |
|
120 private: |
|
121 |
|
122 /** |
|
123 * Global note type |
|
124 */ |
|
125 TAknGlobalNoteType iType; |
|
126 |
|
127 /** |
|
128 * Global note text resource ID |
|
129 */ |
|
130 TInt iTextResourceId; |
|
131 |
|
132 /** |
|
133 * Global note text |
|
134 */ |
|
135 TPtrC iText; |
|
136 |
|
137 /** |
|
138 * Global note tone |
|
139 */ |
|
140 TInt iTone; |
|
141 |
|
142 /** |
|
143 * Wait for ready status |
|
144 */ |
|
145 TBool iWaitforReady; |
|
146 |
|
147 /** |
|
148 * Global note softkeys |
|
149 */ |
|
150 TInt iSoftkeys; |
|
151 |
|
152 }; |
|
153 |
|
154 #endif // __TPHONECMDPARAMGLOBALNOTE_H |
|
155 |
|
156 // End of File |