NCCOOS Trac Projects: Top | Web | Platforms | Processing | Viz | Sprints | Sandbox | (Wind)

root/Chameleon/trunk/Chameleon/ZoomAllLayers/ZoomAllLayers.fr-ca.doc.xml

Revision 13 (checked in by jcleary, 17 years ago)

Latest Chameleon code checkout from previous repository

Line 
1 <?xml version="1.0" encoding="UTF-8"?>
2 <ca:widgetdoc xmlns:ca="http://localhost/chameleon/utils/xml/schemas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://localhost/chameleon/utils/xml/schemas ..\..\..\utils\xml\schemas\chameleon.xsd">
3   <ca:docinfo>
4     <ca:language>
5       <ca:value>French(fr-ca)</ca:value>
6     </ca:language>
7     <ca:docbuilddate>
8       <ca:value>1999-12-31</ca:value>
9     </ca:docbuilddate>
10     <ca:docversion>
11       <ca:value>$id:$</ca:value>
12     </ca:docversion>
13     <ca:authors>
14       <ca:person>
15         <ca:name>Doc_Builder</ca:name>
16         <ca:company>DM Solutions Group Inc.</ca:company>
17         <ca:contact>chameleon@lists.maptools.org</ca:contact>
18       </ca:person>
19     </ca:authors>
20     <ca:editors>
21       <ca:person>
22         <ca:name>Christopher R. Thorne</ca:name>
23         <ca:company>DM Solutions Group Inc.</ca:company>
24         <ca:contact>chameleon@lists.maptools.org</ca:contact>
25       </ca:person>
26     </ca:editors>
27   </ca:docinfo>
28   <ca:identification>
29     <ca:name>
30       <ca:value>ZoomAllLayers</ca:value>
31     </ca:name>
32     <ca:chameleonpack>
33       <ca:value>TBD</ca:value>
34     </ca:chameleonpack>
35     <ca:parentgroup>
36       <ca:value>Navigation Widgets</ca:value>
37     </ca:parentgroup>
38     <ca:version>
39       <ca:value>1.99</ca:value>
40     </ca:version>
41     <ca:releasedate>
42       <ca:value>1999-12-31</ca:value>
43     </ca:releasedate>
44     <ca:maturitylevel>
45       <ca:value>BETA</ca:value>
46     </ca:maturitylevel>
47     <ca:developers>
48       <ca:person>
49         <ca:name>Paul Spencer</ca:name>
50         <ca:company>DM Solutions Group Inc.</ca:company>
51         <ca:contact>chameleon@lists.maptools.org</ca:contact>
52       </ca:person>
53     </ca:developers>
54   </ca:identification>
55   <ca:descriptions>
56     <ca:description>
57       <ca:paras>
58         <ca:para>Allow the user to zoom to the full extents of the currently loaded map. This extent information is located in either the MapServer mapfile (*.map) or the OGC Context (*.xml) file.</ca:para>
59       </ca:paras>
60     </ca:description>
61     <ca:dependancies>
62       <ca:dependancy type="Widget" title="Map Widget">
63         <ca:para>A map widget must be present in the interface for the ZoomAllLayers widget to function. This does not mean the button will not show up, only that the button would be inactive.</ca:para>
64       </ca:dependancy>
65     </ca:dependancies>
66     <ca:sharedresources>
67       <ca:paras title="TextButton">
68         <ca:para>The ZoomAllLayers tag has attributes from the Button Attributes group. This means ZoomAllLayers has access to the "TextButtons" Shared Resource. To learn about this Shared Resource, please refer to the Button attribute group section for details. </ca:para>
69       </ca:paras>
70     </ca:sharedresources>
71     <ca:embeddedhelp>
72       <ca:paras>
73         <ca:para>Ce bouton afiche la carte dans son int&eacute;gralit&eacute; tel que d&eacute;fini dans le contexte. Pour utiliser l'outil, cliquez sur l'ic&ocirc;ne &laquo;&nbsp;Zoom global &nbsp;&raquo;.</ca:para>
74       </ca:paras>
75     </ca:embeddedhelp>
76   </ca:descriptions>
77   <ca:tagstructures>
78     <ca:tagstructure>
79       <ca:description/>
80       <ca:code>
81         <ca:codeblock bold="true">
82           <ca:line>&lt;CWC2 TYPE="ZoomAllLayers"</ca:line>
83         </ca:codeblock>
84         <ca:codeblock bold="false">
85           <ca:line>   ENABLED="[TRUE|FALSE]"</ca:line>
86           <ca:line>   FORMINDEX="[0 &lt; integer]"</ca:line>
87           <ca:line>   VISIBLE="[TRUE|FALSE]"</ca:line>
88           <ca:line/>
89           <ca:line>   &lt;!-- Navigation Attributes --&gt;</ca:line>
90           <ca:line/>
91           <ca:line>   CURSORTYPE="[string]"</ca:line>
92           <ca:line>   DEFAULT="[TRUE|FALSE]"</ca:line>
93           <ca:line>   MAPID="[string]"</ca:line>
94           <ca:line>   WIDGETSTYLE="[string]"</ca:line>
95           <ca:line/>
96           <ca:line>   &lt;!-- Button Attribute Group--&gt;</ca:line>
97           <ca:line/>
98           <ca:line>   BACKGROUNDIMAGE="[path]"</ca:line>
99           <ca:line>   DEFAULT="[TRUE|FALSE]"</ca:line>
100           <ca:line>   IMAGE="[path]"</ca:line>
101           <ca:line>   IMAGEHEIGHT="[integer]"</ca:line>
102           <ca:line>   IMAGETIP="[string]"</ca:line>
103           <ca:line>   IMAGEWIDTH="[integer]"</ca:line>
104           <ca:line>   LABELALIGN="[LEFT|CENTER|RIGHT]"</ca:line>
105           <ca:line>   LABELANTIALIAS="[TRUE|FALSE]"</ca:line>
106           <ca:line>   LABELCOLOR="[#RRGGBB]"</ca:line>
107           <ca:line>   LABELFONT="[string]"</ca:line>
108           <ca:line>   LABELFONTSIZE="[0 &lt; integer]"</ca:line>
109           <ca:line>   ONCLICK="[string]"</ca:line>
110           <ca:line>   STYLERESOURCE="[string]"</ca:line>
111           <ca:line>   TEXTBUTTONBORDER="[path]"</ca:line>
112           <ca:line>   TEXTBUTTONBORDER_BOTTOM_IMAGE="[path]"</ca:line>
113           <ca:line>   TEXTBUTTONBORDER_BOTTOMLEFT_IMAGE="[path]"</ca:line>
114           <ca:line>   TEXTBUTTONBORDER_BOTTOMRIGHT_IMAGE="[path]"</ca:line>
115           <ca:line>   TEXTBUTTONBORDER_LEFT_IMAGE="[path]"</ca:line>
116           <ca:line>   TEXTBUTTONBORDER_RIGHT_IMAGE="[path]"</ca:line>
117           <ca:line>   TEXTBUTTONBORDER_TOP_IMAGE="[path]"</ca:line>
118           <ca:line>   TEXTBUTTONBORDER_TOPLEFT_IMAGE="[path]"</ca:line>
119           <ca:line>   TEXTBUTTONBORDER_TOPRIGHT_IMAGE="[path]"</ca:line>
120           <ca:line>   TEXTBUTTONCOLOR="[#RRGGBB]"</ca:line>
121           <ca:line>   TEXTBUTTONNUDGE="[integer]"</ca:line>
122           <ca:line>   TEXTBUTTONPADDING="[0 &lt; integer]"</ca:line>
123           <ca:line>   TOOLSET="[string]"</ca:line>
124           <ca:line>   USETEXTBUTTONCACHE="[TRUE|FALSE]"&gt;</ca:line>
125           <ca:line/>
126           <ca:line>      &lt;!-- Button Subtag Group --&gt;</ca:line>
127           <ca:line/>
128           <ca:line>      &lt;IMAGE STATE="[NORMAL|SELECTED|HOVER|DISABLED]"</ca:line>
129           <ca:line>         IMAGE="[path]"/&gt;</ca:line>
130         </ca:codeblock>
131         <ca:codeblock bold="true">
132           <ca:line>&lt;CWC2 /&gt;</ca:line>
133         </ca:codeblock>
134       </ca:code>
135     </ca:tagstructure>
136   </ca:tagstructures>
137   <ca:examples>
138     <ca:widgetexamples>
139       <ca:example title="Example #1: Simple">
140         <ca:description>An image will define the ZoomAllLayers button.</ca:description>
141         <ca:code>
142           <ca:codeblock bold="false">
143             <ca:line>&lt;cwc2 type="ZoomAllLayers"</ca:line>
144             <ca:line>   visible="true"</ca:line>
145             <ca:line>   image="buttons/button_zoomfull_1.png"/&gt;</ca:line>
146           </ca:codeblock>
147         </ca:code>
148       </ca:example>
149       <ca:example title="Example #2: Advanced">
150         <ca:description>This example shows how the ZoomAllLayers widget will use a "TextButtons" Shared Resource called "NavigationButtons".</ca:description>
151         <ca:code>
152           <ca:codeblock bold="false">
153             <ca:line>&lt;cwc2 type="ZoomAllLayers"</ca:line>
154             <ca:line>   visible="true"</ca:line>
155             <ca:line>   imagetip="Zoom to Full Extents"</ca:line>
156             <ca:line>   image="icons/pan_zoomfull.png"</ca:line>
157             <ca:line>   styleresource="NavigationButtons"&gt;</ca:line>
158             <ca:line>      &lt;image state="normal" /&gt;</ca:line>
159             <ca:line>      &lt;image state="hover" /&gt;</ca:line>
160             <ca:line>      &lt;image state="selected" /&gt;</ca:line>
161             <ca:line>&lt;/cwc2&gt;</ca:line>
162           </ca:codeblock>
163         </ca:code>
164       </ca:example>
165       <ca:example title="Example #3: Advanced">
166         <ca:description>This ZoomAllLayers example shows how the widget could be defined without using a Shared Resource. Note that this tool is linked to a group of button-based navigation widgets using the TOOLSET attribute. This means that if ZoomAllLayers is selected, it will remain active until you select another tool within that tool group.</ca:description>
167         <ca:code>
168           <ca:codeblock bold="false">
169             <ca:line>&lt;cwc2 type="ZoomAllLayers"</ca:line>
170             <ca:line>   visible="true"</ca:line>
171             <ca:line>   imagetip="Zoom to Full Extents"</ca:line>
172             <ca:line>   toolset="Navigation"</ca:line>
173             <ca:line>   imagewidth="24"</ca:line>
174             <ca:line>   imageheight="24"&gt;</ca:line>
175             <ca:line>      &lt;image state="normal"</ca:line>
176             <ca:line>         image="buttons/button_zoomfull_1.png"/&gt;</ca:line>
177             <ca:line>      &lt;image state="hover"</ca:line>
178             <ca:line>         image="buttons/button_zoomfull_2.png"/&gt;</ca:line>
179             <ca:line>      &lt;image state="selected"</ca:line>
180             <ca:line>         image="buttons/button_zoomfull_3.png"/&gt;</ca:line>
181             <ca:line>&lt;/cwc2&gt;</ca:line>
182           </ca:codeblock>
183         </ca:code>
184       </ca:example>
185     </ca:widgetexamples>
186     <ca:sampleapps>
187       <ca:sampleapp>
188         <ca:name>Hawaii Demo</ca:name>
189         <ca:appurl>www.mapsherpa.com/hawaii2/</ca:appurl>
190         <ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description>
191       </ca:sampleapp>
192     </ca:sampleapps>
193     <ca:scriptexamples/>
194   </ca:examples>
195   <ca:attributegroups>
196     <ca:attributegroup>
197       <ca:name>Base</ca:name>
198       <ca:name>Button</ca:name>
199       <ca:name>NavTool</ca:name>
200     </ca:attributegroup>
201   </ca:attributegroups>
202   <ca:formelements>
203     <ca:formelement>
204       <ca:name>NAV_CMD</ca:name>
205       <ca:type>
206         <ca:value>unknown</ca:value>
207       </ca:type>
208       <ca:description/>
209     </ca:formelement>
210     <ca:formelement>
211       <ca:name>NAV_ALLOW_RECTANGLE</ca:name>
212       <ca:type>
213         <ca:value>unknown</ca:value>
214       </ca:type>
215       <ca:description/>
216     </ca:formelement>
217   </ca:formelements>
218   <ca:jsfunctions>
219     <ca:jsfunction>
220       <ca:name>NavSetActiveTool</ca:name>
221       <ca:scope>
222         <ca:value>Private</ca:value>
223       </ca:scope>
224       <ca:description/>
225       <ca:parameters>
226         <ca:parameter>
227           <ca:name>oButton</ca:name>
228           <ca:type>
229             <ca:value>unknown</ca:value>
230           </ca:type>
231           <ca:required>
232             <ca:value>true</ca:value>
233           </ca:required>
234           <ca:description/>
235         </ca:parameter>
236         <ca:parameter>
237           <ca:name>aVals</ca:name>
238           <ca:type>
239             <ca:value>unknown</ca:value>
240           </ca:type>
241           <ca:required>
242             <ca:value>true</ca:value>
243           </ca:required>
244           <ca:description/>
245         </ca:parameter>
246       </ca:parameters>
247     </ca:jsfunction>
248   </ca:jsfunctions>
249 </ca:widgetdoc>
Note: See TracBrowser for help on using the browser.