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

root/Chameleon/trunk/Chameleon/ROIRectangleTool/ROIRectangleTool.en-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="ISO-8859-1"?>
2 <ca:widgetdoc xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ca="http://localhost/chameleon/utils/xml/schemas" xsi:schemaLocation="http://localhost/chameleon/utils/xml/schemas ..\..\..\utils\xml\schemas\chameleon.xsd">
3   <ca:docinfo title="Document Information">
4     <ca:language title="Document Language Code">
5       <ca:value>English (en-ca)</ca:value>
6     </ca:language>
7     <ca:docbuilddate title="Doc_Builder Date">
8       <ca:value>2004-12-18</ca:value>
9     </ca:docbuilddate>
10     <ca:docversion title="Document Repository Version">
11       <ca:value>$id: $</ca:value>
12     </ca:docversion>
13     <ca:authors title="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:comment></ca:comment>
19       </ca:person>
20     </ca:authors>
21     <ca:editors title="Editors">
22       <ca:person>
23         <ca:name>Christopher R. Thorne</ca:name>
24         <ca:company>DM Solutions Group Inc.</ca:company>
25         <ca:contact>chameleon@lists.maptools.org</ca:contact>
26         <ca:comment></ca:comment>
27       </ca:person>
28     </ca:editors>
29   </ca:docinfo>
30   <ca:identification title="Identification">
31     <ca:name title="Name">
32       <ca:value>roirectangletool</ca:value>
33     </ca:name>
34     <ca:chameleonpack title="Widet Package">
35       <ca:value>TBD</ca:value>
36     </ca:chameleonpack>
37     <ca:parentgroup title="Parent Group">
38       <ca:value>TBD</ca:value>
39     </ca:parentgroup>
40     <ca:version title="Version">
41       <ca:value>1.99</ca:value>
42     </ca:version>
43     <ca:releasedate title="Release Date">
44       <ca:value>1999-12-31</ca:value>
45     </ca:releasedate>
46     <ca:maturitylevel title="Maturity Level">
47       <ca:value>BETA</ca:value>
48     </ca:maturitylevel>
49     <ca:developers title="Developers">
50       <ca:person>
51         <ca:name>Paul Spencer</ca:name>
52         <ca:company>DM Solutions Group Inc.</ca:company>
53         <ca:contact>chameleon@lists.maptools.org</ca:contact>
54         <ca:comment></ca:comment>
55       </ca:person>
56     </ca:developers>
57   </ca:identification>
58   <ca:descriptions title="Description">
59     <ca:description title="General Functionality">
60       <ca:paras title="">
61         <ca:para>The ROIRectangleTool widget allows the user to draw a rectangular region
62 of interest on the map interface.</ca:para>
63       </ca:paras>
64     </ca:description>
65     <ca:techrequirements title="Technical Requirements">
66       <ca:paras title="Not Available">
67         <ca:para></ca:para>
68       </ca:paras>
69     </ca:techrequirements>
70     <ca:dependancies title="Dependancies">
71       <ca:dependancy type="None" title="Not Available">
72         <ca:para></ca:para>
73       </ca:dependancy>
74     </ca:dependancies>
75     <ca:sharedresources title="Shared Resources">
76       <ca:paras title="Not Available">
77         <ca:para></ca:para>
78       </ca:paras>
79     </ca:sharedresources>
80     <ca:embeddedhelp title="General User Interface Help">
81       <ca:paras title="">
82         <ca:para></ca:para>
83       </ca:paras>
84     </ca:embeddedhelp>
85     <ca:guinotes title="Interface Functionality">
86       <ca:guinote type="None" title="None.">
87         <ca:para></ca:para>
88       </ca:guinote>
89     </ca:guinotes>
90     <ca:qanotes title="Quality Assurance">
91       <ca:paras title="None.">
92         <ca:para></ca:para>
93       </ca:paras>
94     </ca:qanotes>
95   </ca:descriptions>
96   <ca:tagstructures title="Tag Syntax">
97     <ca:tagstructure title="Widget Syntax">
98       <ca:description></ca:description>
99       <ca:code title="">
100         <ca:description></ca:description>
101         <ca:codeblock bold="false"/>
102       </ca:code>
103     </ca:tagstructure>
104   </ca:tagstructures>
105   <ca:examples title="Examples">
106     <ca:widgetexamples title="Widget Examples">
107       <ca:example title="Example #1: Simple">
108         <ca:description></ca:description>
109         <ca:code title="">
110           <ca:description></ca:description>
111           <ca:codeblock bold="false">
112             <ca:line></ca:line>
113           </ca:codeblock>
114         </ca:code>
115       </ca:example>
116     </ca:widgetexamples>
117     <ca:sharedresourceexamples title="Shared Resources Examples">
118       <ca:example title="Example #1: Advanced">
119         <ca:description></ca:description>
120         <ca:code title="">
121           <ca:description></ca:description>
122           <ca:codeblock bold="false">
123             <ca:line></ca:line>
124           </ca:codeblock>
125         </ca:code>
126       </ca:example>
127     </ca:sharedresourceexamples>
128     <ca:sampleapps title="Sample Applications">
129       <ca:sampleapp>
130         <ca:name>Hawaii Demo</ca:name>
131         <ca:appurl>http://www.mapsherpa.com/hawaii2/</ca:appurl>
132         <ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description>
133       </ca:sampleapp>
134     </ca:sampleapps>
135     <ca:scriptexamples title="Script Examples">
136       <ca:example title="Example #1: Simple">
137         <ca:description></ca:description>
138         <ca:code title="">
139           <ca:description></ca:description>
140           <ca:codeblock bold="false">
141             <ca:line></ca:line>
142           </ca:codeblock>
143         </ca:code>
144       </ca:example>
145     </ca:scriptexamples>
146   </ca:examples>
147   <ca:attributegroups title="Attribute Groups">
148     <ca:description></ca:description>
149     <ca:attributegroup>
150       <ca:name>base</ca:name>
151       <ca:name>button</ca:name>
152     </ca:attributegroup>
153   </ca:attributegroups>
154   <ca:widgettag title="Attributes">
155     <ca:subtag>
156       <ca:name></ca:name>
157       <ca:type title="Type">
158         <ca:value>XML</ca:value>
159         <ca:description>Child Element to Chameleon widget tag (subtag)</ca:description>
160       </ca:type>
161       <ca:class title="Class">
162         <ca:value>Widget &amp; Shared Resource</ca:value>
163       </ca:class>
164       <ca:description></ca:description>
165       <ca:attribute>
166         <ca:name></ca:name>
167         <ca:type title="Type">
168           <ca:value>float</ca:value>
169           <ca:description></ca:description>
170         </ca:type>
171         <ca:class title="Class">
172           <ca:value>Widget &amp; Shared Resource</ca:value>
173         </ca:class>
174         <ca:default title="Default">
175           <ca:value></ca:value>
176           <ca:description></ca:description>
177         </ca:default>
178         <ca:possvalues type="list" title="Value">
179           <ca:value></ca:value>
180         </ca:possvalues>
181         <ca:description></ca:description>
182       </ca:attribute>
183     </ca:subtag>
184   </ca:widgettag>
185   <ca:formelements title="Form Elements">
186     <ca:formelement>
187       <ca:name>NAV_CMD</ca:name>
188       <ca:type title="Type">
189         <ca:value>unknown</ca:value>
190         <ca:description></ca:description>
191       </ca:type>
192       <ca:default title="Default">
193         <ca:value></ca:value>
194         <ca:description></ca:description>
195       </ca:default>
196       <ca:possvalues type="list" title="Values">
197         <ca:value></ca:value>
198       </ca:possvalues>
199       <ca:description>The last command that was used to interact with the map</ca:description>
200     </ca:formelement>
201   </ca:formelements>
202   <ca:jsvariables title="JavaScript Variables">
203     <ca:jsvariable>
204       <ca:name>gROIToolmouseX</ca:name>
205       <ca:type title="Type">
206         <ca:value>float</ca:value>
207       </ca:type>
208       <ca:scope title="Scope">
209         <ca:value>Private</ca:value>
210       </ca:scope>
211       <ca:default title="Default">
212         <ca:value>0</ca:value>
213       </ca:default>
214       <ca:possvalues type="list" title="Values">
215         <ca:value></ca:value>
216       </ca:possvalues>
217       <ca:description>The current X location of the mouse</ca:description>
218     </ca:jsvariable>
219     <ca:jsvariable>
220       <ca:name>gROIToolmouseY</ca:name>
221       <ca:type title="Type">
222         <ca:value>float</ca:value>
223       </ca:type>
224       <ca:scope title="Scope">
225         <ca:value>Private</ca:value>
226       </ca:scope>
227       <ca:default title="Default">
228         <ca:value>0</ca:value>
229       </ca:default>
230       <ca:possvalues type="list" title="Values">
231         <ca:value></ca:value>
232       </ca:possvalues>
233       <ca:description>The current X location of the mouse</ca:description>
234     </ca:jsvariable>
235     <ca:jsvariable>
236       <ca:name>gROIRectToolx1</ca:name>
237       <ca:type title="Type">
238         <ca:value>float</ca:value>
239       </ca:type>
240       <ca:scope title="Scope">
241         <ca:value>Private</ca:value>
242       </ca:scope>
243       <ca:default title="Default">
244         <ca:value>0</ca:value>
245       </ca:default>
246       <ca:possvalues type="list" title="Values">
247         <ca:value></ca:value>
248       </ca:possvalues>
249       <ca:description>The first mouse X position for the ROI</ca:description>
250     </ca:jsvariable>
251     <ca:jsvariable>
252       <ca:name>gROIRectTooly1</ca:name>
253       <ca:type title="Type">
254         <ca:value>float</ca:value>
255       </ca:type>
256       <ca:scope title="Scope">
257         <ca:value>Private</ca:value>
258       </ca:scope>
259       <ca:default title="Default">
260         <ca:value>0</ca:value>
261       </ca:default>
262       <ca:possvalues type="list" title="Values">
263         <ca:value></ca:value>
264       </ca:possvalues>
265       <ca:description>The first mouse Y position for the ROI</ca:description>
266     </ca:jsvariable>
267     <ca:jsvariable>
268       <ca:name>gROIRectToolx2</ca:name>
269       <ca:type title="Type">
270         <ca:value>float</ca:value>
271       </ca:type>
272       <ca:scope title="Scope">
273         <ca:value>Private</ca:value>
274       </ca:scope>
275       <ca:default title="Default">
276         <ca:value>0</ca:value>
277       </ca:default>
278       <ca:possvalues type="list" title="Values">
279         <ca:value></ca:value>
280       </ca:possvalues>
281       <ca:description>The second mouse X position for the ROI</ca:description>
282     </ca:jsvariable>
283     <ca:jsvariable>
284       <ca:name>gROIRectTooly2</ca:name>
285       <ca:type title="Type">
286         <ca:value>float</ca:value>
287       </ca:type>
288       <ca:scope title="Scope">
289         <ca:value>Private</ca:value>
290       </ca:scope>
291       <ca:default title="Default">
292         <ca:value>0</ca:value>
293       </ca:default>
294       <ca:possvalues type="list" title="Values">
295         <ca:value></ca:value>
296       </ca:possvalues>
297       <ca:description>The second mouse X position for the ROI</ca:description>
298     </ca:jsvariable>
299     <ca:jsvariable>
300       <ca:name>gROIRectDragging</ca:name>
301       <ca:type title="Type">
302         <ca:value>float</ca:value>
303       </ca:type>
304       <ca:scope title="Scope">
305         <ca:value>Private</ca:value>
306       </ca:scope>
307       <ca:default title="Default">
308         <ca:value>false</ca:value>
309       </ca:default>
310       <ca:possvalues type="list" title="Values">
311         <ca:value></ca:value>
312       </ca:possvalues>
313       <ca:description>Used by the ROI Rectangle tool to track if the user is </ca:description>
314     </ca:jsvariable>
315     <ca:jsvariable>
316       <ca:name>goROIRectObj</ca:name>
317       <ca:type title="Type">
318         <ca:value>float</ca:value>
319       </ca:type>
320       <ca:scope title="Scope">
321         <ca:value>Private</ca:value>
322       </ca:scope>
323       <ca:default title="Default">
324         <ca:value>null</ca:value>
325       </ca:default>
326       <ca:possvalues type="list" title="Values">
327         <ca:value></ca:value>
328       </ca:possvalues>
329       <ca:description>The current ROI rectangle if the user is creating one.</ca:description>
330     </ca:jsvariable>
331     <ca:jsvariable>
332       <ca:name>gROIRectBoxTop</ca:name>
333       <ca:type title="Type">
334         <ca:value>string</ca:value>
335       </ca:type>
336       <ca:scope title="Scope">
337         <ca:value>Private</ca:value>
338       </ca:scope>
339       <ca:default title="Default">
340         <ca:value>gROIRectBoxTop</ca:value>
341       </ca:default>
342       <ca:possvalues type="list" title="Values">
343         <ca:value></ca:value>
344       </ca:possvalues>
345       <ca:description>The top layer of the ROI Rectangle Tool's DHTML layers.</ca:description>
346     </ca:jsvariable>
347     <ca:jsvariable>
348       <ca:name>gROIRectBoxLeft</ca:name>
349       <ca:type title="Type">
350         <ca:value>string</ca:value>
351       </ca:type>
352       <ca:scope title="Scope">
353         <ca:value>Private</ca:value>
354       </ca:scope>
355       <ca:default title="Default">
356         <ca:value>gROIRectBoxLeft</ca:value>
357       </ca:default>
358       <ca:possvalues type="list" title="Values">
359         <ca:value></ca:value>
360       </ca:possvalues>
361       <ca:description>The left layer of the ROI Rectangle Tool's DHTML layers.</ca:description>
362     </ca:jsvariable>
363     <ca:jsvariable>
364       <ca:name>gROIRectBoxBottom</ca:name>
365       <ca:type title="Type">
366         <ca:value>string</ca:value>
367       </ca:type>
368       <ca:scope title="Scope">
369         <ca:value>Private</ca:value>
370       </ca:scope>
371       <ca:default title="Default">
372         <ca:value>gROIRectBoxBottom</ca:value>
373       </ca:default>
374       <ca:possvalues type="list" title="Values">
375         <ca:value></ca:value>
376       </ca:possvalues>
377       <ca:description>The bottom layer of the ROI Rectangle Tool's DHTML layers.</ca:description>
378     </ca:jsvariable>
379     <ca:jsvariable>
380       <ca:name>gROIRectBoxRight</ca:name>
381       <ca:type title="Type">
382         <ca:value>string</ca:value>
383       </ca:type>
384       <ca:scope title="Scope">
385         <ca:value>Private</ca:value>
386       </ca:scope>
387       <ca:default title="Default">
388         <ca:value>gROIRectBoxRight</ca:value>
389       </ca:default>
390       <ca:possvalues type="list" title="Values">
391         <ca:value></ca:value>
392       </ca:possvalues>
393       <ca:description>The right layer of the ROI Rectangle Tool's DHTML layers.</ca:description>
394     </ca:jsvariable>
395     <ca:jsvariable>
396       <ca:name>gROIRectBoxFill</ca:name>
397       <ca:type title="Type">
398         <ca:value>string</ca:value>
399       </ca:type>
400       <ca:scope title="Scope">
401         <ca:value>Private</ca:value>
402       </ca:scope>
403       <ca:default title="Default">
404         <ca:value>gROIRectBoxFill</ca:value>
405       </ca:default>
406       <ca:possvalues type="list" title="Values">
407         <ca:value></ca:value>
408       </ca:possvalues>
409       <ca:description>The fill layer of the ROI Rectangle Tool's DHTML layers.</ca:description>
410     </ca:jsvariable>
411   </ca:jsvariables>
412   <ca:jsfunctions title="JavaScript Functions">
413     <ca:jsfunction>
414       <ca:name>ROIRectTool</ca:name>
415       <ca:scope title="Scope">
416         <ca:value>Private</ca:value>
417       </ca:scope>
418       <ca:description></ca:description>
419       <ca:returnvalues title="Function Return Value">
420         <ca:returnvalue>
421           <ca:type title="Type">
422             <ca:value>unknown</ca:value>
423             <ca:description></ca:description>
424           </ca:type>
425           <ca:default title="Default">
426             <ca:value></ca:value>
427           </ca:default>
428           <ca:possvalues type="list" title="Values">
429             <ca:value></ca:value>
430           </ca:possvalues>
431           <ca:description></ca:description>
432         </ca:returnvalue>
433       </ca:returnvalues>
434       <ca:triggeredjsapievents title="JSAPI Triggered Events">
435         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
436         <ca:triggeredjsapievent title="">
437           <ca:name></ca:name>
438           <ca:description></ca:description>
439         </ca:triggeredjsapievent>
440       </ca:triggeredjsapievents>
441     </ca:jsfunction>
442     <ca:jsfunction>
443       <ca:name>ROIRectToolInit</ca:name>
444       <ca:scope title="Scope">
445         <ca:value>Private</ca:value>
446       </ca:scope>
447       <ca:description></ca:description>
448       <ca:returnvalues title="Function Return Value">
449         <ca:returnvalue>
450           <ca:type title="Type">
451             <ca:value>unknown</ca:value>
452             <ca:description></ca:description>
453           </ca:type>
454           <ca:default title="Default">
455             <ca:value></ca:value>
456           </ca:default>
457           <ca:possvalues type="list" title="Values">
458             <ca:value></ca:value>
459           </ca:possvalues>
460           <ca:description></ca:description>
461         </ca:returnvalue>
462       </ca:returnvalues>
463       <ca:triggeredjsapievents title="JSAPI Triggered Events">
464         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
465         <ca:triggeredjsapievent title="">
466           <ca:name></ca:name>
467           <ca:description></ca:description>
468         </ca:triggeredjsapievent>
469       </ca:triggeredjsapievents>
470     </ca:jsfunction>
471     <ca:jsfunction>
472       <ca:name>ROIRectToolCreateDHTMLLayers</ca:name>
473       <ca:scope title="Scope">
474         <ca:value>Private</ca:value>
475       </ca:scope>
476       <ca:description></ca:description>
477       <ca:returnvalues title="Function Return Value">
478         <ca:returnvalue>
479           <ca:type title="Type">
480             <ca:value>unknown</ca:value>
481             <ca:description></ca:description>
482           </ca:type>
483           <ca:default title="Default">
484             <ca:value></ca:value>
485           </ca:default>
486           <ca:possvalues type="list" title="Values">
487             <ca:value></ca:value>
488           </ca:possvalues>
489           <ca:description></ca:description>
490         </ca:returnvalue>
491       </ca:returnvalues>
492       <ca:triggeredjsapievents title="JSAPI Triggered Events">
493         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
494         <ca:triggeredjsapievent title="">
495           <ca:name></ca:name>
496           <ca:description></ca:description>
497         </ca:triggeredjsapievent>
498       </ca:triggeredjsapievents>
499     </ca:jsfunction>
500     <ca:jsfunction>
501       <ca:name>ROIRectToolInitObjects</ca:name>
502       <ca:scope title="Scope">
503         <ca:value>Private</ca:value>
504       </ca:scope>
505       <ca:description></ca:description>
506       <ca:returnvalues title="Function Return Value">
507         <ca:returnvalue>
508           <ca:type title="Type">
509             <ca:value>unknown</ca:value>
510             <ca:description></ca:description>
511           </ca:type>
512           <ca:default title="Default">
513             <ca:value></ca:value>
514           </ca:default>
515           <ca:possvalues type="list" title="Values">
516             <ca:value></ca:value>
517           </ca:possvalues>
518           <ca:description></ca:description>
519         </ca:returnvalue>
520       </ca:returnvalues>
521       <ca:triggeredjsapievents title="JSAPI Triggered Events">
522         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
523         <ca:triggeredjsapievent title="">
524           <ca:name></ca:name>
525           <ca:description></ca:description>
526         </ca:triggeredjsapievent>
527       </ca:triggeredjsapievents>
528     </ca:jsfunction>
529     <ca:jsfunction>
530       <ca:name>ROIRectToolStartZoomBox</ca:name>
531       <ca:scope title="Scope">
532         <ca:value>Private</ca:value>
533       </ca:scope>
534       <ca:description></ca:description>
535       <ca:returnvalues title="Function Return Value">
536         <ca:returnvalue>
537           <ca:type title="Type">
538             <ca:value>unknown</ca:value>
539             <ca:description></ca:description>
540           </ca:type>
541           <ca:default title="Default">
542             <ca:value></ca:value>
543           </ca:default>
544           <ca:possvalues type="list" title="Values">
545             <ca:value></ca:value>
546           </ca:possvalues>
547           <ca:description></ca:description>
548         </ca:returnvalue>
549       </ca:returnvalues>
550       <ca:triggeredjsapievents title="JSAPI Triggered Events">
551         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
552         <ca:triggeredjsapievent title="">
553           <ca:name></ca:name>
554           <ca:description></ca:description>
555         </ca:triggeredjsapievent>
556       </ca:triggeredjsapievents>
557     </ca:jsfunction>
558     <ca:jsfunction>
559       <ca:name>ROIRectToolUpdateZoomBox</ca:name>
560       <ca:scope title="Scope">
561         <ca:value>Private</ca:value>
562       </ca:scope>
563       <ca:description></ca:description>
564       <ca:returnvalues title="Function Return Value">
565         <ca:returnvalue>
566           <ca:type title="Type">
567             <ca:value>unknown</ca:value>
568             <ca:description></ca:description>
569           </ca:type>
570           <ca:default title="Default">
571             <ca:value></ca:value>
572           </ca:default>
573           <ca:possvalues type="list" title="Values">
574             <ca:value></ca:value>
575           </ca:possvalues>
576           <ca:description></ca:description>
577         </ca:returnvalue>
578       </ca:returnvalues>
579       <ca:triggeredjsapievents title="JSAPI Triggered Events">
580         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
581         <ca:triggeredjsapievent title="">
582           <ca:name></ca:name>
583           <ca:description></ca:description>
584         </ca:triggeredjsapievent>
585       </ca:triggeredjsapievents>
586     </ca:jsfunction>
587     <ca:jsfunction>
588       <ca:name>ROIRectToolStopZoomBox</ca:name>
589       <ca:scope title="Scope">
590         <ca:value>Private</ca:value>
591       </ca:scope>
592       <ca:description></ca:description>
593       <ca:returnvalues title="Function Return Value">
594         <ca:returnvalue>
595           <ca:type title="Type">
596             <ca:value>unknown</ca:value>
597             <ca:description></ca:description>
598           </ca:type>
599           <ca:default title="Default">
600             <ca:value></ca:value>
601           </ca:default>
602           <ca:possvalues type="list" title="Values">
603             <ca:value></ca:value>
604           </ca:possvalues>
605           <ca:description></ca:description>
606         </ca:returnvalue>
607       </ca:returnvalues>
608       <ca:triggeredjsapievents title="JSAPI Triggered Events">
609         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
610         <ca:triggeredjsapievent title="">
611           <ca:name></ca:name>
612           <ca:description></ca:description>
613         </ca:triggeredjsapievent>
614       </ca:triggeredjsapievents>
615     </ca:jsfunction>
616     <ca:jsfunction>
617       <ca:name>ROIRectToolMouseDown</ca:name>
618       <ca:scope title="Scope">
619         <ca:value>Private</ca:value>
620       </ca:scope>
621       <ca:description></ca:description>
622       <ca:parameters title="Parameters">
623         <ca:parameter>
624           <ca:name>e</ca:name>
625           <ca:type title="Type">
626             <ca:value>string</ca:value>
627           </ca:type>
628           <ca:default title="Default">
629             <ca:value></ca:value>
630             <ca:description></ca:description>
631           </ca:default>
632           <ca:possvalues type="list" title="Values">
633             <ca:value></ca:value>
634           </ca:possvalues>
635           <ca:description></ca:description>
636         </ca:parameter>
637       </ca:parameters>
638       <ca:returnvalues title="Function Return Value">
639         <ca:returnvalue>
640           <ca:type title="Type">
641             <ca:value>unknown</ca:value>
642             <ca:description></ca:description>
643           </ca:type>
644           <ca:default title="Default">
645             <ca:value></ca:value>
646           </ca:default>
647           <ca:possvalues type="list" title="Values">
648             <ca:value></ca:value>
649           </ca:possvalues>
650           <ca:description></ca:description>
651         </ca:returnvalue>
652       </ca:returnvalues>
653       <ca:triggeredjsapievents title="JSAPI Triggered Events">
654         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
655         <ca:triggeredjsapievent title="">
656           <ca:name></ca:name>
657           <ca:description></ca:description>
658         </ca:triggeredjsapievent>
659       </ca:triggeredjsapievents>
660     </ca:jsfunction>
661     <ca:jsfunction>
662       <ca:name>ROIRectToolMouseUp</ca:name>
663       <ca:scope title="Scope">
664         <ca:value>Private</ca:value>
665       </ca:scope>
666       <ca:description></ca:description>
667       <ca:parameters title="Parameters">
668         <ca:parameter>
669           <ca:name>e</ca:name>
670           <ca:type title="Type">
671             <ca:value>string</ca:value>
672           </ca:type>
673           <ca:default title="Default">
674             <ca:value></ca:value>
675             <ca:description></ca:description>
676           </ca:default>
677           <ca:possvalues type="list" title="Values">
678             <ca:value></ca:value>
679           </ca:possvalues>
680           <ca:description></ca:description>
681         </ca:parameter>
682       </ca:parameters>
683       <ca:returnvalues title="Function Return Value">
684         <ca:returnvalue>
685           <ca:type title="Type">
686             <ca:value>unknown</ca:value>
687             <ca:description></ca:description>
688           </ca:type>
689           <ca:default title="Default">
690             <ca:value></ca:value>
691           </ca:default>
692           <ca:possvalues type="list" title="Values">
693             <ca:value></ca:value>
694           </ca:possvalues>
695           <ca:description></ca:description>
696         </ca:returnvalue>
697       </ca:returnvalues>
698       <ca:triggeredjsapievents title="JSAPI Triggered Events">
699         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
700         <ca:triggeredjsapievent title="">
701           <ca:name></ca:name>
702           <ca:description></ca:description>
703         </ca:triggeredjsapievent>
704       </ca:triggeredjsapievents>
705     </ca:jsfunction>
706     <ca:jsfunction>
707       <ca:name>ROIRectToolGetMousePosition</ca:name>
708       <ca:scope title="Scope">
709         <ca:value>Private</ca:value>
710       </ca:scope>
711       <ca:description></ca:description>
712       <ca:parameters title="Parameters">
713         <ca:parameter>
714           <ca:name>e</ca:name>
715           <ca:type title="Type">
716             <ca:value>string</ca:value>
717           </ca:type>
718           <ca:default title="Default">
719             <ca:value></ca:value>
720             <ca:description></ca:description>
721           </ca:default>
722           <ca:possvalues type="list" title="Values">
723             <ca:value></ca:value>
724           </ca:possvalues>
725           <ca:description></ca:description>
726         </ca:parameter>
727       </ca:parameters>
728       <ca:returnvalues title="Function Return Value">
729         <ca:returnvalue>
730           <ca:type title="Type">
731             <ca:value>unknown</ca:value>
732             <ca:description></ca:description>
733           </ca:type>
734           <ca:default title="Default">
735             <ca:value></ca:value>
736           </ca:default>
737           <ca:possvalues type="list" title="Values">
738             <ca:value></ca:value>
739           </ca:possvalues>
740           <ca:description></ca:description>
741         </ca:returnvalue>
742       </ca:returnvalues>
743       <ca:triggeredjsapievents title="JSAPI Triggered Events">
744         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
745         <ca:triggeredjsapievent title="">
746           <ca:name></ca:name>
747           <ca:description></ca:description>
748         </ca:triggeredjsapievent>
749       </ca:triggeredjsapievents>
750     </ca:jsfunction>
751     <ca:jsfunction>
752       <ca:name>ROIRectToolMouseMove</ca:name>
753       <ca:scope title="Scope">
754         <ca:value>Private</ca:value>
755       </ca:scope>
756       <ca:description></ca:description>
757       <ca:parameters title="Parameters">
758         <ca:parameter>
759           <ca:name>e</ca:name>
760           <ca:type title="Type">
761             <ca:value>string</ca:value>
762           </ca:type>
763           <ca:default title="Default">
764             <ca:value></ca:value>
765             <ca:description></ca:description>
766           </ca:default>
767           <ca:possvalues type="list" title="Values">
768             <ca:value></ca:value>
769           </ca:possvalues>
770           <ca:description></ca:description>
771         </ca:parameter>
772       </ca:parameters>
773       <ca:returnvalues title="Function Return Value">
774         <ca:returnvalue>
775           <ca:type title="Type">
776             <ca:value>unknown</ca:value>
777             <ca:description></ca:description>
778           </ca:type>
779           <ca:default title="Default">
780             <ca:value></ca:value>
781           </ca:default>
782           <ca:possvalues type="list" title="Values">
783             <ca:value></ca:value>
784           </ca:possvalues>
785           <ca:description></ca:description>
786         </ca:returnvalue>
787       </ca:returnvalues>
788       <ca:triggeredjsapievents title="JSAPI Triggered Events">
789         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
790         <ca:triggeredjsapievent title="">
791           <ca:name></ca:name>
792           <ca:description></ca:description>
793         </ca:triggeredjsapievent>
794       </ca:triggeredjsapievents>
795     </ca:jsfunction>
796   </ca:jsfunctions>
797   <ca:jsfiles title="JavaScript Files">
798     <ca:jsfile>
799       <ca:name></ca:name>
800       <ca:description></ca:description>
801       <ca:jsvariables title="JavaScript Variables">
802         <ca:jsvariable>
803           <ca:name></ca:name>
804           <ca:type title="Type">
805             <ca:value>string</ca:value>
806           </ca:type>
807           <ca:scope title="Scope">
808             <ca:value>Private</ca:value>
809           </ca:scope>
810           <ca:default title="Default">
811             <ca:value></ca:value>
812           </ca:default>
813           <ca:possvalues type="list" title="Values">
814             <ca:value></ca:value>
815           </ca:possvalues>
816           <ca:description></ca:description>
817         </ca:jsvariable>
818       </ca:jsvariables>
819       <ca:jsfunctions title="JavaScript Functions">
820         <ca:jsfunction>
821           <ca:name></ca:name>
822           <ca:scope title="Scope">
823             <ca:value>Private</ca:value>
824           </ca:scope>
825           <ca:description></ca:description>
826           <ca:parameters title="Parameters">
827             <ca:parameter>
828               <ca:name></ca:name>
829               <ca:type title="Type">
830                 <ca:value>string</ca:value>
831               </ca:type>
832               <ca:required title="Required">
833                 <ca:value>false</ca:value>
834               </ca:required>
835               <ca:default title="Default">
836                 <ca:value></ca:value>
837                 <ca:description></ca:description>
838               </ca:default>
839               <ca:possvalues type="list" title="Values">
840                 <ca:value></ca:value>
841               </ca:possvalues>
842               <ca:description></ca:description>
843             </ca:parameter>
844           </ca:parameters>
845           <ca:returnvalues title="Function Return Value">
846             <ca:returnvalue>
847               <ca:type title="Type">
848                 <ca:value>unknown</ca:value>
849                 <ca:description></ca:description>
850               </ca:type>
851               <ca:default title="Default">
852                 <ca:value></ca:value>
853               </ca:default>
854               <ca:possvalues type="list" title="Values">
855                 <ca:value></ca:value>
856               </ca:possvalues>
857               <ca:description></ca:description>
858             </ca:returnvalue>
859           </ca:returnvalues>
860           <ca:triggeredjsapievents title="JSAPI Triggered Events">
861             <ca:triggeredjsapievent title="">
862               <ca:name></ca:name>
863               <ca:description></ca:description>
864             </ca:triggeredjsapievent>
865           </ca:triggeredjsapievents>
866         </ca:jsfunction>
867       </ca:jsfunctions>
868     </ca:jsfile>
869   </ca:jsfiles>
870   <ca:listenedjsapievents title="JSAPI Listened Events">
871     <ca:listenedjsapievent title="">
872       <ca:name></ca:name>
873       <ca:description></ca:description>
874       <ca:calledfunctions title="Functions Calls">
875         <ca:intro>JSAPI function calls for this widget are outlined here. </ca:intro>
876         <ca:calledfunction>
877           <ca:name></ca:name>
878           <ca:description></ca:description>
879         </ca:calledfunction>
880       </ca:calledfunctions>
881     </ca:listenedjsapievent>
882   </ca:listenedjsapievents>
883   <ca:widgetevents title="Widget Events">
884     <ca:widgetevent>
885       <ca:name></ca:name>
886       <ca:parameters title="Parameters">
887         <ca:parameter>
888           <ca:name></ca:name>
889           <ca:type title="Type">
890             <ca:value>string</ca:value>
891           </ca:type>
892           <ca:required title="Required">
893             <ca:value>false</ca:value>
894           </ca:required>
895           <ca:default title="Default">
896             <ca:value></ca:value>
897             <ca:description></ca:description>
898           </ca:default>
899           <ca:possvalues type="list" title="Values">
900             <ca:value></ca:value>
901           </ca:possvalues>
902           <ca:description></ca:description>
903         </ca:parameter>
904       </ca:parameters>
905       <ca:description></ca:description>
906     </ca:widgetevent>
907   </ca:widgetevents>
908   <ca:errors title="Widget Errors">
909     <ca:error title="Error #1">
910       <ca:type title="Type">
911         <ca:value>PHP Mapscript</ca:value>
912       </ca:type>
913       <ca:severity title="Severity">
914         <ca:value>none</ca:value>
915         <ca:description></ca:description>
916       </ca:severity>
917       <ca:message title="Error Message">
918         <ca:paras title="">
919           <ca:para>Error message string....</ca:para>
920         </ca:paras>
921       </ca:message>
922       <ca:meaning title="Interpretation">
923         <ca:paras title="">
924           <ca:para>The description of what the message means......</ca:para>
925         </ca:paras>
926       </ca:meaning>
927       <ca:solution title="Troubleshooting Tips">
928         <ca:paras title="">
929           <ca:para>Any possible solution that will help application developers troubleshoot and fix the problem.</ca:para>
930         </ca:paras>
931       </ca:solution>
932     </ca:error>
933   </ca:errors>
934 </ca:widgetdoc>
Note: See TracBrowser for help on using the browser.