1.1 --- a/epoc32/include/apadef.h Tue Nov 24 13:55:44 2009 +0000
1.2 +++ b/epoc32/include/apadef.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -1,1 +1,291 @@
1.4 -apadef.h
1.5 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
1.6 +// All rights reserved.
1.7 +// This component and the accompanying materials are made available
1.8 +// 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
1.9 +// which accompanies this distribution, and is available
1.10 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.11 +//
1.12 +// Initial Contributors:
1.13 +// Nokia Corporation - initial contribution.
1.14 +//
1.15 +// Contributors:
1.16 +//
1.17 +// Description:
1.18 +//
1.19 +
1.20 +#ifndef __APADEF_H__
1.21 +#define __APADEF_H__
1.22 +
1.23 +#if !defined(__E32BASE_H__)
1.24 +#include <e32base.h>
1.25 +#endif
1.26 +
1.27 +// comand line tokens
1.28 +
1.29 +/**
1.30 +@internalComponent
1.31 +*/
1.32 +const TUint KApaCommandLetterOpen='O';
1.33 +
1.34 +/**
1.35 +@internalComponent
1.36 +*/
1.37 +const TUint KApaCommandLetterCreate='C';
1.38 +
1.39 +/**
1.40 +@internalComponent
1.41 +*/
1.42 +const TUint KApaCommandLetterRun='R';
1.43 +
1.44 +/**
1.45 +@internalComponent
1.46 +*/
1.47 +const TUint KApaCommandLetterBackground='B';
1.48 +
1.49 +/**
1.50 +@internalComponent
1.51 +*/
1.52 +const TUint KApaCommandLetterViewActivate='V';
1.53 +
1.54 +/**
1.55 +@internalComponent
1.56 +*/
1.57 +const TUint KApaCommandLetterRunWithoutViews='W';
1.58 +
1.59 +/**
1.60 +@internalComponent
1.61 +*/
1.62 +const TUint KApaCommandLetterBackgroundAndWithoutViews='A';
1.63 +
1.64 +/** Defines the command codes used to indicate the way an application is to be
1.65 +launched.
1.66 +
1.67 +@publishedAll
1.68 +@released
1.69 +@see CApaCommandLine */
1.70 +enum TApaCommand
1.71 + {
1.72 + /** The application is to open the document specified on the command line. */
1.73 + EApaCommandOpen,
1.74 + /** The application is to create the document specified on the command line. */
1.75 + EApaCommandCreate,
1.76 + /** The application is to run and open the last used document. */
1.77 + EApaCommandRun,
1.78 + /** The application is to open the last used document and to run in the background. */
1.79 + EApaCommandBackground,
1.80 + /** Reserved for future use. */
1.81 + EApaCommandViewActivate,
1.82 + /** The application is to run without views.
1.83 +
1.84 + This should NOT be used for view based applications. */
1.85 + EApaCommandRunWithoutViews,
1.86 + /** The application is to run in the background and viewless mode */
1.87 + EApaCommandBackgroundAndWithoutViews
1.88 + };
1.89 +
1.90 +/**
1.91 +@publishedAll
1.92 +@released
1.93 +*/
1.94 +const TInt KApaMaxAppCaption=0x100; // Default name is a file name, so the same limit is used
1.95 +
1.96 +// TApaAppCaption is the current language name of the app (for task lists, dialogs etc)
1.97 +
1.98 +/** Defines a modifiable buffer descriptor to contain the caption or the short caption
1.99 +for an application.
1.100 +
1.101 +@publishedAll
1.102 +@released */
1.103 +typedef TBuf<KApaMaxAppCaption> TApaAppCaption;
1.104 +
1.105 +/**
1.106 +@internalComponent
1.107 +*/
1.108 +const TInt KApaMaxCommandLine=0x100;
1.109 +
1.110 +/**
1.111 +@internalComponent
1.112 +*/
1.113 +typedef TBuf<KApaMaxCommandLine> TApaCommandLine;
1.114 +
1.115 +/**
1.116 +@internalComponent
1.117 +*/
1.118 +const TInt KApaMaxAppFileName=0x10; // Length of App's filename without path or extension (not it's caption)
1.119 +
1.120 +/**
1.121 +@internalComponent
1.122 +*/
1.123 +typedef TBuf<KApaMaxAppFileName> TApaAppFileName;
1.124 +
1.125 +/** Maximum length of an application group name.
1.126 +
1.127 +@publishedAll
1.128 +@released
1.129 +@see TApaAppGroupName */
1.130 +const TInt KApaMaxAppGroupName=0x10; // Length of App's logical groupname
1.131 +
1.132 +/** An application group name.
1.133 +
1.134 +This is a name that allows applications to be categorized, for instance "Games"
1.135 +or "Utilities".
1.136 +
1.137 +@publishedAll
1.138 +@released */
1.139 +typedef TBuf<KApaMaxAppGroupName> TApaAppGroupName;
1.140 +
1.141 +/** The hexadecimal value of the 2nd UID that identifies a DLL as being an ASCII UI
1.142 +application. In .mmp files, the hexadecimal number is explicitly inserted
1.143 +as the first value following the UID keyword.
1.144 +
1.145 +@publishedAll
1.146 +@deprecated */
1.147 +const TInt KAppUidValue8 = 0x1000006c;
1.148 +
1.149 +/** The 2nd UID that identifies a DLL as being an ASCII UI application.
1.150 +
1.151 +@publishedAll
1.152 +@deprecated */
1.153 +const TUid KUidApp8={KAppUidValue8};
1.154 +
1.155 +/** The hexadecimal value of the 2nd UID that defines a DLL as being a Unicode
1.156 +UI application. In .mmp files, the hexadecimal number is explicitly inserted
1.157 +as the first value following the UID keyword.
1.158 +
1.159 +@publishedAll
1.160 +@released
1.161 +@see KAppUidValue */
1.162 +const TInt KAppUidValue16 = 0x100039CE;
1.163 +
1.164 +/** The 2nd UID that defines a DLL as being a Unicode UI application.
1.165 +
1.166 +@publishedAll
1.167 +@released
1.168 +@see KUidApp */
1.169 +const TUid KUidApp16={KAppUidValue16};
1.170 +
1.171 +//
1.172 +// 2nd Uid for app doc files
1.173 +/**
1.174 +@publishedAll
1.175 +@deprecated
1.176 +*/
1.177 +const TUid KUidAppDllDoc8={268435565};
1.178 +
1.179 +/**
1.180 +@publishedAll
1.181 +@released
1.182 +*/
1.183 +const TUid KUidAppDllDoc16={0x10003A12};
1.184 +
1.185 +/** The UID encoded in a TPictureHeader that identifies a picture as a door (for
1.186 +ASCII builds).
1.187 +
1.188 +@publishedAll
1.189 +@deprecated
1.190 +*/
1.191 +const TUid KUidPictureTypeDoor8={268435537};
1.192 +
1.193 +/** The UID encoded in a TPictureHeader that identifies a picture as a door (for
1.194 +Unicode builds).
1.195 +
1.196 +@publishedAll
1.197 +@released
1.198 +@see KUidPictureTypeDoor */
1.199 +const TUid KUidPictureTypeDoor16={0x10003A33};
1.200 +
1.201 +//
1.202 +// Uid's for streams in stream dictionaries
1.203 +/**
1.204 +@publishedAll
1.205 +@deprecated
1.206 +*/
1.207 +const TUid KUidSecurityStream8={268435661};
1.208 +
1.209 +/**
1.210 +@publishedAll
1.211 +@released
1.212 +*/
1.213 +const TUid KUidSecurityStream16={0x10003A40};
1.214 +
1.215 +/**
1.216 +@publishedAll
1.217 +@deprecated
1.218 +*/
1.219 +const TUid KUidAppIdentifierStream8={268435593}; // stream containing a TApaAppIdentifier
1.220 +
1.221 +/**
1.222 +@publishedAll
1.223 +@released
1.224 +*/
1.225 +const TUid KUidAppIdentifierStream16={0x10003A34};
1.226 +
1.227 +#ifdef _UNICODE
1.228 +/** The type-independent 2nd UID that identifies a DLL as being a UI application.
1.229 +
1.230 +@publishedAll
1.231 +@released
1.232 +@see KUidApp16
1.233 +@see KUidApp8 */
1.234 +#define KUidApp KUidApp16
1.235 +/** The type-independent hexadecimal value of the 2nd UID that identifies a DLL as
1.236 +being a UI application.
1.237 +
1.238 +@publishedAll
1.239 +@released
1.240 +@see KAppUidValue16
1.241 +@see KAppUidValue8 */
1.242 +#define KAppUidValue KAppUidValue16 //lint !e1923 supress could become const variable
1.243 +/**
1.244 +@publishedAll
1.245 +@released
1.246 +*/
1.247 +#define KUidAppDllDoc KUidAppDllDoc16
1.248 +/** The type independent UID encoded in a TPictureHeader that identifies a picture
1.249 +as a door.
1.250 +
1.251 +@publishedAll
1.252 +@released
1.253 +@see KUidPictureTypeDoor16
1.254 +@see KUidPictureTypeDoor8
1.255 +@see TPictureHeader
1.256 +@see TApaModelDoorFactory::NewPictureL() */
1.257 +#define KUidPictureTypeDoor KUidPictureTypeDoor16
1.258 +/**
1.259 +@publishedAll
1.260 +@released
1.261 +*/
1.262 +#define KUidAppIdentifierStream KUidAppIdentifierStream16
1.263 +/**
1.264 +@publishedAll
1.265 +@released
1.266 +*/
1.267 +#define KUidSecurityStream KUidSecurityStream16
1.268 +#else
1.269 +/** The type independent 2nd UID that defines a DLL as being a UI application.
1.270 +
1.271 +@see KUidApp16
1.272 +@see KUidApp8 */
1.273 +#define KUidApp KUidApp8
1.274 +/** The type independent hexadecimal value of the 2nd UID that defines a DLL as
1.275 +being a UI application.
1.276 +
1.277 +@see KAppUidValue16
1.278 +@see KAppUidValue8 */
1.279 +#define KAppUidValue KAppUidValue8
1.280 +#define KUidAppDllDoc KUidAppDllDoc8
1.281 +/** The type independent UID encoded in a TPictureHeader that identifies a picture
1.282 +as a door.
1.283 +
1.284 +@see KUidPictureTypeDoor16
1.285 +@see KUidPictureTypeDoor8
1.286 +@see TPictureHeader
1.287 +@see TApaModelDoorFactory::NewPictureL() */
1.288 +#define KUidPictureTypeDoor KUidPictureTypeDoor8
1.289 +#define KUidAppIdentifierStream KUidAppIdentifierStream8
1.290 +#define KUidSecurityStream KUidSecurityStream8
1.291 +#endif
1.292 +
1.293 +const TUid KUidFileEmbeddedApplicationInterfaceUid={0x101f8c96};
1.294 +
1.295 +#endif