localisation/apparchitecture/inc/AppInfo.rh
branchSymbian2
changeset 1 8758140453c0
child 6 c108117318cb
equal deleted inserted replaced
0:e8c1ea2c6496 1:8758140453c0
       
     1 // Copyright (c) 2004-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"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.symbianfoundation.org/legal/sfl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 //
       
    15 
       
    16 #if !defined __APPINFO_RH__
       
    17 #define __APPINFO_RH__
       
    18 
       
    19 //
       
    20 // contains definitions for the Application Information resource files
       
    21 
       
    22 /**
       
    23 @publishedAll
       
    24 @released
       
    25 */
       
    26 #define KMaxFileNameLength 256
       
    27 
       
    28 //////////////////////////////////////////////////////////////////
       
    29 // DEFINITIONS FOR THE NON-LOCALISABLE REGISTRATION RESOURCE FILE
       
    30 //////////////////////////////////////////////////////////////////
       
    31 
       
    32 /**
       
    33 @publishedAll
       
    34 @released
       
    35 */
       
    36 #define KUidAppRegistrationResourceFile 0x101f8021
       
    37 
       
    38 /**
       
    39 @publishedAll
       
    40 @released
       
    41 */
       
    42 // constants for capability.hidden
       
    43 #define KAppNotHidden	0
       
    44 #define KAppIsHidden	1
       
    45 
       
    46 /**
       
    47 @publishedAll
       
    48 @released
       
    49 */
       
    50 // constants for capability.newfile
       
    51 #define KAppDoesNotSupportNewFile	0
       
    52 #define KAppSupportsNewFile			1
       
    53 
       
    54 /**
       
    55 @publishedAll
       
    56 @released
       
    57 */
       
    58 // constants for capability.embeddability
       
    59 #define KAppNotEmbeddable				0
       
    60 #define KAppEmbeddable					1
       
    61 #define KAppEmbeddableOnly				2
       
    62 #define KAppEmbeddableUiOrStandAlone	5
       
    63 #define KAppEmbeddableUiNotStandAlone	6
       
    64 
       
    65 /**
       
    66 @publishedAll
       
    67 @released
       
    68 */
       
    69 // constants for capability.launch
       
    70 #define KAppLaunchInForeground	0
       
    71 #define KAppLaunchInBackground	1
       
    72 
       
    73 /**
       
    74 @publishedAll
       
    75 @released
       
    76 */
       
    77 // bit flags for capability.attributes
       
    78 #define KAppBuiltAsDll				0x00000001
       
    79 #define KAppIsControlPanelItem		0x00000002
       
    80 #define KAppNonNative				0x00000004
       
    81 
       
    82 /**
       
    83 @publishedAll
       
    84 @released
       
    85 */
       
    86 // application group name
       
    87 #define KAppMaxGroupName 16
       
    88 
       
    89 
       
    90 /**
       
    91 @publishedAll
       
    92 @released
       
    93 */
       
    94 STRUCT APP_REGISTRATION_INFO
       
    95 	{
       
    96 	LONG reserved_long = 0; // reserved for future use, do not use
       
    97 	LLINK reserved_llink = 0; // reserved for future use, do not use
       
    98 	//
       
    99 	LTEXT app_file(KMaxFileNameLength) = ""; // name of application binary file (not including extension) - mandatory
       
   100 	LONG attributes = 0;
       
   101 	//
       
   102 	LTEXT localisable_resource_file(KMaxFileNameLength) = ""; // path (not including drive) and name of localisable resource file
       
   103 	LONG localisable_resource_id = 1;
       
   104 	//
       
   105 	BYTE hidden = KAppNotHidden;
       
   106 	BYTE embeddability = KAppNotEmbeddable;
       
   107 	BYTE newfile = KAppDoesNotSupportNewFile;
       
   108 	BYTE launch = KAppLaunchInForeground;
       
   109 	LTEXT group_name(KAppMaxGroupName) = "";
       
   110 	//
       
   111 	BYTE default_screen_number = 0;
       
   112 	//
       
   113 	LEN WORD STRUCT datatype_list[]; // DATATYPE
       
   114 	//
       
   115 	LEN WORD STRUCT file_ownership_list[]; // FILE_OWNERSHIP_INFO
       
   116 	//
       
   117 	LEN WORD STRUCT service_list[]; // SERVICE_INFO
       
   118 	//
       
   119 	LLINK opaque_data = 0;	// use for opaque data to send to non-native application launchers i.e. MIDlet id
       
   120 	}
       
   121 
       
   122 
       
   123 /**
       
   124 @publishedAll
       
   125 @released
       
   126 */
       
   127 #define KMaxDataTypeLength 256
       
   128 
       
   129 /**
       
   130 @publishedAll
       
   131 @released
       
   132 */
       
   133 enum
       
   134 	{
       
   135 	EDataTypePrioritySystem = 0xFFF9,
       
   136 	EDataTypePriorityHigh = 10000,
       
   137 	EDataTypePriorityNormal = 0,
       
   138 	EDataTypePriorityLow = -10000,
       
   139 	EDataTypePriorityLastResort = -20000
       
   140 	};
       
   141 
       
   142 /**
       
   143 @publishedAll
       
   144 @released
       
   145 */
       
   146 STRUCT DATATYPE
       
   147 	{
       
   148 	LONG priority;
       
   149 	LTEXT8 type(KMaxDataTypeLength);
       
   150 	}
       
   151 
       
   152 /**
       
   153 @publishedAll
       
   154 @released
       
   155 */
       
   156 STRUCT FILE_OWNERSHIP_INFO
       
   157 	{
       
   158 	LTEXT file_name(KMaxFileNameLength);
       
   159 	}
       
   160 
       
   161 /**
       
   162 @publishedAll
       
   163 @released
       
   164 */
       
   165 STRUCT SERVICE_INFO
       
   166 	{
       
   167 	LONG uid = 0;
       
   168 	LEN WORD STRUCT datatype_list[];
       
   169 	LLINK opaque_data = 0;
       
   170 	}
       
   171 
       
   172 
       
   173 /////////////////////////////////////////////////
       
   174 // DEFINITIONS FOR THE LOCALISABLE RESOURCE FILE
       
   175 /////////////////////////////////////////////////
       
   176 
       
   177 /**
       
   178 @publishedAll
       
   179 @released
       
   180 */
       
   181 #define KMaxCaption 256
       
   182 
       
   183 /**
       
   184 @publishedAll
       
   185 @released
       
   186 */
       
   187 STRUCT LOCALISABLE_APP_INFO
       
   188 	{
       
   189 	LONG reserved_long = 0; // reserved for future use, do not use
       
   190 	LLINK reserved_llink = 0; // reserved for future use, do not use
       
   191 	//
       
   192 	LTEXT short_caption(KMaxCaption) = "";
       
   193 	STRUCT caption_and_icon; // CAPTION_AND_ICON_INFO
       
   194 	//
       
   195 	LEN WORD STRUCT view_list[]; // VIEW_DATA
       
   196 	//
       
   197 	LTEXT group_name(KAppMaxGroupName) = "";
       
   198 	}
       
   199 
       
   200 /**
       
   201 @publishedAll
       
   202 @released
       
   203 */
       
   204 STRUCT CAPTION_AND_ICON_INFO
       
   205 	{
       
   206 	LONG reserved_long = 0; // reserved for future use, do not use
       
   207 	LLINK reserved_llink = 0; // reserved for future use, do not use
       
   208 	//
       
   209 	LTEXT caption(KMaxCaption) = "";
       
   210 	//
       
   211 	WORD number_of_icons = 0; // each icon must be a bitmap/mask pair
       
   212 	LTEXT icon_file(KMaxFileNameLength) = "";
       
   213 	}
       
   214 
       
   215 /**
       
   216 @publishedAll
       
   217 @released
       
   218 */
       
   219 STRUCT VIEW_DATA
       
   220 	{
       
   221 	LONG reserved_long = 0; // reserved for future use, do not use
       
   222 	LLINK reserved_llink = 0; // reserved for future use, do not use
       
   223 	//
       
   224 	LONG uid = 0;
       
   225 	//
       
   226 	LONG screen_mode = 0;
       
   227 	//
       
   228 	STRUCT caption_and_icon; // CAPTION_AND_ICON_INFO
       
   229 	}
       
   230 
       
   231 #endif