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

Last change on this file since 338 was 338, checked in by smasson, 16 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 327 2007-12-13 16:22:35Z pinsard $
184</div>
185          <h4>History</h4><div class="preformat">
186</div>
187         
188         
189          <h3>Known issues</h3>
190         
191         
192         
193          <h4>Restrictions</h4><div class="preformat">
194</div>
195       
196          <h3>Other attributes</h3>
197         
198         
199          <h4>Uses routines</h4><div class="preformat">
200</div>
201         
202         
203         
204       
205          <h3>Statistics</h3>
206          <table class="statistics">
207            <tr><td>McCabe cyclic</td><td>           4</td></tr>
208            <tr><td>McCabe essential</td><td>           1</td></tr>
209            <tr><td>McCabe modular design</td><td>           1</td></tr>
210          </table>
211         
212       
213        </div>
214       
215
216        <div class="routine_details" id="_cw_slide_slice_event">
217
218          <h2><a class="top" href="#container">top</a>cw_slide_slice_event <span class="categories">
219 Compound widget
220</span></h2>
221       
222          <p class="header">
223            <span class="result">result = </span>cw_slide_slice_event(<span class="result"><a href="#_cw_slide_slice_event_param_event">event</a></span>)</p>
224       
225          <div class="comments">
226</div>
227
228          <h3>Return value</h3><div class="preformat">
229</div>
230
231         
232            <h3>Parameters</h3>
233       
234           
235            <h4 id="_cw_slide_slice_event_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
236             
237             
238             
239             
240             
241             
242             
243             
244            </h4>
245       
246          <div class="comments">
247</div>
248           
249
250         
251
252         
253
254          <h3>Examples</h3><div class="preformat">
255</div>
256          <h3>Version history</h3>
257         
258          <h4>Version</h4><div class="preformat">
259 $Id: cw_slide_slice.pro 327 2007-12-13 16:22:35Z pinsard $
260</div>
261          <h4>History</h4><div class="preformat">
262</div>
263         
264         
265          <h3>Known issues</h3>
266         
267         
268         
269          <h4>Restrictions</h4><div class="preformat">
270</div>
271       
272          <h3>Other attributes</h3>
273         
274         
275          <h4>Uses routines</h4><div class="preformat">
276</div>
277         
278         
279         
280       
281          <h3>Statistics</h3>
282          <table class="statistics">
283            <tr><td>McCabe cyclic</td><td>           6</td></tr>
284            <tr><td>McCabe essential</td><td>           1</td></tr>
285            <tr><td>McCabe modular design</td><td>           1</td></tr>
286          </table>
287         
288       
289        </div>
290       
291
292        <div class="routine_details" id="_cw_slide_slice">
293
294          <h2><a class="top" href="#container">top</a>cw_slide_slice <span class="categories">
295 Compound widget
296</span></h2>
297       
298          <p class="header">
299            <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>
300       
301          <div class="comments">
302</div>
303
304          <h3>Return value</h3><div class="preformat">
305</div>
306
307         
308            <h3>Parameters</h3>
309       
310           
311            <h4 id="_cw_slide_slice_param_parent">parent&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
312              <span class="attr">in</span>
313             
314             
315              <span class="attr">required</span>
316             
317             
318             
319             
320            </h4>
321       
322          <div class="comments">
323 The widget ID of the parent widget.
324</div>
325           
326
327         
328
329         
330
331            <h3>Keywords</h3>
332           
333            <h4 id="_cw_slide_slice_keyword_BOXZOOM">BOXZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
334             
335             
336             
337             
338             
339             
340             
341             
342            </h4>
343       
344            <div class="comments">
345 Vector indicating the geographic zone on which we want to cut the map.
346 If BOXZOOM has :
347   1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
348   2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
349   4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])]
350   5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
351   6 elements: The extraction is made on Boxzoom
352 Where lon1, lon2,lat1,lat2 are global variables defined at the last
353 <a href="../../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> !
354</div>
355           
356            <h4 id="_cw_slide_slice_keyword_UVALUE">UVALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
357             
358             
359             
360             
361             
362             
363             
364             
365            </h4>
366       
367            <div class="comments">
368 The user value to be associated with the widget.
369</div>
370           
371            <h4 id="_cw_slide_slice_keyword_UNAME">UNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
372             
373             
374             
375             
376             
377             
378             
379             
380            </h4>
381       
382            <div class="comments">
383 The user name to be associated with the widget.
384</div>
385           
386            <h4 id="_cw_slide_slice_keyword_FRAME">FRAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
387             
388             
389             
390             
391             
392             
393             
394             
395            </h4>
396       
397            <div class="comments">
398 Specifies the width of the frame to be drawn around the base.
399</div>
400           
401            <h4 id="_cw_slide_slice_keyword_ROW">ROW&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
402             
403             
404             
405             
406             
407             
408             
409             
410            </h4>
411       
412            <div class="comments">
413 Buttons will be arranged in the number of rows
414 specified by this keyword.
415</div>
416           
417            <h4 id="_cw_slide_slice_keyword_COLUMN">COLUMN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
418             
419             
420             
421             
422             
423             
424             
425             
426            </h4>
427       
428            <div class="comments">
429 Buttons will be arranged in the number of columns
430 specified by this keyword.
431</div>
432           
433            <h4 id="_cw_slide_slice_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
434             
435             
436             
437             
438             
439             
440             
441             
442            </h4>
443       
444            <div class="comments">
445 Used to pass keywords
446</div>
447           
448         
449
450          <h3>Examples</h3><div class="preformat">
451</div>
452          <h3>Version history</h3>
453         
454          <h4>Version</h4><div class="preformat">
455 $Id: cw_slide_slice.pro 327 2007-12-13 16:22:35Z pinsard $
456</div>
457          <h4>History</h4><div class="preformat">
458</div>
459         
460         
461          <h3>Known issues</h3>
462         
463         
464          <h4>Todo items</h4><div class="preformat">
465 seb: documenter
466</div>
467          <h4>Restrictions</h4><div class="preformat">
468</div>
469       
470          <h3>Other attributes</h3>
471         
472         
473          <h4>Uses routines</h4><div class="preformat">
474</div>
475         
476         
477         
478       
479          <h3>Statistics</h3>
480          <table class="statistics">
481            <tr><td>McCabe cyclic</td><td>           8</td></tr>
482            <tr><td>McCabe essential</td><td>           1</td></tr>
483            <tr><td>McCabe modular design</td><td>           1</td></tr>
484          </table>
485         
486       
487        </div>
488       
489      </div>
490
491     
492
493      <div id="tagline">Produced by IDLdoc 2.0.</div>
494
495    </div>
496
497  </body>
498</html>
Note: See TracBrowser for help on using the repository browser.