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

Last change on this file since 163 was 163, checked in by navarro, 18 years ago

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)

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
74
75
76   
77    <h2>Routine summary</h2>
78
79    <dl>
80     
81      <dt><a href="#_cw_domain_set_value">cw_domain_set_value<i>, id, value</i></a><dt>
82      <dd><font size="-1"></font></dd>
83     
84      <dt><a href="#_cw_domain_get_value"><i>result = </i>cw_domain_get_value(<i>id</i>)</a><dt>
85      <dd><font size="-1"></font></dd>
86     
87      <dt><a href="#_cw_domain_event"><i>result = </i>cw_domain_event(<i>event</i>)</a><dt>
88      <dd><font size="-1"></font></dd>
89     
90      <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>
91      <dd><font size="-1"></font></dd>
92     
93    </dl>
94
95    <p>&nbsp;</p>
96   
97
98     
99      <a name="#_cw_domain_set_value"></a>
100
101      <h2>cw_domain_set_value  <font size="-1" color="#006633">
102 Compound widget
103 </font></h2>
104
105      <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>
106
107   
108
109    <h3>Return value</h3>
110 
111 
112
113   
114    <h3>Parameters</h3>
115   
116
117    <a name="#_cw_domain_set_value_keyword_id"></a>
118    <h4>id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
119     
120     
121     
122     
123     
124     
125     
126     
127    </h4>
128
129   
130
131
132   
133
134    <a name="#_cw_domain_set_value_keyword_value"></a>
135    <h4>value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
136     
137     
138     
139     
140     
141     
142     
143     
144    </h4>
145
146   
147 It is the default tick mark value (a floating-point number).
148
149   
150   
151
152   
153
154    <h3>Examples</h3>
155 
156 
157    <h3>Version history</h3>
158   
159    <h4>Version</h4> 
160 $Id: cw_domain.pro 157 2006-08-21 09:01:50Z navarro $
161    <h4>History</h4>
162 
163 
164   
165
166    <h3>Known issues</h3>
167   
168   
169   
170    <h4>Restrictions</h4>
171 
172 
173
174    <h3>Other attributes</h3>
175   
176   
177    <h4>Uses routines</h4>
178 
179 
180   
181   
182   
183
184    <font size="-3"><p>&nbsp;</p></font>
185    <hr size="1" color="#CCCCCC"/>
186     
187      <a name="#_cw_domain_get_value"></a>
188
189      <h2>cw_domain_get_value  <font size="-1" color="#006633">
190 Compound widget
191 </font></h2>
192
193      <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>
194
195   
196
197    <h3>Return value</h3>
198 
199 
200
201   
202    <h3>Parameters</h3>
203   
204
205    <a name="#_cw_domain_get_value_keyword_id"></a>
206    <h4>id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
207     
208     
209     
210     
211     
212     
213     
214     
215    </h4>
216
217   
218
219
220   
221   
222
223   
224
225    <h3>Examples</h3>
226 
227 
228    <h3>Version history</h3>
229   
230    <h4>Version</h4> 
231 $Id: cw_domain.pro 157 2006-08-21 09:01:50Z navarro $
232    <h4>History</h4>
233 
234 
235   
236
237    <h3>Known issues</h3>
238   
239   
240   
241    <h4>Restrictions</h4>
242 
243 
244
245    <h3>Other attributes</h3>
246   
247   
248    <h4>Uses routines</h4>
249 
250 
251   
252   
253   
254
255    <font size="-3"><p>&nbsp;</p></font>
256    <hr size="1" color="#CCCCCC"/>
257     
258      <a name="#_cw_domain_event"></a>
259
260      <h2>cw_domain_event  <font size="-1" color="#006633">
261 Compound widget
262 </font></h2>
263
264      <p><font face="Courier"><i>result = </i>cw_domain_event(<i><a href="#_cw_domain_event_keyword_event">event</a></i>)</font></p>
265
266   
267
268    <h3>Return value</h3>
269 
270 
271
272   
273    <h3>Parameters</h3>
274   
275
276    <a name="#_cw_domain_event_keyword_event"></a>
277    <h4>event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
278     
279     
280     
281     
282     
283     
284     
285     
286    </h4>
287
288   
289
290
291   
292   
293
294   
295
296    <h3>Examples</h3>
297 
298 
299    <h3>Version history</h3>
300   
301    <h4>Version</h4> 
302 $Id: cw_domain.pro 157 2006-08-21 09:01:50Z navarro $
303    <h4>History</h4>
304 
305 
306   
307
308    <h3>Known issues</h3>
309   
310   
311   
312    <h4>Restrictions</h4>
313 
314 
315
316    <h3>Other attributes</h3>
317   
318   
319    <h4>Uses routines</h4>
320 
321 
322   
323   
324   
325
326    <font size="-3"><p>&nbsp;</p></font>
327    <hr size="1" color="#CCCCCC"/>
328     
329      <a name="#_cw_domain"></a>
330
331      <h2>cw_domain  <font size="-1" color="#006633">
332 Compound widget
333 </font></h2>
334
335      <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>
336
337   
338
339    <h3>Return value</h3>
340 
341 
342
343   
344    <h3>Parameters</h3>
345   
346
347    <a name="#_cw_domain_keyword_parent"></a>
348    <h4>parent&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
349      <font size="-1" color="#006633">in</font>
350     
351     
352      <font size="-1" color="#006633">required</font>
353     
354     
355     
356     
357    </h4>
358
359   
360 The widget ID of the parent widget.
361 
362   
363   
364
365   
366    <h3>Keywords</h3>
367
368   
369    <a name="#_cw_domain_keyword_BOXZOOM"></a>
370    <h4>BOXZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
371     
372     
373     
374     
375     
376     
377     
378     
379    </h4>
380
381   
382 Vector indicating the geographic zone on which we want to cut the map.
383 If BOXZOOM has :
384   1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
385   2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
386   4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])]
387   5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
388   6 elements: The extraction is made on Boxzoom
389 Where lon1, lon2,lat1,lat2 are global variables defined at the last domdef!
390
391   
392    <a name="#_cw_domain_keyword_STRICT"></a>
393    <h4>STRICT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
394     
395     
396     
397     
398     
399     
400     
401     
402    </h4>
403
404   
405
406
407   
408    <a name="#_cw_domain_keyword_UVALUE"></a>
409    <h4>UVALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
410     
411     
412     
413     
414     
415     
416     
417     
418    </h4>
419
420   
421 The user value to be associated with the widget.
422 
423   
424    <a name="#_cw_domain_keyword_UNAME"></a>
425    <h4>UNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
426     
427     
428     
429     
430     
431     
432     
433     
434    </h4>
435
436   
437 The user name to be associated with the widget.
438 
439   
440    <a name="#_cw_domain_keyword_UNZOOM"></a>
441    <h4>UNZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
442     
443     
444     
445     
446     
447     
448     
449     
450    </h4>
451
452   
453
454
455   
456    <a name="#_cw_domain_keyword__extra"></a>
457    <h4>_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
458     
459     
460     
461     
462     
463     
464     
465     
466    </h4>
467
468   
469 Used to pass your keywords
470 
471   
472   
473
474    <h3>Examples</h3>
475 
476 
477    <h3>Version history</h3>
478   
479    <h4>Version</h4> 
480 $Id: cw_domain.pro 157 2006-08-21 09:01:50Z navarro $
481
482    <h4>History</h4>
483 
484 
485   
486
487    <h3>Known issues</h3>
488   
489   
490    <h4>Todo items</h4>
491 seb: Documenter
492 
493    <h4>Restrictions</h4>
494 
495 
496
497    <h3>Other attributes</h3>
498   
499   
500    <h4>Uses routines</h4>
501 
502 
503   
504   
505   
506
507    <font size="-3"><p>&nbsp;</p></font>
508    <hr size="1" color="#CCCCCC"/>
509     
510
511   
512
513    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Tue Aug 29 14:50:49 2006.</font></p>
514
515  </body>
516</html>
Note: See TracBrowser for help on using the repository browser.