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

Last change on this file since 249 was 249, checked in by smasson, 17 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 232 2007-03-20 16:59:36Z pinsard $</div>
188          <h4>History</h4><div class="preformat">
189</div>
190         
191         
192          <h3>Known issues</h3>
193         
194         
195         
196          <h4>Restrictions</h4><div class="preformat">
197</div>
198       
199          <h3>Other attributes</h3>
200         
201         
202          <h4>Uses routines</h4><div class="preformat">
203</div>
204         
205         
206         
207       
208          <h3>Statistics</h3>
209          <table class="statistics">
210            <tr><td>McCabe cyclic</td><td>           4</td></tr>
211            <tr><td>McCabe essential</td><td>           1</td></tr>
212            <tr><td>McCabe modular design</td><td>           1</td></tr>
213          </table>
214         
215       
216        </div>
217       
218
219        <div class="routine_details" id="_cw_specifie_get_value">
220
221          <h2><a class="top" href="#container">top</a>cw_specifie_get_value <span class="categories">
222 Compound widget
223</span></h2>
224       
225          <p class="header">
226            <span class="result">result = </span>cw_specifie_get_value(<span class="result"><a href="#_cw_specifie_get_value_param_id">id</a></span>)</p>
227       
228          <div class="comments">
229</div>
230
231          <h3>Return value</h3><div class="preformat">
232</div>
233
234         
235            <h3>Parameters</h3>
236       
237           
238            <h4 id="_cw_specifie_get_value_param_id">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
239             
240             
241             
242             
243             
244             
245             
246             
247            </h4>
248       
249          <div class="comments">
250</div>
251           
252
253         
254
255         
256
257          <h3>Examples</h3><div class="preformat">
258</div>
259          <h3>Version history</h3>
260         
261          <h4>Version</h4><div class="preformat">
262 $Id: cw_specifie.pro 232 2007-03-20 16:59:36Z pinsard $
263</div>
264          <h4>History</h4><div class="preformat">
265</div>
266         
267         
268          <h3>Known issues</h3>
269         
270         
271         
272          <h4>Restrictions</h4><div class="preformat">
273</div>
274       
275          <h3>Other attributes</h3>
276         
277         
278          <h4>Uses routines</h4><div class="preformat">
279</div>
280         
281         
282         
283       
284          <h3>Statistics</h3>
285          <table class="statistics">
286            <tr><td>McCabe cyclic</td><td>           2</td></tr>
287            <tr><td>McCabe essential</td><td>           1</td></tr>
288            <tr><td>McCabe modular design</td><td>           1</td></tr>
289          </table>
290         
291       
292        </div>
293       
294
295        <div class="routine_details" id="_cw_specifie_event">
296
297          <h2><a class="top" href="#container">top</a>cw_specifie_event <span class="categories">
298 Compound widget
299</span></h2>
300       
301          <p class="header">
302            <span class="result">result = </span>cw_specifie_event(<span class="result"><a href="#_cw_specifie_event_param_event">event</a></span>)</p>
303       
304          <div class="comments">
305</div>
306
307          <h3>Return value</h3><div class="preformat">
308</div>
309
310         
311            <h3>Parameters</h3>
312       
313           
314            <h4 id="_cw_specifie_event_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
315             
316             
317             
318             
319             
320             
321             
322             
323            </h4>
324       
325          <div class="comments">
326</div>
327           
328
329         
330
331         
332
333          <h3>Examples</h3><div class="preformat">
334</div>
335          <h3>Version history</h3>
336         
337          <h4>Version</h4><div class="preformat">
338 $Id: cw_specifie.pro 232 2007-03-20 16:59:36Z pinsard $
339</div>
340          <h4>History</h4><div class="preformat">
341</div>
342         
343         
344          <h3>Known issues</h3>
345         
346         
347         
348          <h4>Restrictions</h4><div class="preformat">
349</div>
350       
351          <h3>Other attributes</h3>
352         
353         
354          <h4>Uses routines</h4><div class="preformat">
355</div>
356         
357         
358         
359       
360          <h3>Statistics</h3>
361          <table class="statistics">
362            <tr><td>McCabe cyclic</td><td>           4</td></tr>
363            <tr><td>McCabe essential</td><td>           1</td></tr>
364            <tr><td>McCabe modular design</td><td>           1</td></tr>
365          </table>
366         
367       
368        </div>
369       
370
371        <div class="routine_details" id="_cw_specifie">
372
373          <h2><a class="top" href="#container">top</a>cw_specifie <span class="categories">
374 Compound widget
375</span></h2>
376       
377          <p class="header">
378            <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>
379       
380          <div class="comments">
381</div>
382
383          <h3>Return value</h3><div class="preformat">
384</div>
385
386         
387            <h3>Parameters</h3>
388       
389           
390            <h4 id="_cw_specifie_param_parent">parent&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
391              <span class="attr">in</span>
392             
393             
394              <span class="attr">required</span>
395             
396             
397             
398             
399            </h4>
400       
401          <div class="comments">
402 The widget ID of the parent widget.
403</div>
404           
405
406         
407
408         
409
410            <h3>Keywords</h3>
411           
412            <h4 id="_cw_specifie_keyword_ROW">ROW&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
413             
414             
415             
416             
417             
418             
419             
420             
421            </h4>
422       
423            <div class="comments">
424 Buttons will be arranged in the number of rows
425 specified by this keyword.
426</div>
427           
428            <h4 id="_cw_specifie_keyword_COLUMN">COLUMN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
429             
430             
431             
432             
433             
434             
435             
436             
437            </h4>
438       
439            <div class="comments">
440 Buttons will be arranged in the number of columns
441 specified by this keyword.
442</div>
443           
444            <h4 id="_cw_specifie_keyword_UVALUE">UVALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
445             
446             
447             
448             
449             
450             
451             
452             
453            </h4>
454       
455            <div class="comments">
456 The user value to be associated with the widget.
457</div>
458           
459            <h4 id="_cw_specifie_keyword_UNAME">UNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
460             
461             
462             
463             
464             
465             
466             
467             
468            </h4>
469       
470            <div class="comments">
471 The user name to be associated with the widget.
472</div>
473           
474            <h4 id="_cw_specifie_keyword_FRAME">FRAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
475             
476             
477             
478             
479             
480             
481             
482             
483            </h4>
484       
485            <div class="comments">
486</div>
487           
488            <h4 id="_cw_specifie_keyword_FORXXX">FORXXX&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
489             
490             
491             
492             
493             
494             
495             
496             
497            </h4>
498       
499            <div class="comments">
500</div>
501           
502            <h4 id="_cw_specifie_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
503             
504             
505             
506             
507             
508             
509             
510             
511            </h4>
512       
513            <div class="comments">
514 Used to pass keywords
515</div>
516           
517         
518
519          <h3>Examples</h3><div class="preformat">
520</div>
521          <h3>Version history</h3>
522         
523          <h4>Version</h4><div class="preformat">
524 $Id: cw_specifie.pro 232 2007-03-20 16:59:36Z pinsard $
525</div>
526          <h4>History</h4><div class="preformat">
527</div>
528         
529         
530          <h3>Known issues</h3>
531         
532         
533          <h4>Todo items</h4><div class="preformat">
534 seb: documenter
535</div>
536          <h4>Restrictions</h4><div class="preformat">
537</div>
538       
539          <h3>Other attributes</h3>
540         
541         
542          <h4>Uses routines</h4><div class="preformat">
543</div>
544         
545         
546         
547       
548          <h3>Statistics</h3>
549          <table class="statistics">
550            <tr><td>McCabe cyclic</td><td>           8</td></tr>
551            <tr><td>McCabe essential</td><td>           1</td></tr>
552            <tr><td>McCabe modular design</td><td>           1</td></tr>
553          </table>
554         
555       
556        </div>
557       
558      </div>
559
560     
561
562      <div id="tagline">Produced by IDLdoc 2.0.</div>
563
564    </div>
565
566  </body>
567</html>
Note: See TracBrowser for help on using the repository browser.