appfw/apparchitecture/inc/APADEF.H
changeset 0 2e3d3ce01487
equal deleted inserted replaced
-1:000000000000 0:2e3d3ce01487
       
     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 "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 // apadef.h
       
    15 //
       
    16 
       
    17 #ifndef __APADEF_H__
       
    18 #define __APADEF_H__
       
    19 
       
    20 #include <e32base.h>
       
    21 
       
    22 /** Defines the command codes used to indicate the way an application is to be 
       
    23 launched.
       
    24 
       
    25 @publishedAll 
       
    26 @released
       
    27 @see CApaCommandLine */
       
    28 enum TApaCommand
       
    29 	{
       
    30 	/** The application is to open the document specified on the command line. */
       
    31 	EApaCommandOpen,
       
    32 	/** The application is to create the document specified on the command line. */
       
    33 	EApaCommandCreate,
       
    34 	/** The application is to run and open the last used document. */
       
    35 	EApaCommandRun,
       
    36 	/** The application is to open the last used document and to run in the background. */
       
    37 	EApaCommandBackground,
       
    38 	/** Reserved for future use. */
       
    39 	EApaCommandViewActivate,
       
    40 	/** The application is to run without views.
       
    41 	
       
    42 	This should NOT be used for view based applications. */
       
    43 	EApaCommandRunWithoutViews,
       
    44 	/** The application is to run in the background and viewless mode */
       
    45 	EApaCommandBackgroundAndWithoutViews
       
    46 	};
       
    47 
       
    48 /**
       
    49 @publishedAll 
       
    50 @released
       
    51 */
       
    52 const TInt KApaMaxAppCaption=0x100;	// Default name is a file name, so the same limit is used
       
    53 
       
    54 // TApaAppCaption is the current language name of the app (for task lists, dialogs etc)
       
    55 
       
    56 /** Defines a modifiable buffer descriptor to contain the caption or the short caption 
       
    57 for an application. 
       
    58 
       
    59 @publishedAll 
       
    60 @released */
       
    61 typedef TBuf<KApaMaxAppCaption> TApaAppCaption; 
       
    62 
       
    63 #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
       
    64 /**
       
    65 @internalComponent
       
    66 */
       
    67 const TInt KApaMaxCommandLine=0x100;	
       
    68 
       
    69 /**
       
    70 @internalComponent
       
    71 */
       
    72 typedef TBuf<KApaMaxCommandLine> TApaCommandLine;
       
    73 
       
    74 #endif //SYMBIAN_ENABLE_SPLIT_HEADERS
       
    75 
       
    76 /** Maximum length of an application group name.
       
    77 
       
    78 @publishedAll 
       
    79 @released
       
    80 @see TApaAppGroupName */
       
    81 const TInt KApaMaxAppGroupName=0x10; // Length of App's logical groupname
       
    82 
       
    83 /** An application group name.
       
    84 
       
    85 This is a name that allows applications to be categorized, for instance "Games" 
       
    86 or "Utilities". 
       
    87 
       
    88 @publishedAll 
       
    89 @released */
       
    90 typedef TBuf<KApaMaxAppGroupName> TApaAppGroupName;
       
    91 
       
    92 /** The hexadecimal value of the 2nd UID that defines a DLL as being a Unicode 
       
    93 UI application. In .mmp files, the hexadecimal number is explicitly inserted 
       
    94 as the first value following the UID keyword.
       
    95 
       
    96 @publishedAll 
       
    97 @released
       
    98 @see KAppUidValue */
       
    99 const TInt KAppUidValue16 = 0x100039CE;
       
   100 
       
   101 /** The 2nd UID that defines a DLL as being a Unicode UI application.
       
   102 
       
   103 @publishedAll 
       
   104 @released
       
   105 @see KUidApp */
       
   106 const TUid KUidApp16={KAppUidValue16};
       
   107 
       
   108 //
       
   109 // 2nd Uid for app doc files
       
   110 /**
       
   111 @publishedAll 
       
   112 @released
       
   113 */
       
   114 const TUid KUidAppDllDoc16={0x10003A12};
       
   115 
       
   116 /** The UID encoded in a TPictureHeader that identifies a picture as a door (for 
       
   117 Unicode builds).
       
   118 
       
   119 @publishedAll 
       
   120 @released
       
   121 @see KUidPictureTypeDoor */
       
   122 const TUid KUidPictureTypeDoor16={0x10003A33};
       
   123 
       
   124 //
       
   125 // Uid's for streams in stream dictionaries
       
   126 
       
   127 /**
       
   128 @publishedAll 
       
   129 @released
       
   130 */
       
   131 const TUid KUidSecurityStream16={0x10003A40};
       
   132 
       
   133 /**
       
   134 @publishedAll 
       
   135 @released
       
   136 */
       
   137 const TUid KUidAppIdentifierStream16={0x10003A34};
       
   138 
       
   139 /** The type-independent 2nd UID that identifies a DLL as being a UI application.
       
   140 
       
   141 @publishedAll 
       
   142 @released
       
   143 @see KUidApp16 */
       
   144 #define KUidApp KUidApp16
       
   145 
       
   146 /** The type-independent hexadecimal value of the 2nd UID that identifies a DLL as 
       
   147 being a UI application.
       
   148 
       
   149 @publishedAll 
       
   150 @released
       
   151 @see KAppUidValue16 */
       
   152 #define KAppUidValue KAppUidValue16 //lint !e1923 supress could become const variable
       
   153 
       
   154 /**
       
   155 @publishedAll 
       
   156 @released
       
   157 */
       
   158 #define KUidAppDllDoc KUidAppDllDoc16
       
   159 
       
   160 /** The type independent UID encoded in a TPictureHeader that identifies a picture 
       
   161 as a door.
       
   162 
       
   163 @publishedAll 
       
   164 @released
       
   165 @see KUidPictureTypeDoor16
       
   166 @see TPictureHeader
       
   167 @see TApaModelDoorFactory::NewPictureL() */
       
   168 #define KUidPictureTypeDoor KUidPictureTypeDoor16
       
   169 
       
   170 /**
       
   171 @publishedAll 
       
   172 @released
       
   173 */
       
   174 #define KUidAppIdentifierStream KUidAppIdentifierStream16
       
   175 
       
   176 /**
       
   177 @publishedAll 
       
   178 @released
       
   179 */
       
   180 #define KUidSecurityStream KUidSecurityStream16
       
   181 
       
   182 
       
   183 const TUid KUidFileEmbeddedApplicationInterfaceUid={0x101f8c96};
       
   184 
       
   185 #endif	// __APADEF_H__