source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/WIDGET/COMPOUND_WIDGET/cw_slide_slice.html @ 290

Last change on this file since 290 was 290, checked in by smasson, 17 years ago

update documentation
File size: 11.0 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>cw_slide_slice.pro (SAXO Documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../../../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../../../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="cw_slide_slice.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../../../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../../../ToBeReviewed/WIDGET/COMPOUND_WIDGET//cw_slide_slice.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../../../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="cw_pagelayout.html">&lt;&lt;prev file</a> | <a href="cw_slider_pm.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="cw_slide_slice.html" target="_TOP">view single page</a> | <a href="./../../../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | <a href="#routine_summary">routine</a>&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/WIDGET/COMPOUND_WIDGET/</a></h1>
82      <h2 class="pro_file">cw_slide_slice.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90
91
92
93
94
95</div>
96
97     
98
99     
100
101     
102
103     
104      <div id="routine_summary">               
105        <h2>Routine summary</h2>
106       
107        <dl>
108         
109          <dt><p><a href="#_cw_slide_slice_set_value">cw_slide_slice_set_value<span class="result">, id, value</span></a></p><dt>
110          <dd> </dd>   
111         
112          <dt><p><a href="#_cw_slide_slice_event"><span class="result">result = </span>cw_slide_slice_event(<span class="result">event</span>)</a></p><dt>
113          <dd> </dd>   
114         
115          <dt><p><a href="#_cw_slide_slice"><span class="result">result = </span>cw_slide_slice(<span class="result">parent</span>, BOXZOOM=<span class="result">BOXZOOM</span>, UVALUE=<span class="result">UVALUE</span>, UNAME=<span class="result">UNAME</span>, FRAME=<span class="result">FRAME</span>, ROW=<span class="result">ROW</span>, COLUMN=<span class="result">COLUMN</span>, _EXTRA=<span class="result">_EXTRA</span>)</a></p><dt>
116          <dd> </dd>   
117               
118        </dl>
119      </div>
120     
121
122      <div id="routine_details">
123       
124
125        <div class="routine_details" id="_cw_slide_slice_set_value">
126
127          <h2><a class="top" href="#container">top</a>cw_slide_slice_set_value <span class="categories">
128 Compound widget
129</span></h2>
130       
131          <p class="header">
132            cw_slide_slice_set_value<span class="result">, <a href="#_cw_slide_slice_set_value_param_id">id</a>, <a href="#_cw_slide_slice_set_value_param_value">value</a></span></p>
133       
134          <div class="comments">
135</div>
136
137          <h3>Return value</h3><div class="preformat">
138</div>
139
140         
141            <h3>Parameters</h3>
142       
143           
144            <h4 id="_cw_slide_slice_set_value_param_id">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
145             
146             
147             
148             
149             
150             
151             
152             
153            </h4>
154       
155          <div class="comments">
156</div>
157           
158            <h4 id="_cw_slide_slice_set_value_param_value">value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
159             
160             
161             
162             
163             
164             
165             
166             
167            </h4>
168       
169          <div class="comments">
170 It is the default tick mark value (a floating-point number).
171</div>
172           
173
174         
175
176         
177
178          <h3>Examples</h3><div class="preformat">
179</div>
180          <h3>Version history</h3>
181         
182          <h4>Version</h4><div class="preformat">
183 $Id: cw_slide_slice.pro 262 2007-08-21 14:19:32Z pinsard $</div>
184          <h4>History</h4><div class="preformat">
185</div>
186         
187         
188          <h3>Known issues</h3>
189         
190         
191         
192          <h4>Restrictions</h4><div class="preformat">
193</div>
194       
195          <h3>Other attributes</h3>
196         
197         
198          <h4>Uses routines</h4><div class="preformat">
199</div>
200         
201         
202         
203       
204          <h3>Statistics</h3>
205          <table class="statistics">
206            <tr><td>McCabe cyclic</td><td>           4</td></tr>
207            <tr><td>McCabe essential</td><td>           1</td></tr>
208            <tr><td>McCabe modular design</td><td>           1</td></tr>
209          </table>
210         
211       
212        </div>
213       
214
215        <div class="routine_details" id="_cw_slide_slice_event">
216
217          <h2><a class="top" href="#container">top</a>cw_slide_slice_event <span class="categories">
218 Compound widget
219</span></h2>
220       
221          <p class="header">
222            <span class="result">result = </span>cw_slide_slice_event(<span class="result"><a href="#_cw_slide_slice_event_param_event">event</a></span>)</p>
223       
224          <div class="comments">
225</div>
226
227          <h3>Return value</h3><div class="preformat">
228</div>
229
230         
231            <h3>Parameters</h3>
232       
233           
234            <h4 id="_cw_slide_slice_event_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
235             
236             
237             
238             
239             
240             
241             
242             
243            </h4>
244       
245          <div class="comments">
246</div>
247           
248
249         
250
251         
252
253          <h3>Examples</h3><div class="preformat">
254</div>
255          <h3>Version history</h3>
256         
257          <h4>Version</h4><div class="preformat">
258 $Id: cw_slide_slice.pro 262 2007-08-21 14:19:32Z pinsard $</div>
259          <h4>History</h4><div class="preformat">
260</div>
261         
262         
263          <h3>Known issues</h3>
264         
265         
266         
267          <h4>Restrictions</h4><div class="preformat">
268</div>
269       
270          <h3>Other attributes</h3>
271         
272         
273          <h4>Uses routines</h4><div class="preformat">
274</div>
275         
276         
277         
278       
279          <h3>Statistics</h3>
280          <table class="statistics">
281            <tr><td>McCabe cyclic</td><td>           6</td></tr>
282            <tr><td>McCabe essential</td><td>           1</td></tr>
283            <tr><td>McCabe modular design</td><td>           1</td></tr>
284          </table>
285         
286       
287        </div>
288       
289
290        <div class="routine_details" id="_cw_slide_slice">
291
292          <h2><a class="top" href="#container">top</a>cw_slide_slice <span class="categories">
293 Compound widget
294</span></h2>
295       
296          <p class="header">
297            <span class="result">result = </span>cw_slide_slice(<span class="result"><a href="#_cw_slide_slice_param_parent">parent</a></span>, <a href="#_cw_slide_slice_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_cw_slide_slice_keyword_UVALUE">UVALUE</a>=<span class="result">UVALUE</span>, <a href="#_cw_slide_slice_keyword_UNAME">UNAME</a>=<span class="result">UNAME</span>, <a href="#_cw_slide_slice_keyword_FRAME">FRAME</a>=<span class="result">FRAME</span>, <a href="#_cw_slide_slice_keyword_ROW">ROW</a>=<span class="result">ROW</span>, <a href="#_cw_slide_slice_keyword_COLUMN">COLUMN</a>=<span class="result">COLUMN</span>, <a href="#_cw_slide_slice_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
298       
299          <div class="comments">
300</div>
301
302          <h3>Return value</h3><div class="preformat">
303</div>
304
305         
306            <h3>Parameters</h3>
307       
308           
309            <h4 id="_cw_slide_slice_param_parent">parent&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
310              <span class="attr">in</span>
311             
312             
313              <span class="attr">required</span>
314             
315             
316             
317             
318            </h4>
319       
320          <div class="comments">
321 The widget ID of the parent widget.
322</div>
323           
324
325         
326
327         
328
329            <h3>Keywords</h3>
330           
331            <h4 id="_cw_slide_slice_keyword_BOXZOOM">BOXZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
332             
333             
334             
335             
336             
337             
338             
339             
340            </h4>
341       
342            <div class="comments">
343 Vector indicating the geographic zone on which we want to cut the map.
344 If BOXZOOM has :
345   1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
346   2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
347   4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])]
348   5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
349   6 elements: The extraction is made on Boxzoom
350 Where lon1, lon2,lat1,lat2 are global variables defined at the last
351 <a href="../../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> !
352</div>
353           
354            <h4 id="_cw_slide_slice_keyword_UVALUE">UVALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
355             
356             
357             
358             
359             
360             
361             
362             
363            </h4>
364       
365            <div class="comments">
366 The user value to be associated with the widget.
367</div>
368           
369            <h4 id="_cw_slide_slice_keyword_UNAME">UNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
370             
371             
372             
373             
374             
375             
376             
377             
378            </h4>
379       
380            <div class="comments">
381 The user name to be associated with the widget.
382</div>
383           
384            <h4 id="_cw_slide_slice_keyword_FRAME">FRAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
385             
386             
387             
388             
389             
390             
391             
392             
393            </h4>
394       
395            <div class="comments">
396 Specifies the width of the frame to be drawn around the base.
397</div>
398           
399            <h4 id="_cw_slide_slice_keyword_ROW">ROW&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
400             
401             
402             
403             
404             
405             
406             
407             
408            </h4>
409       
410            <div class="comments">
411 Buttons will be arranged in the number of rows
412 specified by this keyword.
413</div>
414           
415            <h4 id="_cw_slide_slice_keyword_COLUMN">COLUMN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
416             
417             
418             
419             
420             
421             
422             
423             
424            </h4>
425       
426            <div class="comments">
427 Buttons will be arranged in the number of columns
428 specified by this keyword.
429</div>
430           
431            <h4 id="_cw_slide_slice_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
432             
433             
434             
435             
436             
437             
438             
439             
440            </h4>
441       
442            <div class="comments">
443 Used to pass keywords
444</div>
445           
446         
447
448          <h3>Examples</h3><div class="preformat">
449</div>
450          <h3>Version history</h3>
451         
452          <h4>Version</h4><div class="preformat">
453 $Id: cw_slide_slice.pro 262 2007-08-21 14:19:32Z pinsard $
454</div>
455          <h4>History</h4><div class="preformat">
456</div>
457         
458         
459          <h3>Known issues</h3>
460         
461         
462          <h4>Todo items</h4><div class="preformat">
463 seb: documenter
464</div>
465          <h4>Restrictions</h4><div class="preformat">
466</div>
467       
468          <h3>Other attributes</h3>
469         
470         
471          <h4>Uses routines</h4><div class="preformat">
472</div>
473         
474         
475         
476       
477          <h3>Statistics</h3>
478          <table class="statistics">
479            <tr><td>McCabe cyclic</td><td>           8</td></tr>
480            <tr><td>McCabe essential</td><td>           1</td></tr>
481            <tr><td>McCabe modular design</td><td>           1</td></tr>
482          </table>
483         
484       
485        </div>
486       
487      </div>
488
489     
490
491      <div id="tagline">Produced by IDLdoc 2.0.</div>
492
493    </div>
494
495  </body>
496</html>
Note: See TracBrowser for help on using the repository browser.