|
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 * A paramater class for application information. |
|
16 * |
|
17 */ |
|
18 |
|
19 |
|
20 #ifndef __TPHONECMDPARAMAPPINFO_H |
|
21 #define __TPHONECMDPARAMAPPINFO_H |
|
22 |
|
23 // INCLUDES |
|
24 |
|
25 #include "tphonecommandparam.h" |
|
26 |
|
27 // DATA TYPES |
|
28 |
|
29 // CLASS DECLARATION |
|
30 |
|
31 /** |
|
32 * A paramater class for identifying view. |
|
33 */ |
|
34 class TPhoneCmdParamAppInfo : public TPhoneUICommandParam |
|
35 { |
|
36 public: |
|
37 |
|
38 /** |
|
39 * Constructor. |
|
40 */ |
|
41 IMPORT_C TPhoneCmdParamAppInfo(); |
|
42 |
|
43 /** |
|
44 * Sets application uid. |
|
45 * @param aAppUid, Id of app. |
|
46 * @return None. |
|
47 */ |
|
48 IMPORT_C void SetAppUid( const TUid& aAppUid ); |
|
49 |
|
50 /** |
|
51 * Sets view uid. |
|
52 * @param aViewUid, Id of view. |
|
53 * @return None. |
|
54 */ |
|
55 IMPORT_C void SetViewUid( const TUid& aViewUid ); |
|
56 |
|
57 /** |
|
58 * Sets application parameter. |
|
59 * @param aParam |
|
60 * @return None. |
|
61 */ |
|
62 IMPORT_C void SetParam( const TDesC8& aParam ); |
|
63 |
|
64 /** |
|
65 * Sets Custom Message Id. |
|
66 * @param aCustomMessageId |
|
67 * @return None. |
|
68 */ |
|
69 IMPORT_C void SetCustomMessageId( const TUid& aCustomMessageId ); |
|
70 |
|
71 /** |
|
72 * Sets Custom Message. |
|
73 * @param aCustomMessage |
|
74 * @return None. |
|
75 */ |
|
76 IMPORT_C void SetCustomMessage( const TDesC8& aCustomMessage ); |
|
77 |
|
78 /** |
|
79 * Sets multiple instances status for the application |
|
80 * @param aMultipleInstances is ETrue if there are multiple instances |
|
81 * of the application. |
|
82 */ |
|
83 IMPORT_C void SetMultipleInstances( TBool aMultipleInstances ); |
|
84 |
|
85 /** |
|
86 * Returns App uid. |
|
87 * @param None. |
|
88 * @return iAppUid. |
|
89 */ |
|
90 IMPORT_C TUid AppUid() const; |
|
91 |
|
92 /** |
|
93 * Returns View uid. |
|
94 * @param None. |
|
95 * @return iViewUid. |
|
96 */ |
|
97 IMPORT_C TUid ViewUid() const; |
|
98 |
|
99 /** |
|
100 * Returns App parameter. |
|
101 * @param None. |
|
102 * @return iParam. |
|
103 */ |
|
104 IMPORT_C const TDesC8& Param() const; |
|
105 |
|
106 /** |
|
107 * Returns Custom Message Id. |
|
108 * @param None. |
|
109 * @return iCustomMessageId. |
|
110 */ |
|
111 IMPORT_C TUid CustomMessageId() const; |
|
112 |
|
113 /** |
|
114 * Returns CustomMessage. |
|
115 * @param None. |
|
116 * @return iMessage. |
|
117 */ |
|
118 IMPORT_C const TDesC8& CustomMessage() const; |
|
119 |
|
120 /** |
|
121 * Returns multiple instance status of the application. |
|
122 * @return Returns ETrue if there are multiple instances of the |
|
123 * application. |
|
124 */ |
|
125 IMPORT_C TBool MultipleInstances() const; |
|
126 |
|
127 private: |
|
128 |
|
129 /** |
|
130 * App UID. |
|
131 */ |
|
132 TUid iAppUid; |
|
133 |
|
134 /** |
|
135 * App view UID. |
|
136 */ |
|
137 TUid iViewUid; |
|
138 |
|
139 /** |
|
140 * App parameter |
|
141 */ |
|
142 TPtrC8 iParam; |
|
143 |
|
144 /** |
|
145 * Custom message ID. |
|
146 */ |
|
147 TUid iCustomMessageId; |
|
148 |
|
149 /** |
|
150 * Custom message |
|
151 */ |
|
152 TPtrC8 iCustomMessage; |
|
153 |
|
154 /** |
|
155 * Indicates that they are multiple instance for this application |
|
156 */ |
|
157 TBool iMultipleInstances; |
|
158 |
|
159 }; |
|
160 |
|
161 #endif // __TPHONECMDPARAMAPPINFO_H |
|
162 |
|
163 // End of File |