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

root/Chameleon/trunk/Chameleon/XMLThemeLegend/XMLThemeLegend.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>xmlthemelegend</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 XMLThemeLegend widget provides generic legend control capabilities
62 for Chameleon applications.  The widget is controlled by a template file and a theme
63 file that describe how layers in the current context should be presented to the
64 user.</ca:para>
65       </ca:paras>
66     </ca:description>
67     <ca:techrequirements title="Technical Requirements">
68       <ca:paras title="Not Available">
69         <ca:para></ca:para>
70       </ca:paras>
71     </ca:techrequirements>
72     <ca:dependancies title="Dependancies">
73       <ca:dependancy type="None" title="Not Available">
74         <ca:para></ca:para>
75       </ca:dependancy>
76     </ca:dependancies>
77     <ca:sharedresources title="Shared Resources">
78       <ca:paras title="Not Available">
79         <ca:para></ca:para>
80       </ca:paras>
81     </ca:sharedresources>
82     <ca:embeddedhelp title="General User Interface Help">
83       <ca:paras title="">
84         <ca:para>This widget provides the capability to select between several contexts defined for this application.
85 The XML Theme Legend widget also provides the capability to modify the visibility of layers and groups of layers in the
86 current context. To change the visibility of a layer, click the checkbox next to the layer name or theme name and click
87 the apply button.</ca:para>
88       </ca:paras>
89     </ca:embeddedhelp>
90     <ca:guinotes title="Interface Functionality">
91       <ca:guinote type="None" title="None.">
92         <ca:para></ca:para>
93       </ca:guinote>
94     </ca:guinotes>
95     <ca:qanotes title="Quality Assurance">
96       <ca:paras title="None.">
97         <ca:para></ca:para>
98       </ca:paras>
99     </ca:qanotes>
100   </ca:descriptions>
101   <ca:tagstructures title="Tag Syntax">
102     <ca:tagstructure title="Widget Syntax">
103       <ca:description></ca:description>
104       <ca:code title="">
105         <ca:description></ca:description>
106         <ca:codeblock bold="false"/>
107       </ca:code>
108     </ca:tagstructure>
109   </ca:tagstructures>
110   <ca:examples title="Examples">
111     <ca:widgetexamples title="Widget Examples">
112       <ca:example title="Example #1: Simple">
113         <ca:description></ca:description>
114         <ca:code title="">
115           <ca:description></ca:description>
116           <ca:codeblock bold="false">
117             <ca:line></ca:line>
118           </ca:codeblock>
119         </ca:code>
120       </ca:example>
121     </ca:widgetexamples>
122     <ca:sharedresourceexamples title="Shared Resources Examples">
123       <ca:example title="Example #1: Advanced">
124         <ca:description></ca:description>
125         <ca:code title="">
126           <ca:description></ca:description>
127           <ca:codeblock bold="false">
128             <ca:line></ca:line>
129           </ca:codeblock>
130         </ca:code>
131       </ca:example>
132     </ca:sharedresourceexamples>
133     <ca:sampleapps title="Sample Applications">
134       <ca:sampleapp>
135         <ca:name>Hawaii Demo</ca:name>
136         <ca:appurl>http://www.mapsherpa.com/hawaii2/</ca:appurl>
137         <ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description>
138       </ca:sampleapp>
139     </ca:sampleapps>
140     <ca:scriptexamples title="Script Examples">
141       <ca:example title="Example #1: Simple">
142         <ca:description></ca:description>
143         <ca:code title="">
144           <ca:description></ca:description>
145           <ca:codeblock bold="false">
146             <ca:line></ca:line>
147           </ca:codeblock>
148         </ca:code>
149       </ca:example>
150     </ca:scriptexamples>
151   </ca:examples>
152   <ca:attributegroups title="Attribute Groups">
153     <ca:description></ca:description>
154     <ca:attributegroup>
155       <ca:name>base</ca:name>
156       <ca:name>popup</ca:name>
157     </ca:attributegroup>
158   </ca:attributegroups>
159   <ca:widgettag title="Attributes">
160     <ca:subtag>
161       <ca:name></ca:name>
162       <ca:type title="Type">
163         <ca:value>XML</ca:value>
164         <ca:description>Child Element to Chameleon widget tag (subtag)</ca:description>
165       </ca:type>
166       <ca:class title="Class">
167         <ca:value>Widget &amp; Shared Resource</ca:value>
168       </ca:class>
169       <ca:description></ca:description>
170       <ca:attribute>
171         <ca:name></ca:name>
172         <ca:type title="Type">
173           <ca:value>float</ca:value>
174           <ca:description></ca:description>
175         </ca:type>
176         <ca:class title="Class">
177           <ca:value>Widget &amp; Shared Resource</ca:value>
178         </ca:class>
179         <ca:default title="Default">
180           <ca:value></ca:value>
181           <ca:description></ca:description>
182         </ca:default>
183         <ca:possvalues type="list" title="Value">
184           <ca:value></ca:value>
185         </ca:possvalues>
186         <ca:description></ca:description>
187       </ca:attribute>
188     </ca:subtag>
189   </ca:widgettag>
190   <ca:formelements title="Form Elements">
191     <ca:formelement>
192       <ca:name>CONTEXTSELECTOR</ca:name>
193       <ca:type title="Type">
194         <ca:value>unknown</ca:value>
195
196       </ca:type>
197       <ca:default title="Default">
198         <ca:value></ca:value>
199         <ca:description></ca:description>
200       </ca:default>
201       <ca:possvalues type="list" title="Values">
202         <ca:value></ca:value>
203       </ca:possvalues>
204       <ca:description>Used by XMLThemeLegend to avoid processing URL values on first load.</ca:description>
205     </ca:formelement>
206     <ca:formelement>
207       <ca:name>CONTEXT</ca:name>
208       <ca:type title="Type">
209         <ca:value>unknown</ca:value>
210         <ca:description></ca:description>
211       </ca:type>
212       <ca:default title="Default">
213         <ca:value></ca:value>
214         <ca:description></ca:description>
215       </ca:default>
216       <ca:possvalues type="list" title="Values">
217         <ca:value></ca:value>
218       </ca:possvalues>
219       <ca:description>The currently loaded context</ca:description>
220     </ca:formelement>
221     <ca:formelement>
222       <ca:name>TEMPLATE</ca:name>
223       <ca:type title="Type">
224         <ca:value>unknown</ca:value>
225         <ca:description></ca:description>
226       </ca:type>
227       <ca:default title="Default">
228         <ca:value></ca:value>
229         <ca:description></ca:description>
230       </ca:default>
231       <ca:possvalues type="list" title="Values">
232         <ca:value></ca:value>
233       </ca:possvalues>
234       <ca:description>The current template that is being displayed</ca:description>
235     </ca:formelement>
236     <ca:formelement>
237       <ca:name>CONTEXTSELECTOR_CONTEXT_CHANGED</ca:name>
238       <ca:type title="Type">
239         <ca:value>unknown</ca:value>
240         <ca:description></ca:description>
241       </ca:type>
242       <ca:default title="Default">
243         <ca:value></ca:value>
244         <ca:description></ca:description>
245       </ca:default>
246       <ca:possvalues type="list" title="Values">
247         <ca:value></ca:value>
248       </ca:possvalues>
249       <ca:description>Used by XMLThemeLegend to determine if the current context has changed.</ca:description>
250     </ca:formelement>
251     <ca:formelement>
252       <ca:name>CONTEXTSELECTOR_LAYERS_ON</ca:name>
253       <ca:type title="Type">
254         <ca:value>unknown</ca:value>
255         <ca:description></ca:description>
256       </ca:type>
257       <ca:default title="Default">
258         <ca:value></ca:value>
259         <ca:description></ca:description>
260       </ca:default>
261       <ca:possvalues type="list" title="Values">
262         <ca:value></ca:value>
263       </ca:possvalues>
264       <ca:description>Used by XMLThemeLegend to track which layers are currently visible.</ca:description>
265     </ca:formelement>
266     <ca:formelement>
267       <ca:name>CONTEXTSELECTOR_ALL_LAYERS</ca:name>
268       <ca:type title="Type">
269         <ca:value>unknown</ca:value>
270         <ca:description></ca:description>
271       </ca:type>
272       <ca:default title="Default">
273         <ca:value></ca:value>
274         <ca:description></ca:description>
275       </ca:default>
276       <ca:possvalues type="list" title="Values">
277         <ca:value></ca:value>
278       </ca:possvalues>
279       <ca:description>Used by XMLThemeLegend to track all layers that are currently being controlled.</ca:description>
280     </ca:formelement>
281     <ca:formelement>
282       <ca:name>CONTEXTSELECTOR_TEMPLATE</ca:name>
283       <ca:type title="Type">
284         <ca:value>unknown</ca:value>
285         <ca:description></ca:description>
286       </ca:type>
287       <ca:default title="Default">
288         <ca:value></ca:value>
289         <ca:description></ca:description>
290       </ca:default>
291       <ca:possvalues type="list" title="Values">
292         <ca:value></ca:value>
293       </ca:possvalues>
294       <ca:description>Used by XMLThemeLegend to remember the name of the current template.</ca:description>
295     </ca:formelement>
296   </ca:formelements>
297   <ca:jsvariables title="JavaScript Variables">
298     <ca:jsvariable>
299       <ca:name>gContextSelectorManager</ca:name>
300       <ca:type title="Type">
301         <ca:value></ca:value>
302       </ca:type>
303       <ca:scope title="Scope">
304         <ca:value>Private</ca:value>
305       </ca:scope>
306       <ca:default title="Default">
307         <ca:value></ca:value>
308       </ca:default>
309       <ca:possvalues type="list" title="Values">
310         <ca:value></ca:value>
311       </ca:possvalues>
312       <ca:description>The global context selector manager.</ca:description>
313     </ca:jsvariable>
314   </ca:jsvariables>
315   <ca:jsfunctions title="JavaScript Functions">
316     <ca:jsfunction>
317       <ca:name>ContextSelector_initialize</ca:name>
318       <ca:scope title="Scope">
319         <ca:value>Private</ca:value>
320       </ca:scope>
321       <ca:description>Called by the XMLThemeLegend to initialize all themes and groups.</ca:description>
322       <ca:returnvalues title="Function Return Value">
323         <ca:returnvalue>
324           <ca:type title="Type">
325             <ca:value>unknown</ca:value>
326             <ca:description></ca:description>
327           </ca:type>
328           <ca:default title="Default">
329             <ca:value></ca:value>
330           </ca:default>
331           <ca:possvalues type="list" title="Values">
332             <ca:value></ca:value>
333           </ca:possvalues>
334           <ca:description></ca:description>
335         </ca:returnvalue>
336       </ca:returnvalues>
337       <ca:triggeredjsapievents title="JSAPI Triggered Events">
338         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
339         <ca:triggeredjsapievent title="">
340           <ca:name></ca:name>
341           <ca:description></ca:description>
342         </ca:triggeredjsapievent>
343       </ca:triggeredjsapievents>
344     </ca:jsfunction>
345     <ca:jsfunction>
346       <ca:name>ContextSelector_openGroupInfo</ca:name>
347       <ca:scope title="Scope">
348         <ca:value>Private</ca:value>
349       </ca:scope>
350       <ca:description>Called by the XMLThemeLegend to display metadata about layers in a group.</ca:description>
351       <ca:parameters title="Parameters">
352         <ca:parameter>
353           <ca:name>groupName</ca:name>
354           <ca:type title="Type">
355             <ca:value>string</ca:value>
356           </ca:type>
357           <ca:default title="Default">
358             <ca:value></ca:value>
359             <ca:description></ca:description>
360           </ca:default>
361           <ca:possvalues type="list" title="Values">
362             <ca:value></ca:value>
363           </ca:possvalues>
364           <ca:description></ca:description>
365         </ca:parameter>
366         <ca:parameter>
367           <ca:name>groupAbstract</ca:name>
368           <ca:type title="Type">
369             <ca:value>string</ca:value>
370           </ca:type>
371           <ca:default title="Default">
372             <ca:value></ca:value>
373             <ca:description></ca:description>
374           </ca:default>
375           <ca:possvalues type="list" title="Values">
376             <ca:value></ca:value>
377           </ca:possvalues>
378           <ca:description></ca:description>
379         </ca:parameter>
380         <ca:parameter>
381           <ca:name>groupLayers</ca:name>
382           <ca:type title="Type">
383             <ca:value>string</ca:value>
384           </ca:type>
385           <ca:default title="Default">
386             <ca:value></ca:value>
387             <ca:description></ca:description>
388           </ca:default>
389           <ca:possvalues type="list" title="Values">
390             <ca:value></ca:value>
391           </ca:possvalues>
392           <ca:description></ca:description>
393         </ca:parameter>
394       </ca:parameters>
395       <ca:returnvalues title="Function Return Value">
396         <ca:returnvalue>
397           <ca:type title="Type">
398             <ca:value>unknown</ca:value>
399             <ca:description></ca:description>
400           </ca:type>
401           <ca:default title="Default">
402             <ca:value></ca:value>
403           </ca:default>
404           <ca:possvalues type="list" title="Values">
405             <ca:value></ca:value>
406           </ca:possvalues>
407           <ca:description></ca:description>
408         </ca:returnvalue>
409       </ca:returnvalues>
410       <ca:triggeredjsapievents title="JSAPI Triggered Events">
411         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
412         <ca:triggeredjsapievent title="">
413           <ca:name></ca:name>
414           <ca:description></ca:description>
415         </ca:triggeredjsapievent>
416       </ca:triggeredjsapievents>
417     </ca:jsfunction>
418     <ca:jsfunction>
419       <ca:name>ContextSelector_openThemeInfo</ca:name>
420       <ca:scope title="Scope">
421         <ca:value>Private</ca:value>
422       </ca:scope>
423       <ca:description>Called by the XMLThemeLegend to display metadata about all groups and layers in a theme.</ca:description>
424       <ca:parameters title="Parameters">
425         <ca:parameter>
426           <ca:name>themeName</ca:name>
427           <ca:type title="Type">
428             <ca:value>string</ca:value>
429           </ca:type>
430           <ca:default title="Default">
431             <ca:value></ca:value>
432             <ca:description></ca:description>
433           </ca:default>
434           <ca:possvalues type="list" title="Values">
435             <ca:value></ca:value>
436           </ca:possvalues>
437           <ca:description></ca:description>
438         </ca:parameter>
439         <ca:parameter>
440           <ca:name>themeAbstract</ca:name>
441           <ca:type title="Type">
442             <ca:value>string</ca:value>
443           </ca:type>
444           <ca:default title="Default">
445             <ca:value></ca:value>
446             <ca:description></ca:description>
447           </ca:default>
448           <ca:possvalues type="list" title="Values">
449             <ca:value></ca:value>
450           </ca:possvalues>
451           <ca:description></ca:description>
452         </ca:parameter>
453         <ca:parameter>
454           <ca:name>themeGroups</ca:name>
455           <ca:type title="Type">
456             <ca:value>string</ca:value>
457           </ca:type>
458           <ca:default title="Default">
459             <ca:value></ca:value>
460             <ca:description></ca:description>
461           </ca:default>
462           <ca:possvalues type="list" title="Values">
463             <ca:value></ca:value>
464           </ca:possvalues>
465           <ca:description></ca:description>
466         </ca:parameter>
467       </ca:parameters>
468       <ca:returnvalues title="Function Return Value">
469         <ca:returnvalue>
470           <ca:type title="Type">
471             <ca:value>unknown</ca:value>
472             <ca:description></ca:description>
473           </ca:type>
474           <ca:default title="Default">
475             <ca:value></ca:value>
476           </ca:default>
477           <ca:possvalues type="list" title="Values">
478             <ca:value></ca:value>
479           </ca:possvalues>
480           <ca:description></ca:description>
481         </ca:returnvalue>
482       </ca:returnvalues>
483       <ca:triggeredjsapievents title="JSAPI Triggered Events">
484         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
485         <ca:triggeredjsapievent title="">
486           <ca:name></ca:name>
487           <ca:description></ca:description>
488         </ca:triggeredjsapievent>
489       </ca:triggeredjsapievents>
490     </ca:jsfunction>
491     <ca:jsfunction>
492       <ca:name>ContextSelector_SetThemeStatus</ca:name>
493       <ca:scope title="Scope">
494         <ca:value>Private</ca:value>
495       </ca:scope>
496       <ca:description>Called by the XMLThemeLegend to toggle the state of a theme.</ca:description>
497       <ca:parameters title="Parameters">
498         <ca:parameter>
499           <ca:name>nTheme</ca:name>
500           <ca:type title="Type">
501             <ca:value>string</ca:value>
502           </ca:type>
503           <ca:default title="Default">
504             <ca:value></ca:value>
505             <ca:description></ca:description>
506           </ca:default>
507           <ca:possvalues type="list" title="Values">
508             <ca:value></ca:value>
509           </ca:possvalues>
510           <ca:description></ca:description>
511         </ca:parameter>
512         <ca:parameter>
513           <ca:name>bStatus</ca:name>
514           <ca:type title="Type">
515             <ca:value>string</ca:value>
516           </ca:type>
517           <ca:default title="Default">
518             <ca:value></ca:value>
519             <ca:description></ca:description>
520           </ca:default>
521           <ca:possvalues type="list" title="Values">
522             <ca:value></ca:value>
523           </ca:possvalues>
524           <ca:description></ca:description>
525         </ca:parameter>
526       </ca:parameters>
527       <ca:returnvalues title="Function Return Value">
528         <ca:returnvalue>
529           <ca:type title="Type">
530             <ca:value>unknown</ca:value>
531             <ca:description></ca:description>
532           </ca:type>
533           <ca:default title="Default">
534             <ca:value></ca:value>
535           </ca:default>
536           <ca:possvalues type="list" title="Values">
537             <ca:value></ca:value>
538           </ca:possvalues>
539           <ca:description></ca:description>
540         </ca:returnvalue>
541       </ca:returnvalues>
542       <ca:triggeredjsapievents title="JSAPI Triggered Events">
543         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
544         <ca:triggeredjsapievent title="">
545           <ca:name></ca:name>
546           <ca:description></ca:description>
547         </ca:triggeredjsapievent>
548       </ca:triggeredjsapievents>
549     </ca:jsfunction>
550     <ca:jsfunction>
551       <ca:name>ContextSelector_SetGroupStatus</ca:name>
552       <ca:scope title="Scope">
553         <ca:value>Private</ca:value>
554       </ca:scope>
555       <ca:description>Called by the XMLThemeLegend to toggle the state of a group of layers.</ca:description>
556       <ca:parameters title="Parameters">
557         <ca:parameter>
558           <ca:name>nTheme</ca:name>
559           <ca:type title="Type">
560             <ca:value>string</ca:value>
561           </ca:type>
562           <ca:default title="Default">
563             <ca:value></ca:value>
564             <ca:description></ca:description>
565           </ca:default>
566           <ca:possvalues type="list" title="Values">
567             <ca:value></ca:value>
568           </ca:possvalues>
569           <ca:description></ca:description>
570         </ca:parameter>
571         <ca:parameter>
572           <ca:name>nGroup</ca:name>
573           <ca:type title="Type">
574             <ca:value>string</ca:value>
575           </ca:type>
576           <ca:default title="Default">
577             <ca:value></ca:value>
578             <ca:description></ca:description>
579           </ca:default>
580           <ca:possvalues type="list" title="Values">
581             <ca:value></ca:value>
582           </ca:possvalues>
583           <ca:description></ca:description>
584         </ca:parameter>
585         <ca:parameter>
586           <ca:name>bStatus</ca:name>
587           <ca:type title="Type">
588             <ca:value>string</ca:value>
589           </ca:type>
590           <ca:default title="Default">
591             <ca:value></ca:value>
592             <ca:description></ca:description>
593           </ca:default>
594           <ca:possvalues type="list" title="Values">
595             <ca:value></ca:value>
596           </ca:possvalues>
597           <ca:description></ca:description>
598         </ca:parameter>
599       </ca:parameters>
600       <ca:returnvalues title="Function Return Value">
601         <ca:returnvalue>
602           <ca:type title="Type">
603             <ca:value>unknown</ca:value>
604             <ca:description></ca:description>
605           </ca:type>
606           <ca:default title="Default">
607             <ca:value></ca:value>
608           </ca:default>
609           <ca:possvalues type="list" title="Values">
610             <ca:value></ca:value>
611           </ca:possvalues>
612           <ca:description></ca:description>
613         </ca:returnvalue>
614       </ca:returnvalues>
615       <ca:triggeredjsapievents title="JSAPI Triggered Events">
616         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
617         <ca:triggeredjsapievent title="">
618           <ca:name></ca:name>
619           <ca:description></ca:description>
620         </ca:triggeredjsapievent>
621       </ca:triggeredjsapievents>
622     </ca:jsfunction>
623     <ca:jsfunction>
624       <ca:name>ContextSelected</ca:name>
625       <ca:scope title="Scope">
626         <ca:value>Private</ca:value>
627       </ca:scope>
628       <ca:description>Called by the XMLThemeLegend when a new context has been requested by the user.</ca:description>
629       <ca:parameters title="Parameters">
630         <ca:parameter>
631           <ca:name>szTemplate</ca:name>
632           <ca:type title="Type">
633             <ca:value>string</ca:value>
634           </ca:type>
635           <ca:default title="Default">
636             <ca:value></ca:value>
637             <ca:description></ca:description>
638           </ca:default>
639           <ca:possvalues type="list" title="Values">
640             <ca:value></ca:value>
641           </ca:possvalues>
642           <ca:description></ca:description>
643         </ca:parameter>
644         <ca:parameter>
645           <ca:name>szContext</ca:name>
646           <ca:type title="Type">
647             <ca:value>string</ca:value>
648           </ca:type>
649           <ca:default title="Default">
650             <ca:value></ca:value>
651             <ca:description></ca:description>
652           </ca:default>
653           <ca:possvalues type="list" title="Values">
654             <ca:value></ca:value>
655           </ca:possvalues>
656           <ca:description></ca:description>
657         </ca:parameter>
658       </ca:parameters>
659       <ca:returnvalues title="Function Return Value">
660         <ca:returnvalue>
661           <ca:type title="Type">
662             <ca:value>unknown</ca:value>
663             <ca:description></ca:description>
664           </ca:type>
665           <ca:default title="Default">
666             <ca:value></ca:value>
667           </ca:default>
668           <ca:possvalues type="list" title="Values">
669             <ca:value></ca:value>
670           </ca:possvalues>
671           <ca:description></ca:description>
672         </ca:returnvalue>
673       </ca:returnvalues>
674       <ca:triggeredjsapievents title="JSAPI Triggered Events">
675         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
676         <ca:triggeredjsapievent title="">
677           <ca:name></ca:name>
678           <ca:description></ca:description>
679         </ca:triggeredjsapievent>
680       </ca:triggeredjsapievents>
681     </ca:jsfunction>
682   </ca:jsfunctions>
683   <ca:jsfiles title="JavaScript Files">
684     <ca:jsfile>
685       <ca:name></ca:name>
686       <ca:description></ca:description>
687       <ca:jsvariables title="JavaScript Variables">
688         <ca:jsvariable>
689           <ca:name></ca:name>
690           <ca:type title="Type">
691             <ca:value>string</ca:value>
692           </ca:type>
693           <ca:scope title="Scope">
694             <ca:value>Private</ca:value>
695           </ca:scope>
696           <ca:default title="Default">
697             <ca:value></ca:value>
698           </ca:default>
699           <ca:possvalues type="list" title="Values">
700             <ca:value></ca:value>
701           </ca:possvalues>
702           <ca:description></ca:description>
703         </ca:jsvariable>
704       </ca:jsvariables>
705       <ca:jsfunctions title="JavaScript Functions">
706         <ca:jsfunction>
707           <ca:name></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></ca:name>
715               <ca:type title="Type">
716                 <ca:value>string</ca:value>
717               </ca:type>
718               <ca:required title="Required">
719                 <ca:value>false</ca:value>
720               </ca:required>
721               <ca:default title="Default">
722                 <ca:value></ca:value>
723                 <ca:description></ca:description>
724               </ca:default>
725               <ca:possvalues type="list" title="Values">
726                 <ca:value></ca:value>
727               </ca:possvalues>
728               <ca:description></ca:description>
729             </ca:parameter>
730           </ca:parameters>
731           <ca:returnvalues title="Function Return Value">
732             <ca:returnvalue>
733               <ca:type title="Type">
734                 <ca:value>unknown</ca:value>
735                 <ca:description></ca:description>
736               </ca:type>
737               <ca:default title="Default">
738                 <ca:value></ca:value>
739               </ca:default>
740               <ca:possvalues type="list" title="Values">
741                 <ca:value></ca:value>
742               </ca:possvalues>
743               <ca:description></ca:description>
744             </ca:returnvalue>
745           </ca:returnvalues>
746           <ca:triggeredjsapievents title="JSAPI Triggered Events">
747             <ca:triggeredjsapievent title="">
748               <ca:name></ca:name>
749               <ca:description></ca:description>
750             </ca:triggeredjsapievent>
751           </ca:triggeredjsapievents>
752         </ca:jsfunction>
753       </ca:jsfunctions>
754     </ca:jsfile>
755   </ca:jsfiles>
756   <ca:listenedjsapievents title="JSAPI Listened Events">
757     <ca:listenedjsapievent title="">
758       <ca:name></ca:name>
759       <ca:description></ca:description>
760       <ca:calledfunctions title="Functions Calls">
761         <ca:intro>JSAPI function calls for this widget are outlined here. </ca:intro>
762         <ca:calledfunction>
763           <ca:name></ca:name>
764           <ca:description></ca:description>
765         </ca:calledfunction>
766       </ca:calledfunctions>
767     </ca:listenedjsapievent>
768   </ca:listenedjsapievents>
769   <ca:widgetevents title="Widget Events">
770     <ca:widgetevent>
771       <ca:name></ca:name>
772       <ca:parameters title="Parameters">
773         <ca:parameter>
774           <ca:name></ca:name>
775           <ca:type title="Type">
776             <ca:value>string</ca:value>
777           </ca:type>
778           <ca:required title="Required">
779             <ca:value>false</ca:value>
780           </ca:required>
781           <ca:default title="Default">
782             <ca:value></ca:value>
783             <ca:description></ca:description>
784           </ca:default>
785           <ca:possvalues type="list" title="Values">
786             <ca:value></ca:value>
787           </ca:possvalues>
788           <ca:description></ca:description>
789         </ca:parameter>
790       </ca:parameters>
791       <ca:description></ca:description>
792     </ca:widgetevent>
793   </ca:widgetevents>
794   <ca:errors title="Widget Errors">
795     <ca:error title="Error #1">
796       <ca:type title="Type">
797         <ca:value>PHP Mapscript</ca:value>
798       </ca:type>
799       <ca:severity title="Severity">
800         <ca:value>none</ca:value>
801         <ca:description></ca:description>
802       </ca:severity>
803       <ca:message title="Error Message">
804         <ca:paras title="">
805           <ca:para>Error message string....</ca:para>
806         </ca:paras>
807       </ca:message>
808       <ca:meaning title="Interpretation">
809         <ca:paras title="">
810           <ca:para>The description of what the message means......</ca:para>
811         </ca:paras>
812       </ca:meaning>
813       <ca:solution title="Troubleshooting Tips">
814         <ca:paras title="">
815           <ca:para>Any possible solution that will help application developers troubleshoot and fix the problem.</ca:para>
816         </ca:paras>
817       </ca:solution>
818     </ca:error>
819   </ca:errors>
820 </ca:widgetdoc>
Note: See TracBrowser for help on using the browser.