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

root/Chameleon/trunk/Chameleon/KeyMapDHTMLMode/KeyMapDHTMLMode.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>keymapdhtmlmode</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 KeyMapDHTMLMode widget allows the user to set the current mode
62 of the KeyMapDHTML.</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:line>   MODE ="[string]"</ca:line>
103         </ca:codeblock>
104       </ca:code>
105     </ca:tagstructure>
106   </ca:tagstructures>
107   <ca:examples title="Examples">
108     <ca:widgetexamples title="Widget Examples">
109       <ca:example title="Example #1: Simple">
110         <ca:description></ca:description>
111         <ca:code title="">
112           <ca:description></ca:description>
113           <ca:codeblock bold="false">
114             <ca:line></ca:line>
115           </ca:codeblock>
116         </ca:code>
117       </ca:example>
118     </ca:widgetexamples>
119     <ca:sharedresourceexamples title="Shared Resources Examples">
120       <ca:example title="Example #1: Advanced">
121         <ca:description></ca:description>
122         <ca:code title="">
123           <ca:description></ca:description>
124           <ca:codeblock bold="false">
125             <ca:line></ca:line>
126           </ca:codeblock>
127         </ca:code>
128       </ca:example>
129     </ca:sharedresourceexamples>
130     <ca:sampleapps title="Sample Applications">
131       <ca:sampleapp>
132         <ca:name>Hawaii Demo</ca:name>
133         <ca:appurl>http://www.mapsherpa.com/hawaii2/</ca:appurl>
134         <ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description>
135       </ca:sampleapp>
136     </ca:sampleapps>
137     <ca:scriptexamples title="Script Examples">
138       <ca:example title="Example #1: Simple">
139         <ca:description></ca:description>
140         <ca:code title="">
141           <ca:description></ca:description>
142           <ca:codeblock bold="false">
143             <ca:line></ca:line>
144           </ca:codeblock>
145         </ca:code>
146       </ca:example>
147     </ca:scriptexamples>
148   </ca:examples>
149   <ca:attributegroups title="Attribute Groups">
150     <ca:description></ca:description>
151     <ca:attributegroup>
152       <ca:name>base</ca:name>
153       <ca:name>button</ca:name>
154     </ca:attributegroup>
155   </ca:attributegroups>
156   <ca:widgettag title="Attributes">
157     <ca:attribute>
158       <ca:name>MODE</ca:name>
159       <ca:type title="Type">
160         <ca:value>string</ca:value>
161         <ca:description></ca:description>
162       </ca:type>
163       <ca:class title="Class">
164         <ca:value>Widget Only</ca:value>
165       </ca:class>
166       <ca:default title="Default">
167         <ca:description></ca:description>
168       </ca:default>
169     </ca:attribute>
170     <ca:subtag>
171       <ca:name></ca:name>
172       <ca:type title="Type">
173         <ca:value>XML</ca:value>
174         <ca:description>Child Element to Chameleon widget tag (subtag)</ca:description>
175       </ca:type>
176       <ca:class title="Class">
177         <ca:value>Widget &amp; Shared Resource</ca:value>
178       </ca:class>
179       <ca:description></ca:description>
180       <ca:attribute>
181         <ca:name></ca:name>
182         <ca:type title="Type">
183           <ca:value>float</ca:value>
184           <ca:description></ca:description>
185         </ca:type>
186         <ca:class title="Class">
187           <ca:value>Widget &amp; Shared Resource</ca:value>
188         </ca:class>
189         <ca:default title="Default">
190           <ca:value></ca:value>
191           <ca:description></ca:description>
192         </ca:default>
193         <ca:possvalues type="list" title="Value">
194           <ca:value></ca:value>
195         </ca:possvalues>
196         <ca:description></ca:description>
197       </ca:attribute>
198     </ca:subtag>
199   </ca:widgettag>
200   <ca:formelements title="Form Elements">
201     <ca:formelement>
202       <ca:name>KEYMAP_DHTML_MODE</ca:name>
203       <ca:type title="Type">
204         <ca:value>unknown</ca:value>
205         <ca:description></ca:description>
206       </ca:type>
207       <ca:default title="Default">
208         <ca:value></ca:value>
209         <ca:description></ca:description>
210       </ca:default>
211       <ca:possvalues type="list" title="Values">
212         <ca:value></ca:value>
213       </ca:possvalues>
214       <ca:description></ca:description>
215     </ca:formelement>
216     <ca:formelement>
217       <ca:name>KEYMAP_NAV_ALLOW_RECTANGLE</ca:name>
218       <ca:type title="Type">
219         <ca:value>unknown</ca:value>
220         <ca:description></ca:description>
221       </ca:type>
222       <ca:default title="Default">
223         <ca:value></ca:value>
224         <ca:description></ca:description>
225       </ca:default>
226       <ca:possvalues type="list" title="Values">
227         <ca:value></ca:value>
228       </ca:possvalues>
229       <ca:description></ca:description>
230     </ca:formelement>
231   </ca:formelements>
232   <ca:jsvariables title="JavaScript Variables"/>
233   <ca:jsfunctions title="JavaScript Functions">
234     <ca:jsfunction>
235       <ca:name>CWCKeyMapDHTMLModeSet</ca:name>
236       <ca:scope title="Scope">
237         <ca:value>Private</ca:value>
238       </ca:scope>
239       <ca:description></ca:description>
240       <ca:parameters title="Parameters">
241         <ca:parameter>
242           <ca:name>oButton</ca:name>
243           <ca:type title="Type">
244             <ca:value>string</ca:value>
245           </ca:type>
246           <ca:default title="Default">
247             <ca:value></ca:value>
248             <ca:description></ca:description>
249           </ca:default>
250           <ca:possvalues type="list" title="Values">
251             <ca:value></ca:value>
252           </ca:possvalues>
253           <ca:description></ca:description>
254         </ca:parameter>
255         <ca:parameter>
256           <ca:name>xValues</ca:name>
257           <ca:type title="Type">
258             <ca:value>string</ca:value>
259           </ca:type>
260           <ca:default title="Default">
261             <ca:value></ca:value>
262             <ca:description></ca:description>
263           </ca:default>
264           <ca:possvalues type="list" title="Values">
265             <ca:value></ca:value>
266           </ca:possvalues>
267           <ca:description></ca:description>
268         </ca:parameter>
269       </ca:parameters>
270       <ca:returnvalues title="Function Return Value">
271         <ca:returnvalue>
272           <ca:type title="Type">
273             <ca:value>unknown</ca:value>
274             <ca:description></ca:description>
275           </ca:type>
276           <ca:default title="Default">
277             <ca:value></ca:value>
278           </ca:default>
279           <ca:possvalues type="list" title="Values">
280             <ca:value></ca:value>
281           </ca:possvalues>
282           <ca:description></ca:description>
283         </ca:returnvalue>
284       </ca:returnvalues>
285       <ca:triggeredjsapievents title="JSAPI Triggered Events">
286         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
287         <ca:triggeredjsapievent title="">
288           <ca:name></ca:name>
289           <ca:description></ca:description>
290         </ca:triggeredjsapievent>
291       </ca:triggeredjsapievents>
292     </ca:jsfunction>
293   </ca:jsfunctions>
294   <ca:jsfiles title="JavaScript Files">
295     <ca:jsfile>
296       <ca:name></ca:name>
297       <ca:description></ca:description>
298       <ca:jsvariables title="JavaScript Variables">
299         <ca:jsvariable>
300           <ca:name></ca:name>
301           <ca:type title="Type">
302             <ca:value>string</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></ca:value>
309           </ca:default>
310           <ca:possvalues type="list" title="Values">
311             <ca:value></ca:value>
312           </ca:possvalues>
313           <ca:description></ca:description>
314         </ca:jsvariable>
315       </ca:jsvariables>
316       <ca:jsfunctions title="JavaScript Functions">
317         <ca:jsfunction>
318           <ca:name></ca:name>
319           <ca:scope title="Scope">
320             <ca:value>Private</ca:value>
321           </ca:scope>
322           <ca:description></ca:description>
323           <ca:parameters title="Parameters">
324             <ca:parameter>
325               <ca:name></ca:name>
326               <ca:type title="Type">
327                 <ca:value>string</ca:value>
328               </ca:type>
329               <ca:required title="Required">
330                 <ca:value>false</ca:value>
331               </ca:required>
332               <ca:default title="Default">
333                 <ca:value></ca:value>
334                 <ca:description></ca:description>
335               </ca:default>
336               <ca:possvalues type="list" title="Values">
337                 <ca:value></ca:value>
338               </ca:possvalues>
339               <ca:description></ca:description>
340             </ca:parameter>
341           </ca:parameters>
342           <ca:returnvalues title="Function Return Value">
343             <ca:returnvalue>
344               <ca:type title="Type">
345                 <ca:value>unknown</ca:value>
346                 <ca:description></ca:description>
347               </ca:type>
348               <ca:default title="Default">
349                 <ca:value></ca:value>
350               </ca:default>
351               <ca:possvalues type="list" title="Values">
352                 <ca:value></ca:value>
353               </ca:possvalues>
354               <ca:description></ca:description>
355             </ca:returnvalue>
356           </ca:returnvalues>
357           <ca:triggeredjsapievents title="JSAPI Triggered Events">
358             <ca:triggeredjsapievent title="">
359               <ca:name></ca:name>
360               <ca:description></ca:description>
361             </ca:triggeredjsapievent>
362           </ca:triggeredjsapievents>
363         </ca:jsfunction>
364       </ca:jsfunctions>
365     </ca:jsfile>
366   </ca:jsfiles>
367   <ca:listenedjsapievents title="JSAPI Listened Events">
368     <ca:listenedjsapievent title="">
369       <ca:name></ca:name>
370       <ca:description></ca:description>
371       <ca:calledfunctions title="Functions Calls">
372         <ca:intro>JSAPI function calls for this widget are outlined here. </ca:intro>
373         <ca:calledfunction>
374           <ca:name></ca:name>
375           <ca:description></ca:description>
376         </ca:calledfunction>
377       </ca:calledfunctions>
378     </ca:listenedjsapievent>
379   </ca:listenedjsapievents>
380   <ca:widgetevents title="Widget Events">
381     <ca:widgetevent>
382       <ca:name></ca:name>
383       <ca:parameters title="Parameters">
384         <ca:parameter>
385           <ca:name></ca:name>
386           <ca:type title="Type">
387             <ca:value>string</ca:value>
388           </ca:type>
389           <ca:required title="Required">
390             <ca:value>false</ca:value>
391           </ca:required>
392           <ca:default title="Default">
393             <ca:value></ca:value>
394             <ca:description></ca:description>
395           </ca:default>
396           <ca:possvalues type="list" title="Values">
397             <ca:value></ca:value>
398           </ca:possvalues>
399           <ca:description></ca:description>
400         </ca:parameter>
401       </ca:parameters>
402       <ca:description></ca:description>
403     </ca:widgetevent>
404   </ca:widgetevents>
405   <ca:errors title="Widget Errors">
406     <ca:error title="Error #1">
407       <ca:type title="Type">
408         <ca:value>PHP Mapscript</ca:value>
409       </ca:type>
410       <ca:severity title="Severity">
411         <ca:value>none</ca:value>
412         <ca:description></ca:description>
413       </ca:severity>
414       <ca:message title="Error Message">
415         <ca:paras title="">
416           <ca:para>Error message string....</ca:para>
417         </ca:paras>
418       </ca:message>
419       <ca:meaning title="Interpretation">
420         <ca:paras title="">
421           <ca:para>The description of what the message means......</ca:para>
422         </ca:paras>
423       </ca:meaning>
424       <ca:solution title="Troubleshooting Tips">
425         <ca:paras title="">
426           <ca:para>Any possible solution that will help application developers troubleshoot and fix the problem.</ca:para>
427         </ca:paras>
428       </ca:solution>
429     </ca:error>
430   </ca:errors>
431 </ca:widgetdoc>
Note: See TracBrowser for help on using the browser.