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

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

update documentation
File size: 11.8 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_specifie.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_specifie.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_specifie.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_slider_pm.html">&lt;&lt;prev file</a> | next file &gt;&gt;&nbsp;&nbsp;&nbsp;&nbsp;<a href="cw_specifie.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_specifie.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
96</div>
97
98     
99
100     
101
102     
103
104     
105      <div id="routine_summary">               
106        <h2>Routine summary</h2>
107       
108        <dl>
109         
110          <dt><p><a href="#_cw_specifie_set_value">cw_specifie_set_value<span class="result">, id, value</span></a></p><dt>
111          <dd> </dd>   
112         
113          <dt><p><a href="#_cw_specifie_get_value"><span class="result">result = </span>cw_specifie_get_value(<span class="result">id</span>)</a></p><dt>
114          <dd> </dd>   
115         
116          <dt><p><a href="#_cw_specifie_event"><span class="result">result = </span>cw_specifie_event(<span class="result">event</span>)</a></p><dt>
117          <dd> </dd>   
118         
119          <dt><p><a href="#_cw_specifie"><span class="result">result = </span>cw_specifie(<span class="result">parent</span>, ROW=<span class="result">ROW</span>, COLUMN=<span class="result">COLUMN</span>, UVALUE=<span class="result">UVALUE</span>, UNAME=<span class="result">UNAME</span>, FRAME=<span class="result">FRAME</span>, FORXXX=<span class="result">FORXXX</span>, _EXTRA=<span class="result">_EXTRA</span>)</a></p><dt>
120          <dd> </dd>   
121               
122        </dl>
123      </div>
124     
125
126      <div id="routine_details">
127       
128
129        <div class="routine_details" id="_cw_specifie_set_value">
130
131          <h2><a class="top" href="#container">top</a>cw_specifie_set_value <span class="categories">
132 Compound widget
133</span></h2>
134       
135          <p class="header">
136            cw_specifie_set_value<span class="result">, <a href="#_cw_specifie_set_value_param_id">id</a>, <a href="#_cw_specifie_set_value_param_value">value</a></span></p>
137       
138          <div class="comments">
139</div>
140
141          <h3>Return value</h3><div class="preformat">
142</div>
143
144         
145            <h3>Parameters</h3>
146       
147           
148            <h4 id="_cw_specifie_set_value_param_id">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
149             
150             
151             
152             
153             
154             
155             
156             
157            </h4>
158       
159          <div class="comments">
160</div>
161           
162            <h4 id="_cw_specifie_set_value_param_value">value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
163             
164             
165             
166             
167             
168             
169             
170             
171            </h4>
172       
173          <div class="comments">
174 It is the default tick mark value (a floating-point number).
175</div>
176           
177
178         
179
180         
181
182          <h3>Examples</h3><div class="preformat">
183</div>
184          <h3>Version history</h3>
185         
186          <h4>Version</h4><div class="preformat">
187 $Id: cw_specifie.pro 327 2007-12-13 16:22:35Z pinsard $
188</div>
189          <h4>History</h4><div class="preformat">
190</div>
191         
192         
193          <h3>Known issues</h3>
194         
195         
196         
197          <h4>Restrictions</h4><div class="preformat">
198</div>
199       
200          <h3>Other attributes</h3>
201         
202         
203          <h4>Uses routines</h4><div class="preformat">
204</div>
205         
206         
207         
208       
209          <h3>Statistics</h3>
210          <table class="statistics">
211            <tr><td>McCabe cyclic</td><td>           4</td></tr>
212            <tr><td>McCabe essential</td><td>           1</td></tr>
213            <tr><td>McCabe modular design</td><td>           1</td></tr>
214          </table>
215         
216       
217        </div>
218       
219
220        <div class="routine_details" id="_cw_specifie_get_value">
221
222          <h2><a class="top" href="#container">top</a>cw_specifie_get_value <span class="categories">
223 Compound widget
224</span></h2>
225       
226          <p class="header">
227            <span class="result">result = </span>cw_specifie_get_value(<span class="result"><a href="#_cw_specifie_get_value_param_id">id</a></span>)</p>
228       
229          <div class="comments">
230</div>
231
232          <h3>Return value</h3><div class="preformat">
233</div>
234
235         
236            <h3>Parameters</h3>
237       
238           
239            <h4 id="_cw_specifie_get_value_param_id">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
240             
241             
242             
243             
244             
245             
246             
247             
248            </h4>
249       
250          <div class="comments">
251</div>
252           
253
254         
255
256         
257
258          <h3>Examples</h3><div class="preformat">
259</div>
260          <h3>Version history</h3>
261         
262          <h4>Version</h4><div class="preformat">
263 $Id: cw_specifie.pro 327 2007-12-13 16:22:35Z pinsard $
264</div>
265          <h4>History</h4><div class="preformat">
266</div>
267         
268         
269          <h3>Known issues</h3>
270         
271         
272         
273          <h4>Restrictions</h4><div class="preformat">
274</div>
275       
276          <h3>Other attributes</h3>
277         
278         
279          <h4>Uses routines</h4><div class="preformat">
280</div>
281         
282         
283         
284       
285          <h3>Statistics</h3>
286          <table class="statistics">
287            <tr><td>McCabe cyclic</td><td>           2</td></tr>
288            <tr><td>McCabe essential</td><td>           1</td></tr>
289            <tr><td>McCabe modular design</td><td>           1</td></tr>
290          </table>
291         
292       
293        </div>
294       
295
296        <div class="routine_details" id="_cw_specifie_event">
297
298          <h2><a class="top" href="#container">top</a>cw_specifie_event <span class="categories">
299 Compound widget
300</span></h2>
301       
302          <p class="header">
303            <span class="result">result = </span>cw_specifie_event(<span class="result"><a href="#_cw_specifie_event_param_event">event</a></span>)</p>
304       
305          <div class="comments">
306</div>
307
308          <h3>Return value</h3><div class="preformat">
309</div>
310
311         
312            <h3>Parameters</h3>
313       
314           
315            <h4 id="_cw_specifie_event_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
316             
317             
318             
319             
320             
321             
322             
323             
324            </h4>
325       
326          <div class="comments">
327</div>
328           
329
330         
331
332         
333
334          <h3>Examples</h3><div class="preformat">
335</div>
336          <h3>Version history</h3>
337         
338          <h4>Version</h4><div class="preformat">
339 $Id: cw_specifie.pro 327 2007-12-13 16:22:35Z pinsard $
340</div>
341          <h4>History</h4><div class="preformat">
342</div>
343         
344         
345          <h3>Known issues</h3>
346         
347         
348         
349          <h4>Restrictions</h4><div class="preformat">
350</div>
351       
352          <h3>Other attributes</h3>
353         
354         
355          <h4>Uses routines</h4><div class="preformat">
356</div>
357         
358         
359         
360       
361          <h3>Statistics</h3>
362          <table class="statistics">
363            <tr><td>McCabe cyclic</td><td>           4</td></tr>
364            <tr><td>McCabe essential</td><td>           1</td></tr>
365            <tr><td>McCabe modular design</td><td>           1</td></tr>
366          </table>
367         
368       
369        </div>
370       
371
372        <div class="routine_details" id="_cw_specifie">
373
374          <h2><a class="top" href="#container">top</a>cw_specifie <span class="categories">
375 Compound widget
376</span></h2>
377       
378          <p class="header">
379            <span class="result">result = </span>cw_specifie(<span class="result"><a href="#_cw_specifie_param_parent">parent</a></span>, <a href="#_cw_specifie_keyword_ROW">ROW</a>=<span class="result">ROW</span>, <a href="#_cw_specifie_keyword_COLUMN">COLUMN</a>=<span class="result">COLUMN</span>, <a href="#_cw_specifie_keyword_UVALUE">UVALUE</a>=<span class="result">UVALUE</span>, <a href="#_cw_specifie_keyword_UNAME">UNAME</a>=<span class="result">UNAME</span>, <a href="#_cw_specifie_keyword_FRAME">FRAME</a>=<span class="result">FRAME</span>, <a href="#_cw_specifie_keyword_FORXXX">FORXXX</a>=<span class="result">FORXXX</span>, <a href="#_cw_specifie_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
380       
381          <div class="comments">
382</div>
383
384          <h3>Return value</h3><div class="preformat">
385</div>
386
387         
388            <h3>Parameters</h3>
389       
390           
391            <h4 id="_cw_specifie_param_parent">parent&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
392              <span class="attr">in</span>
393             
394             
395              <span class="attr">required</span>
396             
397             
398             
399             
400            </h4>
401       
402          <div class="comments">
403 The widget ID of the parent widget.
404</div>
405           
406
407         
408
409         
410
411            <h3>Keywords</h3>
412           
413            <h4 id="_cw_specifie_keyword_ROW">ROW&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
414             
415             
416             
417             
418             
419             
420             
421             
422            </h4>
423       
424            <div class="comments">
425 Buttons will be arranged in the number of rows
426 specified by this keyword.
427</div>
428           
429            <h4 id="_cw_specifie_keyword_COLUMN">COLUMN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
430             
431             
432             
433             
434             
435             
436             
437             
438            </h4>
439       
440            <div class="comments">
441 Buttons will be arranged in the number of columns
442 specified by this keyword.
443</div>
444           
445            <h4 id="_cw_specifie_keyword_UVALUE">UVALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
446             
447             
448             
449             
450             
451             
452             
453             
454            </h4>
455       
456            <div class="comments">
457 The user value to be associated with the widget.
458</div>
459           
460            <h4 id="_cw_specifie_keyword_UNAME">UNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
461             
462             
463             
464             
465             
466             
467             
468             
469            </h4>
470       
471            <div class="comments">
472 The user name to be associated with the widget.
473</div>
474           
475            <h4 id="_cw_specifie_keyword_FRAME">FRAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
476             
477             
478             
479             
480             
481             
482             
483             
484            </h4>
485       
486            <div class="comments">
487</div>
488           
489            <h4 id="_cw_specifie_keyword_FORXXX">FORXXX&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
490             
491             
492             
493             
494             
495             
496             
497             
498            </h4>
499       
500            <div class="comments">
501</div>
502           
503            <h4 id="_cw_specifie_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
504             
505             
506             
507             
508             
509             
510             
511             
512            </h4>
513       
514            <div class="comments">
515 Used to pass keywords
516</div>
517           
518         
519
520          <h3>Examples</h3><div class="preformat">
521</div>
522          <h3>Version history</h3>
523         
524          <h4>Version</h4><div class="preformat">
525 $Id: cw_specifie.pro 327 2007-12-13 16:22:35Z pinsard $
526</div>
527          <h4>History</h4><div class="preformat">
528</div>
529         
530         
531          <h3>Known issues</h3>
532         
533         
534          <h4>Todo items</h4><div class="preformat">
535 seb: documenter
536</div>
537          <h4>Restrictions</h4><div class="preformat">
538</div>
539       
540          <h3>Other attributes</h3>
541         
542         
543          <h4>Uses routines</h4><div class="preformat">
544</div>
545         
546         
547         
548       
549          <h3>Statistics</h3>
550          <table class="statistics">
551            <tr><td>McCabe cyclic</td><td>           8</td></tr>
552            <tr><td>McCabe essential</td><td>           1</td></tr>
553            <tr><td>McCabe modular design</td><td>           1</td></tr>
554          </table>
555         
556       
557        </div>
558       
559      </div>
560
561     
562
563      <div id="tagline">Produced by IDLdoc 2.0.</div>
564
565    </div>
566
567  </body>
568</html>
Note: See TracBrowser for help on using the repository browser.