source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/WIDGET/COMPOUND_WIDGET/cw_domain.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation

File size: 8.7 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>cw_domain.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="cw_combobox_pm.html"><img src="./../../../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../../../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="cw_droplist_pm.html"><img src="./../../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/WIDGET/COMPOUND_WIDGET/</font></h1>
58    <h2>cw_domain.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64
65
66
67
68
69
70
71
72   
73    <h2>Routine summary</h2>
74
75    <dl>
76     
77      <dt><a href="#_cw_domain_set_value">cw_domain_set_value<i>, id, value</i></a><dt>
78      <dd><font size="-1"> </font></dd>
79     
80      <dt><a href="#_cw_domain_get_value"><i>result = </i>cw_domain_get_value(<i>id</i>)</a><dt>
81      <dd><font size="-1"> </font></dd>
82     
83      <dt><a href="#_cw_domain_event"><i>result = </i>cw_domain_event(<i>event</i>)</a><dt>
84      <dd><font size="-1"> </font></dd>
85     
86      <dt><a href="#_cw_domain"><i>result = </i>cw_domain(<i>parent</i>, BOXZOOM=<i>BOXZOOM</i>, STRICT=<i>STRICT</i>, UVALUE=<i>UVALUE</i>, UNAME=<i>UNAME</i>, UNZOOM=<i>UNZOOM</i>, _EXTRA=<i>_EXTRA</i>)</a><dt>
87      <dd><font size="-1"> </font></dd>
88     
89    </dl>
90
91    <p>&nbsp;</p>
92   
93
94     
95      <a name="#_cw_domain_set_value"></a>
96
97      <h2>cw_domain_set_value  <font size="-1" color="#006633">
98 Compound widget
99</font></h2>
100
101      <p><font face="Courier">cw_domain_set_value<i>, <a href="#_cw_domain_set_value_keyword_id">id</a>, <a href="#_cw_domain_set_value_keyword_value">value</a></i></font></p>
102
103   
104
105
106    <h3>Return value</h3>
107
108
109   
110    <h3>Parameters</h3>
111   
112
113    <a name="#_cw_domain_set_value_keyword_id"></a>
114    <h4>id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
115     
116     
117     
118     
119     
120     
121     
122     
123    </h4>
124
125   
126
127
128   
129
130    <a name="#_cw_domain_set_value_keyword_value"></a>
131    <h4>value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
132     
133     
134     
135     
136     
137     
138     
139     
140    </h4>
141
142   
143 It is the default tick mark value (a floating-point number).
144
145   
146   
147
148   
149
150    <h3>Examples</h3><pre>
151
152    </pre><h3>Version history</h3>
153   
154    <h4>Version</h4>
155 $Id: cw_domain.pro 327 2007-12-13 16:22:35Z pinsard $
156
157    <h4>History</h4>
158
159   
160
161    <h3>Known issues</h3>
162   
163   
164   
165    <h4>Restrictions</h4>
166
167
168    <h3>Other attributes</h3>
169   
170   
171    <h4>Uses routines</h4>
172
173   
174   
175   
176
177    <font size="-3"><p>&nbsp;</p></font>
178    <hr size="1" color="#CCCCCC"/>
179     
180      <a name="#_cw_domain_get_value"></a>
181
182      <h2>cw_domain_get_value  <font size="-1" color="#006633">
183 Compound widget
184</font></h2>
185
186      <p><font face="Courier"><i>result = </i>cw_domain_get_value(<i><a href="#_cw_domain_get_value_keyword_id">id</a></i>)</font></p>
187
188   
189
190
191    <h3>Return value</h3>
192
193
194   
195    <h3>Parameters</h3>
196   
197
198    <a name="#_cw_domain_get_value_keyword_id"></a>
199    <h4>id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
200     
201     
202     
203     
204     
205     
206     
207     
208    </h4>
209
210   
211
212   
213   
214
215   
216
217    <h3>Examples</h3><pre>
218
219    </pre><h3>Version history</h3>
220   
221    <h4>Version</h4>
222 $Id: cw_domain.pro 327 2007-12-13 16:22:35Z pinsard $
223
224    <h4>History</h4>
225
226   
227
228    <h3>Known issues</h3>
229   
230   
231   
232    <h4>Restrictions</h4>
233
234
235    <h3>Other attributes</h3>
236   
237   
238    <h4>Uses routines</h4>
239
240   
241   
242   
243
244    <font size="-3"><p>&nbsp;</p></font>
245    <hr size="1" color="#CCCCCC"/>
246     
247      <a name="#_cw_domain_event"></a>
248
249      <h2>cw_domain_event  <font size="-1" color="#006633">
250 Compound widget
251</font></h2>
252
253      <p><font face="Courier"><i>result = </i>cw_domain_event(<i><a href="#_cw_domain_event_keyword_event">event</a></i>)</font></p>
254
255   
256
257
258    <h3>Return value</h3>
259
260
261   
262    <h3>Parameters</h3>
263   
264
265    <a name="#_cw_domain_event_keyword_event"></a>
266    <h4>event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
267     
268     
269     
270     
271     
272     
273     
274     
275    </h4>
276
277   
278
279   
280   
281
282   
283
284    <h3>Examples</h3><pre>
285
286    </pre><h3>Version history</h3>
287   
288    <h4>Version</h4>
289 $Id: cw_domain.pro 327 2007-12-13 16:22:35Z pinsard $
290
291    <h4>History</h4>
292
293   
294
295    <h3>Known issues</h3>
296   
297   
298   
299    <h4>Restrictions</h4>
300
301
302    <h3>Other attributes</h3>
303   
304   
305    <h4>Uses routines</h4>
306
307   
308   
309   
310
311    <font size="-3"><p>&nbsp;</p></font>
312    <hr size="1" color="#CCCCCC"/>
313     
314      <a name="#_cw_domain"></a>
315
316      <h2>cw_domain  <font size="-1" color="#006633">
317 Compound widget
318</font></h2>
319
320      <p><font face="Courier"><i>result = </i>cw_domain(<i><a href="#_cw_domain_keyword_parent">parent</a></i>, <a href="#_cw_domain_keyword_BOXZOOM">BOXZOOM</a>=<i>BOXZOOM</i>, <a href="#_cw_domain_keyword_STRICT">STRICT</a>=<i>STRICT</i>, <a href="#_cw_domain_keyword_UVALUE">UVALUE</a>=<i>UVALUE</i>, <a href="#_cw_domain_keyword_UNAME">UNAME</a>=<i>UNAME</i>, <a href="#_cw_domain_keyword_UNZOOM">UNZOOM</a>=<i>UNZOOM</i>, <a href="#_cw_domain_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
321
322   
323
324
325    <h3>Return value</h3>
326
327
328   
329    <h3>Parameters</h3>
330   
331
332    <a name="#_cw_domain_keyword_parent"></a>
333    <h4>parent&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
334      <font size="-1" color="#006633">in</font>
335     
336     
337      <font size="-1" color="#006633">required</font>
338     
339     
340     
341     
342    </h4>
343
344   
345 The widget ID of the parent widget.
346
347   
348   
349
350   
351    <h3>Keywords</h3>
352
353   
354    <a name="#_cw_domain_keyword_BOXZOOM"></a>
355    <h4>BOXZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
356     
357     
358     
359     
360     
361     
362     
363     
364    </h4>
365
366   
367 Vector indicating the geographic zone on which we want to cut the map.
368 If BOXZOOM has :
369   1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
370   2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
371   4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])]
372   5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
373   6 elements: The extraction is made on Boxzoom
374 Where lon1, lon2,lat1,lat2 are global variables defined at the last
375 <a href="../../..//ToBeReviewed/GRILLE/domdef.html">domdef</a>!
376
377   
378    <a name="#_cw_domain_keyword_STRICT"></a>
379    <h4>STRICT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
380     
381     
382     
383     
384     
385     
386     
387     
388    </h4>
389
390   
391
392   
393    <a name="#_cw_domain_keyword_UVALUE"></a>
394    <h4>UVALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
395     
396     
397     
398     
399     
400     
401     
402     
403    </h4>
404
405   
406 The user value to be associated with the widget.
407
408   
409    <a name="#_cw_domain_keyword_UNAME"></a>
410    <h4>UNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
411     
412     
413     
414     
415     
416     
417     
418     
419    </h4>
420
421   
422 The user name to be associated with the widget.
423
424   
425    <a name="#_cw_domain_keyword_UNZOOM"></a>
426    <h4>UNZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
427     
428     
429     
430     
431     
432     
433     
434     
435    </h4>
436
437   
438
439   
440    <a name="#_cw_domain_keyword__EXTRA"></a>
441    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
442     
443     
444     
445     
446     
447     
448     
449     
450    </h4>
451
452   
453 Used to pass keywords
454
455   
456   
457
458    <h3>Examples</h3><pre>
459
460    </pre><h3>Version history</h3>
461   
462    <h4>Version</h4>
463 $Id: cw_domain.pro 327 2007-12-13 16:22:35Z pinsard $
464
465    <h4>History</h4>
466
467   
468
469    <h3>Known issues</h3>
470   
471   
472    <h4>Todo items</h4>
473 seb: Documenter
474
475    <h4>Restrictions</h4>
476
477
478    <h3>Other attributes</h3>
479   
480   
481    <h4>Uses routines</h4>
482
483   
484   
485   
486
487    <font size="-3"><p>&nbsp;</p></font>
488    <hr size="1" color="#CCCCCC"/>
489     
490
491   
492
493    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
494
495  </body>
496</html>
Note: See TracBrowser for help on using the repository browser.