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

Last change on this file since 290 was 290, checked in by smasson, 17 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 254 2007-06-26 15:58:20Z pinsard $
156    <h4>History</h4>
157
158   
159
160    <h3>Known issues</h3>
161   
162   
163   
164    <h4>Restrictions</h4>
165
166
167    <h3>Other attributes</h3>
168   
169   
170    <h4>Uses routines</h4>
171
172   
173   
174   
175
176    <font size="-3"><p>&nbsp;</p></font>
177    <hr size="1" color="#CCCCCC"/>
178     
179      <a name="#_cw_domain_get_value"></a>
180
181      <h2>cw_domain_get_value  <font size="-1" color="#006633">
182 Compound widget
183</font></h2>
184
185      <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>
186
187   
188
189
190    <h3>Return value</h3>
191
192
193   
194    <h3>Parameters</h3>
195   
196
197    <a name="#_cw_domain_get_value_keyword_id"></a>
198    <h4>id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
199     
200     
201     
202     
203     
204     
205     
206     
207    </h4>
208
209   
210
211   
212   
213
214   
215
216    <h3>Examples</h3><pre>
217
218    </pre><h3>Version history</h3>
219   
220    <h4>Version</h4>
221 $Id: cw_domain.pro 254 2007-06-26 15:58:20Z pinsard $
222    <h4>History</h4>
223
224   
225
226    <h3>Known issues</h3>
227   
228   
229   
230    <h4>Restrictions</h4>
231
232
233    <h3>Other attributes</h3>
234   
235   
236    <h4>Uses routines</h4>
237
238   
239   
240   
241
242    <font size="-3"><p>&nbsp;</p></font>
243    <hr size="1" color="#CCCCCC"/>
244     
245      <a name="#_cw_domain_event"></a>
246
247      <h2>cw_domain_event  <font size="-1" color="#006633">
248 Compound widget
249</font></h2>
250
251      <p><font face="Courier"><i>result = </i>cw_domain_event(<i><a href="#_cw_domain_event_keyword_event">event</a></i>)</font></p>
252
253   
254
255
256    <h3>Return value</h3>
257
258
259   
260    <h3>Parameters</h3>
261   
262
263    <a name="#_cw_domain_event_keyword_event"></a>
264    <h4>event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
265     
266     
267     
268     
269     
270     
271     
272     
273    </h4>
274
275   
276
277   
278   
279
280   
281
282    <h3>Examples</h3><pre>
283
284    </pre><h3>Version history</h3>
285   
286    <h4>Version</h4>
287 $Id: cw_domain.pro 254 2007-06-26 15:58:20Z pinsard $
288    <h4>History</h4>
289
290   
291
292    <h3>Known issues</h3>
293   
294   
295   
296    <h4>Restrictions</h4>
297
298
299    <h3>Other attributes</h3>
300   
301   
302    <h4>Uses routines</h4>
303
304   
305   
306   
307
308    <font size="-3"><p>&nbsp;</p></font>
309    <hr size="1" color="#CCCCCC"/>
310     
311      <a name="#_cw_domain"></a>
312
313      <h2>cw_domain  <font size="-1" color="#006633">
314 Compound widget
315</font></h2>
316
317      <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>
318
319   
320
321
322    <h3>Return value</h3>
323
324
325   
326    <h3>Parameters</h3>
327   
328
329    <a name="#_cw_domain_keyword_parent"></a>
330    <h4>parent&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
331      <font size="-1" color="#006633">in</font>
332     
333     
334      <font size="-1" color="#006633">required</font>
335     
336     
337     
338     
339    </h4>
340
341   
342 The widget ID of the parent widget.
343
344   
345   
346
347   
348    <h3>Keywords</h3>
349
350   
351    <a name="#_cw_domain_keyword_BOXZOOM"></a>
352    <h4>BOXZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
353     
354     
355     
356     
357     
358     
359     
360     
361    </h4>
362
363   
364 Vector indicating the geographic zone on which we want to cut the map.
365 If BOXZOOM has :
366   1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
367   2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
368   4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])]
369   5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
370   6 elements: The extraction is made on Boxzoom
371 Where lon1, lon2,lat1,lat2 are global variables defined at the last
372 <a href="../../..//ToBeReviewed/GRILLE/domdef.html">domdef</a>!
373
374   
375    <a name="#_cw_domain_keyword_STRICT"></a>
376    <h4>STRICT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
377     
378     
379     
380     
381     
382     
383     
384     
385    </h4>
386
387   
388
389   
390    <a name="#_cw_domain_keyword_UVALUE"></a>
391    <h4>UVALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
392     
393     
394     
395     
396     
397     
398     
399     
400    </h4>
401
402   
403 The user value to be associated with the widget.
404
405   
406    <a name="#_cw_domain_keyword_UNAME"></a>
407    <h4>UNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
408     
409     
410     
411     
412     
413     
414     
415     
416    </h4>
417
418   
419 The user name to be associated with the widget.
420
421   
422    <a name="#_cw_domain_keyword_UNZOOM"></a>
423    <h4>UNZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
424     
425     
426     
427     
428     
429     
430     
431     
432    </h4>
433
434   
435
436   
437    <a name="#_cw_domain_keyword__EXTRA"></a>
438    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
439     
440     
441     
442     
443     
444     
445     
446     
447    </h4>
448
449   
450 Used to pass keywords
451
452   
453   
454
455    <h3>Examples</h3><pre>
456
457    </pre><h3>Version history</h3>
458   
459    <h4>Version</h4>
460 $Id: cw_domain.pro 254 2007-06-26 15:58:20Z pinsard $
461
462    <h4>History</h4>
463
464   
465
466    <h3>Known issues</h3>
467   
468   
469    <h4>Todo items</h4>
470 seb: Documenter
471
472    <h4>Restrictions</h4>
473
474
475    <h3>Other attributes</h3>
476   
477   
478    <h4>Uses routines</h4>
479
480   
481   
482   
483
484    <font size="-3"><p>&nbsp;</p></font>
485    <hr size="1" color="#CCCCCC"/>
486     
487
488   
489
490    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
491
492  </body>
493</html>
Note: See TracBrowser for help on using the repository browser.