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-23A60DE7-B72D-41BD-9F1E-882D31A7E3C7" xml:lang="en"><title>Required |
12 <concept id="GUID-23A60DE7-B72D-41BD-9F1E-882D31A7E3C7" xml:lang="en"><title>Required resource file statements</title><prolog><metadata><keywords/></metadata></prolog><conbody> |
13 resource file statements</title><prolog><metadata><keywords/></metadata></prolog><conbody> |
13 <p>As noted in <xref href="GUID-EC49B54F-7724-433B-BD7F-201DE3B7DAA6.dita">Resource file structure</xref>, if the <parmname>NAME</parmname> is given, it must be the |
14 <p>As noted in <xref href="GUID-EC49B54F-7724-433B-BD7F-201DE3B7DAA6.dita">Resource |
14 first statement in the resource file.</p> |
15 file structure</xref>, |
15 <p>After the <parmname>NAME</parmname> statement, resource files |
16 if the <parmname>NAME</parmname> is given, it must be the first statement |
16 must begin with the following three <parmname>RESOURCE</parmname> statements: </p> |
17 in the resource file.</p> |
|
18 <p>After the <parmname>NAME</parmname> statement, resource files must begin |
|
19 with the following three <parmname>RESOURCE</parmname> statements: </p> |
|
20 <ul> |
17 <ul> |
21 <li><p><parmname>RESOURCE RSS_SIGNATURE</parmname></p></li> |
18 <li><p><parmname>RESOURCE RSS_SIGNATURE</parmname></p> |
|
19 </li> |
22 <li><p><parmname>RESOURCE TBUF</parmname></p></li> |
20 <li><p><parmname>RESOURCE TBUF</parmname></p></li> |
23 <li><p><parmname>RESOURCE TBUF RESOURCE EIK_APP_INFO</parmname></p> |
21 <li><p><parmname>RESOURCE TBUF RESOURCE EIK_APP_INFO</parmname></p></li> |
24 </li> |
|
25 </ul> |
22 </ul> |
26 <section id="GUID-4283E4EE-4553-4684-B19E-E22BA3248A72"><title>RESOURCE RSS_SIGNATURE</title> |
23 <section id="GUID-4283E4EE-4553-4684-B19E-E22BA3248A72"><title>RESOURCE |
27 <p>The <parmname>RSS_SIGNATURE</parmname> resource is used to declare the |
24 RSS_SIGNATURE</title> |
28 version number of the resource file. Leave this blank. The syntax is as follows:</p> |
25 <p>The <parmname>RSS_SIGNATURE</parmname> resource is used to declare |
|
26 the version number of the resource file. Leave this blank. The syntax |
|
27 is as follows:</p> |
29 <codeblock id="GUID-AA3B4D8C-55DA-4328-82D9-42F1A7BD18F6" xml:space="preserve">RESOURCE RSS_SIGNATURE |
28 <codeblock id="GUID-AA3B4D8C-55DA-4328-82D9-42F1A7BD18F6" xml:space="preserve">RESOURCE RSS_SIGNATURE |
30 { |
29 { |
31 signature = value |
30 signature = value |
32 }</codeblock> |
31 }</codeblock> |
33 <p>where signature is a <parmname>LONG</parmname> value.</p> |
32 <p>where signature is a <parmname>LONG</parmname> value.</p> |
34 <p>By default the signature is set to 0.</p> |
33 <p>By default the signature is set to 0.</p> |
35 <p>For an example, see <xref href="GUID-6AD1DA34-EA3D-4EC9-A667-390507B4D6CB.dita">helloworldbasic.rss</xref>.</p> |
34 <p>For an example, see <xref href="GUID-6AD1DA34-EA3D-4EC9-A667-390507B4D6CB.dita">helloworldbasic.rss</xref>.</p> |
36 <p>For more information on <codeph>RSS_STRUCTURE</codeph>, see <xref href="jar:GUID-35228542-8C95-4849-A73F-2B4F082F0C44.jar!/sdk/doc_source/reference/reference-resource/bafl/BA_RSS_SIGNATUREStruct.html#BA_RSS_SIGNATURE" format="application/java-archive">BA_RSS_SIGNATURE</xref>.</p> |
35 <p>For more information on <codeph>RSS_STRUCTURE</codeph>, see <xref href="jar:GUID-35228542-8C95-4849-A73F-2B4F082F0C44.jar!/sdk/doc_source/reference/reference-resource/bafl/BA_RSS_SIGNATUREStruct.html#BA_RSS_SIGNATURE" format="application/java-archive">BA_RSS_SIGNATURE</xref>.</p> |
37 </section> |
36 </section> |
38 <section id="GUID-CB1C2A65-73EA-4130-923C-AABA2878D93F"><title>RESOURCE TBUF</title> |
37 <section id="GUID-CB1C2A65-73EA-4130-923C-AABA2878D93F"><title>RESOURCE |
39 <p>The <parmname>TBUF</parmname> resource may be used to declare a file |
38 TBUF</title> |
40 name for use by the document class if it is stated that the <parmname>StoreL</parmname> and <parmname>RestoreL</parmname> of |
39 <p>The <parmname>TBUF</parmname> resource may be used to declare |
41 the document class is called. Otherwise, it may be left blank. The syntax |
40 a file name for use by the document class if it is stated that the <parmname>StoreL</parmname> and <parmname>RestoreL</parmname> of the document |
42 is as follows:</p> |
41 class is called. Otherwise, it may be left blank. The syntax is as |
|
42 follows:</p> |
43 <codeblock id="GUID-79FD4FE0-2D55-4090-B342-FDFA288DC0A5" xml:space="preserve">RESOURCE TBUF |
43 <codeblock id="GUID-79FD4FE0-2D55-4090-B342-FDFA288DC0A5" xml:space="preserve">RESOURCE TBUF |
44 { |
44 { |
45 buf="NAME"; |
45 buf="NAME"; |
46 }</codeblock> |
46 }</codeblock> |
47 <p>where <parmname>buf</parmname> is one non-zero terminating string.</p> |
47 <p>where <parmname>buf</parmname> is one non-zero terminating string.</p> |
48 <p>For an example, see <xref href="GUID-6AD1DA34-EA3D-4EC9-A667-390507B4D6CB.dita">helloworldbasic.rss</xref>.</p> |
48 <p>For an example, see <xref href="GUID-6AD1DA34-EA3D-4EC9-A667-390507B4D6CB.dita">helloworldbasic.rss</xref>.</p> |
49 <note> |
49 <note> |
50 <p>The TBUF structure is declared in <parmname>badef.rh</parmname>, which |
50 <p>The TBUF structure is declared in <parmname>badef.rh</parmname>, which is included in the <parmname>uikon.rh</parmname> file. For |
51 is included in the <parmname>uikon.rh</parmname> file. For more information |
51 more information on the TBUF resource, see <xref href="jar:GUID-35228542-8C95-4849-A73F-2B4F082F0C44.jar!/sdk/doc_source/reference/reference-resource/bafl/TBUFStruct.html#TBUF" format="application/java-archive"><parmname>TBUF</parmname></xref>.</p> |
52 on the TBUF resource, see <xref href="jar:GUID-35228542-8C95-4849-A73F-2B4F082F0C44.jar!/sdk/doc_source/reference/reference-resource/bafl/TBUFStruct.html#TBUF" format="application/java-archive"><parmname>TBUF</parmname></xref>.</p> |
|
53 </note> |
52 </note> |
54 </section> |
53 </section> |
55 <section id="GUID-3687D483-9834-401B-B389-6C615B60AB87"><title>RESOURCE EIK_APP_INFO</title> |
54 <section id="GUID-3687D483-9834-401B-B389-6C615B60AB87"><title>RESOURCE |
56 <p>The <xref href="jar:GUID-35228542-8C95-4849-A73F-2B4F082F0C44.jar!/sdk/doc_source/reference/reference-resource/uikon/EIK_APP_INFO.html#EIK_APP_INFO" format="application/java-archive"><parmname>EIK_APP_INFO</parmname></xref> resource defines the objects |
55 EIK_APP_INFO</title> |
57 used in the application GUI. </p> |
56 <p>The <xref href="jar:GUID-35228542-8C95-4849-A73F-2B4F082F0C44.jar!/sdk/doc_source/reference/reference-resource/uikon/EIK_APP_INFO.html#EIK_APP_INFO" format="application/java-archive"><parmname>EIK_APP_INFO</parmname></xref> resource defines the |
|
57 objects used in the application GUI. </p> |
58 <note> |
58 <note> |
59 <p>Not all possible objects need to be declared. </p> |
59 <p>Not all possible objects need to be declared. </p> |
60 </note> |
60 </note> |
61 <p>The syntax is as follows:</p> |
61 <p>The syntax is as follows:</p> |
62 <codeblock id="GUID-7930019A-52B6-449F-861C-81EE003A2DB2" xml:space="preserve">RESOURCE EIK_APP_INFO |
62 <codeblock id="GUID-7930019A-52B6-449F-861C-81EE003A2DB2" xml:space="preserve">RESOURCE EIK_APP_INFO |
65 cba = value5; |
65 cba = value5; |
66 status_pane = value6; |
66 status_pane = value6; |
67 }</codeblock> |
67 }</codeblock> |
68 <p>where:</p> |
68 <p>where:</p> |
69 <ul> |
69 <ul> |
70 <li><p><parmname>menubar</parmname> defines the menubar resource.</p> |
70 <li><p><parmname>menubar</parmname> defines the menubar |
71 </li> |
71 resource.</p></li> |
72 <li><p><parmname>cba</parmname> defines the softkeys resource.</p> |
72 <li><p><parmname>cba</parmname> defines the softkeys resource.</p> |
73 </li> |
73 </li> |
74 <li><p><parmname>status_pane</parmname> defines the status pane |
74 <li><p><parmname>status_pane</parmname> defines the status |
75 resource.</p></li> |
75 pane resource.</p></li> |
76 </ul> |
76 </ul> |
77 <p>All values refer to resources defined either in the resource file or |
77 <p>All values refer to resources defined either in the resource |
78 in a generated resource header file (<parmname>.rsg</parmname>) included in |
78 file or in a generated resource header file (<parmname>.rsg</parmname>) included in the resource file. </p> |
79 the resource file. </p> |
|
80 <note> |
79 <note> |
81 <p>If an element is not defined, then it is not used. For example:</p> |
80 <p>If an element is not defined, then it is not used. For example:</p> |
82 </note> |
81 </note> |
83 <codeblock id="GUID-52146026-2265-43B2-BD2D-B3589CA7E9A9" xml:space="preserve">RESOURCE EIK_APP_INFO |
82 <codeblock id="GUID-52146026-2265-43B2-BD2D-B3589CA7E9A9" xml:space="preserve">RESOURCE EIK_APP_INFO |
84 { |
83 { |
85 menubar=r_name4; |
84 menubar=r_name4; |
86 cba=R_AVKON_SOFTKEYS_OPTIONS_EXIT; |
85 cba=R_AVKON_SOFTKEYS_OPTIONS_EXIT; |
87 }</codeblock> |
86 }</codeblock> |
88 <p>sets the application to use the menu bar defined by the <parmname>RESOURCE</parmname> statement |
87 <p>sets the application to use the menu bar defined by the <parmname>RESOURCE</parmname> statement with the name<parmname>r_name4</parmname>, and creates the softkey options <parmname>Options</parmname> and <parmname>Exit</parmname> in the control button area. </p> |
89 with the name<parmname>r_name4</parmname>, and creates the softkey options <parmname>Options</parmname> and <parmname>Exit</parmname> in |
|
90 the control button area. </p> |
|
91 <p>For an example, see <xref href="GUID-6AD1DA34-EA3D-4EC9-A667-390507B4D6CB.dita">helloworldbasic.rss</xref>.</p> |
88 <p>For an example, see <xref href="GUID-6AD1DA34-EA3D-4EC9-A667-390507B4D6CB.dita">helloworldbasic.rss</xref>.</p> |
92 <p>For more information on the control button area softkeys provided by |
89 <p>For more information on the control button area softkeys provided |
93 the Symbian platform, see <xref href="GUID-CBB00F6A-CBA7-4872-B0A1-A86A863725F5.dita">Precompiled |
90 by the Symbian platform, see <xref href="GUID-CBB00F6A-CBA7-4872-B0A1-A86A863725F5.dita">Precompiled resource values available from the Symbian platform</xref>. </p> |
94 resource values available from the Symbian platform</xref>. </p> |
|
95 </section> |
91 </section> |
96 </conbody></concept> |
92 </conbody></concept> |