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