|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. --> |
|
3 <!-- This component and the accompanying materials are made available under the terms of the License |
|
4 "Eclipse Public License v1.0" which accompanies this distribution, |
|
5 and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". --> |
|
6 <!-- Initial Contributors: |
|
7 Nokia Corporation - initial contribution. |
|
8 Contributors: |
|
9 --> |
|
10 <!DOCTYPE concept |
|
11 PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd"> |
|
12 <concept id="GUID-9F90A2F0-9C76-4871-A766-D1AE0FC42C08" xml:lang="en"><title>Defining |
|
13 localizable registration information</title><prolog><metadata><keywords/></metadata></prolog><conbody> |
|
14 <p>You need to register your applications |
|
15 to make them visible to the application menu and to provide other information |
|
16 to the underlying system. To register, you need to provide a <xref href="GUID-BF1AAA0D-DF2F-4E1D-A0D2-F419BD32F97A.dita">registration |
|
17 resource file</xref> that contains the non-localized information for your |
|
18 application. You also need to provide the localizable registration information. |
|
19 The registration resource file is compiled during the build process and included |
|
20 in the <parmname>.pkg</parmname> file used to make the file used to make |
|
21 the <parmname>sis</parmname> installation file.</p> |
|
22 |
|
23 |
|
24 <p>Localizable registration information is defined in a <parmname>LOCALISABLE_APP_INFO</parmname> resource |
|
25 statement, which may be in a separate file or in the resource file for the |
|
26 GUI resources. For a discussion of the available options for where you can |
|
27 place this resource statement, see <xref href="GUID-3F880EFC-E891-5C71-8360-1BBB54367AFA.dita">Localisable |
|
28 icon/caption definition files</xref>.</p> |
|
29 <p>To define the localizable registration information:</p> |
|
30 <ol> |
|
31 <li id="GUID-A5E13549-C926-45ED-A081-165742AAF157"><p>Determine |
|
32 the requirements of your application, including deciding on whether the resource |
|
33 statement should be in its own file or part of the GUI resource file.</p> |
|
34 </li> |
|
35 <li id="GUID-B8106EC5-BDA0-4F59-B943-9B63895347EE"><p>Create a <parmname>LOCALISABLE_APP_INFO</parmname> resource. |
|
36 The data structure is declared in the <parmname>appinfo.rh</parmname> file |
|
37 in the <parmname>./epoc32/include</parmname> folder, as is the <parmname>CAPTION_AND_ICON_INFO</parmname> structure |
|
38 used in the resource. The syntax is as follows:</p> |
|
39 <itemgroup> |
|
40 <codeblock id="GUID-4A202ECA-380D-4FE2-AE41-3D1035F3FF7A" xml:space="preserve">RESOURCE LOCALISABLE_APP_INFO r_name36 |
|
41 { |
|
42 short_caption = ""; |
|
43 CAPTION_AND_ICON_INFO |
|
44 { |
|
45 caption = ""; |
|
46 number_of_icons =0; |
|
47 icon_file = ""; |
|
48 }; |
|
49 view_list[]; // VIEW_DATA |
|
50 group_name(KAppMaxGroupName) = ""; |
|
51 }</codeblock> |
|
52 <p>where</p> |
|
53 <ul> |
|
54 <li><p><parmname>r_name36</parmname> is the resource name that uniquely |
|
55 identifies the RESOURCE statement in the application, and is used in the <xref href="GUID-BF1AAA0D-DF2F-4E1D-A0D2-F419BD32F97A.dita">registration resource file</xref>.</p> |
|
56 </li> |
|
57 <li><p><parmname>short_caption</parmname> indicates a shortened |
|
58 version of the caption used by some UIs when screen space is limited.</p> |
|
59 </li> |
|
60 <li><p><parmname>caption</parmname> indicates the caption used for |
|
61 the application on the grid and list menu.</p></li> |
|
62 <li><p><parmname>number_of_icons</parmname> indicates the number |
|
63 of icons used for the application in the menu.</p></li> |
|
64 <li><p><parmname>icon_file</parmname> indicates the name of the |
|
65 file that contains the icon, including the path but not the drive name.</p> |
|
66 </li> |
|
67 </ul> |
|
68 <p>For information on the other possible values, see <xref href="GUID-3F880EFC-E891-5C71-8360-1BBB54367AFA.dita">Localisable |
|
69 icon/caption definition files</xref>.</p> |
|
70 </itemgroup> |
|
71 </li> |
|
72 <li id="GUID-1F9CBCC9-B366-43E8-9ADB-E4AB6A255181"><p>Add the resource |
|
73 name of this resource to the <parmname>localisable_resource_id</parmname> in |
|
74 the registration resource file.</p></li> |
|
75 </ol> |
|
76 <p>For a commented example, see <xref href="GUID-6AD1DA34-EA3D-4EC9-A667-390507B4D6CB.dita">helloworldbasic.rss</xref>.</p> |
|
77 </conbody></concept> |