1 apadef.h |
1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies). |
|
2 // All rights reserved. |
|
3 // This component and the accompanying materials are made available |
|
4 // under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members |
|
5 // which accompanies this distribution, and is available |
|
6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html". |
|
7 // |
|
8 // Initial Contributors: |
|
9 // Nokia Corporation - initial contribution. |
|
10 // |
|
11 // Contributors: |
|
12 // |
|
13 // Description: |
|
14 // |
|
15 |
|
16 #ifndef __APADEF_H__ |
|
17 #define __APADEF_H__ |
|
18 |
|
19 #if !defined(__E32BASE_H__) |
|
20 #include <e32base.h> |
|
21 #endif |
|
22 |
|
23 // comand line tokens |
|
24 |
|
25 /** |
|
26 @internalComponent |
|
27 */ |
|
28 const TUint KApaCommandLetterOpen='O'; |
|
29 |
|
30 /** |
|
31 @internalComponent |
|
32 */ |
|
33 const TUint KApaCommandLetterCreate='C'; |
|
34 |
|
35 /** |
|
36 @internalComponent |
|
37 */ |
|
38 const TUint KApaCommandLetterRun='R'; |
|
39 |
|
40 /** |
|
41 @internalComponent |
|
42 */ |
|
43 const TUint KApaCommandLetterBackground='B'; |
|
44 |
|
45 /** |
|
46 @internalComponent |
|
47 */ |
|
48 const TUint KApaCommandLetterViewActivate='V'; |
|
49 |
|
50 /** |
|
51 @internalComponent |
|
52 */ |
|
53 const TUint KApaCommandLetterRunWithoutViews='W'; |
|
54 |
|
55 /** |
|
56 @internalComponent |
|
57 */ |
|
58 const TUint KApaCommandLetterBackgroundAndWithoutViews='A'; |
|
59 |
|
60 /** Defines the command codes used to indicate the way an application is to be |
|
61 launched. |
|
62 |
|
63 @publishedAll |
|
64 @released |
|
65 @see CApaCommandLine */ |
|
66 enum TApaCommand |
|
67 { |
|
68 /** The application is to open the document specified on the command line. */ |
|
69 EApaCommandOpen, |
|
70 /** The application is to create the document specified on the command line. */ |
|
71 EApaCommandCreate, |
|
72 /** The application is to run and open the last used document. */ |
|
73 EApaCommandRun, |
|
74 /** The application is to open the last used document and to run in the background. */ |
|
75 EApaCommandBackground, |
|
76 /** Reserved for future use. */ |
|
77 EApaCommandViewActivate, |
|
78 /** The application is to run without views. |
|
79 |
|
80 This should NOT be used for view based applications. */ |
|
81 EApaCommandRunWithoutViews, |
|
82 /** The application is to run in the background and viewless mode */ |
|
83 EApaCommandBackgroundAndWithoutViews |
|
84 }; |
|
85 |
|
86 /** |
|
87 @publishedAll |
|
88 @released |
|
89 */ |
|
90 const TInt KApaMaxAppCaption=0x100; // Default name is a file name, so the same limit is used |
|
91 |
|
92 // TApaAppCaption is the current language name of the app (for task lists, dialogs etc) |
|
93 |
|
94 /** Defines a modifiable buffer descriptor to contain the caption or the short caption |
|
95 for an application. |
|
96 |
|
97 @publishedAll |
|
98 @released */ |
|
99 typedef TBuf<KApaMaxAppCaption> TApaAppCaption; |
|
100 |
|
101 /** |
|
102 @internalComponent |
|
103 */ |
|
104 const TInt KApaMaxCommandLine=0x100; |
|
105 |
|
106 /** |
|
107 @internalComponent |
|
108 */ |
|
109 typedef TBuf<KApaMaxCommandLine> TApaCommandLine; |
|
110 |
|
111 /** |
|
112 @internalComponent |
|
113 */ |
|
114 const TInt KApaMaxAppFileName=0x10; // Length of App's filename without path or extension (not it's caption) |
|
115 |
|
116 /** |
|
117 @internalComponent |
|
118 */ |
|
119 typedef TBuf<KApaMaxAppFileName> TApaAppFileName; |
|
120 |
|
121 /** Maximum length of an application group name. |
|
122 |
|
123 @publishedAll |
|
124 @released |
|
125 @see TApaAppGroupName */ |
|
126 const TInt KApaMaxAppGroupName=0x10; // Length of App's logical groupname |
|
127 |
|
128 /** An application group name. |
|
129 |
|
130 This is a name that allows applications to be categorized, for instance "Games" |
|
131 or "Utilities". |
|
132 |
|
133 @publishedAll |
|
134 @released */ |
|
135 typedef TBuf<KApaMaxAppGroupName> TApaAppGroupName; |
|
136 |
|
137 /** The hexadecimal value of the 2nd UID that identifies a DLL as being an ASCII UI |
|
138 application. In .mmp files, the hexadecimal number is explicitly inserted |
|
139 as the first value following the UID keyword. |
|
140 |
|
141 @publishedAll |
|
142 @deprecated */ |
|
143 const TInt KAppUidValue8 = 0x1000006c; |
|
144 |
|
145 /** The 2nd UID that identifies a DLL as being an ASCII UI application. |
|
146 |
|
147 @publishedAll |
|
148 @deprecated */ |
|
149 const TUid KUidApp8={KAppUidValue8}; |
|
150 |
|
151 /** The hexadecimal value of the 2nd UID that defines a DLL as being a Unicode |
|
152 UI application. In .mmp files, the hexadecimal number is explicitly inserted |
|
153 as the first value following the UID keyword. |
|
154 |
|
155 @publishedAll |
|
156 @released |
|
157 @see KAppUidValue */ |
|
158 const TInt KAppUidValue16 = 0x100039CE; |
|
159 |
|
160 /** The 2nd UID that defines a DLL as being a Unicode UI application. |
|
161 |
|
162 @publishedAll |
|
163 @released |
|
164 @see KUidApp */ |
|
165 const TUid KUidApp16={KAppUidValue16}; |
|
166 |
|
167 // |
|
168 // 2nd Uid for app doc files |
|
169 /** |
|
170 @publishedAll |
|
171 @deprecated |
|
172 */ |
|
173 const TUid KUidAppDllDoc8={268435565}; |
|
174 |
|
175 /** |
|
176 @publishedAll |
|
177 @released |
|
178 */ |
|
179 const TUid KUidAppDllDoc16={0x10003A12}; |
|
180 |
|
181 /** The UID encoded in a TPictureHeader that identifies a picture as a door (for |
|
182 ASCII builds). |
|
183 |
|
184 @publishedAll |
|
185 @deprecated |
|
186 */ |
|
187 const TUid KUidPictureTypeDoor8={268435537}; |
|
188 |
|
189 /** The UID encoded in a TPictureHeader that identifies a picture as a door (for |
|
190 Unicode builds). |
|
191 |
|
192 @publishedAll |
|
193 @released |
|
194 @see KUidPictureTypeDoor */ |
|
195 const TUid KUidPictureTypeDoor16={0x10003A33}; |
|
196 |
|
197 // |
|
198 // Uid's for streams in stream dictionaries |
|
199 /** |
|
200 @publishedAll |
|
201 @deprecated |
|
202 */ |
|
203 const TUid KUidSecurityStream8={268435661}; |
|
204 |
|
205 /** |
|
206 @publishedAll |
|
207 @released |
|
208 */ |
|
209 const TUid KUidSecurityStream16={0x10003A40}; |
|
210 |
|
211 /** |
|
212 @publishedAll |
|
213 @deprecated |
|
214 */ |
|
215 const TUid KUidAppIdentifierStream8={268435593}; // stream containing a TApaAppIdentifier |
|
216 |
|
217 /** |
|
218 @publishedAll |
|
219 @released |
|
220 */ |
|
221 const TUid KUidAppIdentifierStream16={0x10003A34}; |
|
222 |
|
223 #ifdef _UNICODE |
|
224 /** The type-independent 2nd UID that identifies a DLL as being a UI application. |
|
225 |
|
226 @publishedAll |
|
227 @released |
|
228 @see KUidApp16 |
|
229 @see KUidApp8 */ |
|
230 #define KUidApp KUidApp16 |
|
231 /** The type-independent hexadecimal value of the 2nd UID that identifies a DLL as |
|
232 being a UI application. |
|
233 |
|
234 @publishedAll |
|
235 @released |
|
236 @see KAppUidValue16 |
|
237 @see KAppUidValue8 */ |
|
238 #define KAppUidValue KAppUidValue16 //lint !e1923 supress could become const variable |
|
239 /** |
|
240 @publishedAll |
|
241 @released |
|
242 */ |
|
243 #define KUidAppDllDoc KUidAppDllDoc16 |
|
244 /** The type independent UID encoded in a TPictureHeader that identifies a picture |
|
245 as a door. |
|
246 |
|
247 @publishedAll |
|
248 @released |
|
249 @see KUidPictureTypeDoor16 |
|
250 @see KUidPictureTypeDoor8 |
|
251 @see TPictureHeader |
|
252 @see TApaModelDoorFactory::NewPictureL() */ |
|
253 #define KUidPictureTypeDoor KUidPictureTypeDoor16 |
|
254 /** |
|
255 @publishedAll |
|
256 @released |
|
257 */ |
|
258 #define KUidAppIdentifierStream KUidAppIdentifierStream16 |
|
259 /** |
|
260 @publishedAll |
|
261 @released |
|
262 */ |
|
263 #define KUidSecurityStream KUidSecurityStream16 |
|
264 #else |
|
265 /** The type independent 2nd UID that defines a DLL as being a UI application. |
|
266 |
|
267 @see KUidApp16 |
|
268 @see KUidApp8 */ |
|
269 #define KUidApp KUidApp8 |
|
270 /** The type independent hexadecimal value of the 2nd UID that defines a DLL as |
|
271 being a UI application. |
|
272 |
|
273 @see KAppUidValue16 |
|
274 @see KAppUidValue8 */ |
|
275 #define KAppUidValue KAppUidValue8 |
|
276 #define KUidAppDllDoc KUidAppDllDoc8 |
|
277 /** The type independent UID encoded in a TPictureHeader that identifies a picture |
|
278 as a door. |
|
279 |
|
280 @see KUidPictureTypeDoor16 |
|
281 @see KUidPictureTypeDoor8 |
|
282 @see TPictureHeader |
|
283 @see TApaModelDoorFactory::NewPictureL() */ |
|
284 #define KUidPictureTypeDoor KUidPictureTypeDoor8 |
|
285 #define KUidAppIdentifierStream KUidAppIdentifierStream8 |
|
286 #define KUidSecurityStream KUidSecurityStream8 |
|
287 #endif |
|
288 |
|
289 const TUid KUidFileEmbeddedApplicationInterfaceUid={0x101f8c96}; |
|
290 |
|
291 #endif |