source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/WIDGET/COMPOUND_WIDGET/cw_slider_pm.html @ 321

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

update documentation
File size: 17.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_slider_pm.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_slider_pm.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_slider_pm.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_slide_slice.html">&lt;&lt;prev file</a> | <a href="cw_specifie.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="cw_slider_pm.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_slider_pm.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
97
98
99
100
101 Like WIDGET_SLIDER but here, there are 2 buttons + and - to move the widget from +/- 1
102</div>
103
104     
105
106     
107
108     
109
110     
111      <div id="routine_summary">               
112        <h2>Routine summary</h2>
113       
114        <dl>
115         
116          <dt><p><a href="#_decvalue"><span class="result">result = </span>decvalue(<span class="result">value</span>)</a></p><dt>
117          <dd> </dd>   
118         
119          <dt><p><a href="#_decind"><span class="result">result = </span>decind(<span class="result">value</span>)</a></p><dt>
120          <dd> </dd>   
121         
122          <dt><p><a href="#_cw_slider_pm_set_value">cw_slider_pm_set_value<span class="result">, id, value</span></a></p><dt>
123          <dd> </dd>   
124         
125          <dt><p><a href="#_cw_slider_pm_get_value"><span class="result">result = </span>cw_slider_pm_get_value(<span class="result">id</span>)</a></p><dt>
126          <dd> </dd>   
127         
128          <dt><p><a href="#_cw_slider_pm_event"><span class="result">result = </span>cw_slider_pm_event(<span class="result">event</span>)</a></p><dt>
129          <dd> </dd>   
130         
131          <dt><p><a href="#_cw_slider_pm"><span class="result">result = </span>cw_slider_pm(<span class="result">parent</span>, MAXIMUM=<span class="result">MAXIMUM</span>, MINIMUM=<span class="result">MINIMUM</span>, STRMINLEN=<span class="result">STRMINLEN</span>, VALUE=<span class="result">VALUE</span>, UVALUE=<span class="result">UVALUE</span>, UNAME=<span class="result">UNAME</span>, TITLE=<span class="result">TITLE</span>, _EXTRA=<span class="result">_EXTRA</span>)</a></p><dt>
132          <dd> </dd>   
133               
134        </dl>
135      </div>
136     
137
138      <div id="routine_details">
139       
140
141        <div class="routine_details" id="_decvalue">
142
143          <h2><a class="top" href="#container">top</a>decvalue <span class="categories">
144 Compound widget
145</span></h2>
146       
147          <p class="header">
148            <span class="result">result = </span>decvalue(<span class="result"><a href="#_decvalue_param_value">value</a></span>)</p>
149       
150          <div class="comments">
151</div>
152
153          <h3>Return value</h3><div class="preformat">
154</div>
155
156         
157            <h3>Parameters</h3>
158       
159           
160            <h4 id="_decvalue_param_value">value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
161             
162             
163             
164             
165             
166             
167             
168             
169            </h4>
170       
171          <div class="comments">
172 It is the default tick mark value (a floating-point number).
173</div>
174           
175
176         
177
178         
179
180          <h3>Examples</h3><div class="preformat">
181</div>
182          <h3>Version history</h3>
183         
184          <h4>Version</h4><div class="preformat">
185 $Id: cw_slider_pm.pro 295 2007-09-25 10:16:00Z pinsard $</div>
186          <h4>History</h4><div class="preformat">
187</div>
188         
189         
190          <h3>Known issues</h3>
191         
192         
193         
194          <h4>Restrictions</h4><div class="preformat">
195</div>
196       
197          <h3>Other attributes</h3>
198         
199         
200          <h4>Uses routines</h4><div class="preformat">
201</div>
202         
203         
204         
205       
206          <h3>Statistics</h3>
207          <table class="statistics">
208            <tr><td>McCabe cyclic</td><td>           1</td></tr>
209            <tr><td>McCabe essential</td><td>           1</td></tr>
210            <tr><td>McCabe modular design</td><td>           1</td></tr>
211          </table>
212         
213       
214        </div>
215       
216
217        <div class="routine_details" id="_decind">
218
219          <h2><a class="top" href="#container">top</a>decind <span class="categories">
220 Compound widget
221</span></h2>
222       
223          <p class="header">
224            <span class="result">result = </span>decind(<span class="result"><a href="#_decind_param_value">value</a></span>)</p>
225       
226          <div class="comments">
227</div>
228
229          <h3>Return value</h3><div class="preformat">
230</div>
231
232         
233            <h3>Parameters</h3>
234       
235           
236            <h4 id="_decind_param_value">value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
237             
238             
239             
240             
241             
242             
243             
244             
245            </h4>
246       
247          <div class="comments">
248 It is the default tick mark value (a floating-point number).
249</div>
250           
251
252         
253
254         
255
256          <h3>Examples</h3><div class="preformat">
257</div>
258          <h3>Version history</h3>
259         
260          <h4>Version</h4><div class="preformat">
261 $Id: cw_slider_pm.pro 295 2007-09-25 10:16:00Z pinsard $</div>
262          <h4>History</h4><div class="preformat">
263</div>
264         
265         
266          <h3>Known issues</h3>
267         
268         
269         
270          <h4>Restrictions</h4><div class="preformat">
271</div>
272       
273          <h3>Other attributes</h3>
274         
275         
276          <h4>Uses routines</h4><div class="preformat">
277</div>
278         
279         
280         
281       
282          <h3>Statistics</h3>
283          <table class="statistics">
284            <tr><td>McCabe cyclic</td><td>           1</td></tr>
285            <tr><td>McCabe essential</td><td>           1</td></tr>
286            <tr><td>McCabe modular design</td><td>           1</td></tr>
287          </table>
288         
289       
290        </div>
291       
292
293        <div class="routine_details" id="_cw_slider_pm_set_value">
294
295          <h2><a class="top" href="#container">top</a>cw_slider_pm_set_value <span class="categories">
296 Compound widget
297</span></h2>
298       
299          <p class="header">
300            cw_slider_pm_set_value<span class="result">, <a href="#_cw_slider_pm_set_value_param_id">id</a>, <a href="#_cw_slider_pm_set_value_param_value">value</a></span></p>
301       
302          <div class="comments">
303</div>
304
305          <h3>Return value</h3><div class="preformat">
306</div>
307
308         
309            <h3>Parameters</h3>
310       
311           
312            <h4 id="_cw_slider_pm_set_value_param_id">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
313             
314             
315             
316             
317             
318             
319             
320             
321            </h4>
322       
323          <div class="comments">
324</div>
325           
326            <h4 id="_cw_slider_pm_set_value_param_value">value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
327             
328             
329             
330             
331             
332             
333             
334             
335            </h4>
336       
337          <div class="comments">
338 It is the default tick mark value (a floating-point number).
339</div>
340           
341
342         
343
344         
345
346          <h3>Examples</h3><div class="preformat">
347</div>
348          <h3>Version history</h3>
349         
350          <h4>Version</h4><div class="preformat">
351 $Id: cw_slider_pm.pro 295 2007-09-25 10:16:00Z pinsard $</div>
352          <h4>History</h4><div class="preformat">
353</div>
354         
355         
356          <h3>Known issues</h3>
357         
358         
359         
360          <h4>Restrictions</h4><div class="preformat">
361</div>
362       
363          <h3>Other attributes</h3>
364         
365         
366          <h4>Uses routines</h4><div class="preformat">
367</div>
368         
369         
370         
371       
372          <h3>Statistics</h3>
373          <table class="statistics">
374            <tr><td>McCabe cyclic</td><td>          11</td></tr>
375            <tr><td>McCabe essential</td><td>           1</td></tr>
376            <tr><td>McCabe modular design</td><td>           1</td></tr>
377          </table>
378         
379       
380        </div>
381       
382
383        <div class="routine_details" id="_cw_slider_pm_get_value">
384
385          <h2><a class="top" href="#container">top</a>cw_slider_pm_get_value <span class="categories">
386 Compound widget
387</span></h2>
388       
389          <p class="header">
390            <span class="result">result = </span>cw_slider_pm_get_value(<span class="result"><a href="#_cw_slider_pm_get_value_param_id">id</a></span>)</p>
391       
392          <div class="comments">
393</div>
394
395          <h3>Return value</h3><div class="preformat">
396</div>
397
398         
399            <h3>Parameters</h3>
400       
401           
402            <h4 id="_cw_slider_pm_get_value_param_id">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
403             
404             
405             
406             
407             
408             
409             
410             
411            </h4>
412       
413          <div class="comments">
414</div>
415           
416
417         
418
419         
420
421          <h3>Examples</h3><div class="preformat">
422</div>
423          <h3>Version history</h3>
424         
425          <h4>Version</h4><div class="preformat">
426 $Id: cw_slider_pm.pro 295 2007-09-25 10:16:00Z pinsard $</div>
427          <h4>History</h4><div class="preformat">
428</div>
429         
430         
431          <h3>Known issues</h3>
432         
433         
434         
435          <h4>Restrictions</h4><div class="preformat">
436</div>
437       
438          <h3>Other attributes</h3>
439         
440         
441          <h4>Uses routines</h4><div class="preformat">
442</div>
443         
444         
445         
446       
447          <h3>Statistics</h3>
448          <table class="statistics">
449            <tr><td>McCabe cyclic</td><td>           1</td></tr>
450            <tr><td>McCabe essential</td><td>           1</td></tr>
451            <tr><td>McCabe modular design</td><td>           1</td></tr>
452          </table>
453         
454       
455        </div>
456       
457
458        <div class="routine_details" id="_cw_slider_pm_event">
459
460          <h2><a class="top" href="#container">top</a>cw_slider_pm_event <span class="categories">
461 Compound widget
462</span></h2>
463       
464          <p class="header">
465            <span class="result">result = </span>cw_slider_pm_event(<span class="result"><a href="#_cw_slider_pm_event_param_event">event</a></span>)</p>
466       
467          <div class="comments">
468</div>
469
470          <h3>Return value</h3><div class="preformat">
471</div>
472
473         
474            <h3>Parameters</h3>
475       
476           
477            <h4 id="_cw_slider_pm_event_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
478             
479             
480             
481             
482             
483             
484             
485             
486            </h4>
487       
488          <div class="comments">
489</div>
490           
491
492         
493
494         
495
496          <h3>Examples</h3><div class="preformat">
497</div>
498          <h3>Version history</h3>
499         
500          <h4>Version</h4><div class="preformat">
501 $Id: cw_slider_pm.pro 295 2007-09-25 10:16:00Z pinsard $</div>
502          <h4>History</h4><div class="preformat">
503</div>
504         
505         
506          <h3>Known issues</h3>
507         
508         
509         
510          <h4>Restrictions</h4><div class="preformat">
511</div>
512       
513          <h3>Other attributes</h3>
514         
515         
516          <h4>Uses routines</h4><div class="preformat">
517</div>
518         
519         
520         
521       
522          <h3>Statistics</h3>
523          <table class="statistics">
524            <tr><td>McCabe cyclic</td><td>          11</td></tr>
525            <tr><td>McCabe essential</td><td>           1</td></tr>
526            <tr><td>McCabe modular design</td><td>           1</td></tr>
527          </table>
528         
529       
530        </div>
531       
532
533        <div class="routine_details" id="_cw_slider_pm">
534
535          <h2><a class="top" href="#container">top</a>cw_slider_pm <span class="categories">
536 Compound widget
537</span></h2>
538       
539          <p class="header">
540            <span class="result">result = </span>cw_slider_pm(<span class="result"><a href="#_cw_slider_pm_param_parent">parent</a></span>, <a href="#_cw_slider_pm_keyword_MAXIMUM">MAXIMUM</a>=<span class="result">MAXIMUM</span>, <a href="#_cw_slider_pm_keyword_MINIMUM">MINIMUM</a>=<span class="result">MINIMUM</span>, <a href="#_cw_slider_pm_keyword_STRMINLEN">STRMINLEN</a>=<span class="result">STRMINLEN</span>, <a href="#_cw_slider_pm_keyword_VALUE">VALUE</a>=<span class="result">VALUE</span>, <a href="#_cw_slider_pm_keyword_UVALUE">UVALUE</a>=<span class="result">UVALUE</span>, <a href="#_cw_slider_pm_keyword_UNAME">UNAME</a>=<span class="result">UNAME</span>, <a href="#_cw_slider_pm_keyword_TITLE">TITLE</a>=<span class="result">TITLE</span>, <a href="#_cw_slider_pm_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
541       
542          <div class="comments">
543</div>
544
545          <h3>Return value</h3><div class="preformat">
546 The returned value of this function is the widget ID of the
547 newly-created animation widget.
548</div>
549
550         
551            <h3>Parameters</h3>
552       
553           
554            <h4 id="_cw_slider_pm_param_parent">parent&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
555              <span class="attr">in</span>
556             
557             
558              <span class="attr">required</span>
559             
560             
561             
562             
563            </h4>
564       
565          <div class="comments">
566 The widget ID of the parent widget.
567</div>
568           
569
570         
571
572         
573
574            <h3>Keywords</h3>
575           
576            <h4 id="_cw_slider_pm_keyword_MAXIMUM">MAXIMUM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
577             
578             
579             
580             
581             
582             
583             
584             
585            </h4>
586       
587            <div class="comments">
588</div>
589           
590            <h4 id="_cw_slider_pm_keyword_MINIMUM">MINIMUM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
591             
592             
593             
594             
595             
596             
597             
598             
599            </h4>
600       
601            <div class="comments">
602</div>
603           
604            <h4 id="_cw_slider_pm_keyword_STRMINLEN">STRMINLEN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
605             
606             
607             
608             
609             
610             
611             
612             
613            </h4>
614       
615            <div class="comments">
616</div>
617           
618            <h4 id="_cw_slider_pm_keyword_VALUE">VALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
619             
620             
621             
622             
623             
624             
625             
626             
627            </h4>
628       
629            <div class="comments">
630</div>
631           
632            <h4 id="_cw_slider_pm_keyword_UVALUE">UVALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
633             
634             
635             
636             
637             
638             
639             
640             
641            </h4>
642       
643            <div class="comments">
644 The user value to be associated with the widget.
645</div>
646           
647            <h4 id="_cw_slider_pm_keyword_UNAME">UNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
648             
649             
650             
651             
652             
653             
654             
655             
656            </h4>
657       
658            <div class="comments">
659 The user name to be associated with the widget.
660</div>
661           
662            <h4 id="_cw_slider_pm_keyword_TITLE">TITLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
663             
664             
665             
666             
667             
668             
669             
670             
671            </h4>
672       
673            <div class="comments"></div>
674           
675            <h4 id="_cw_slider_pm_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
676             
677             
678             
679             
680             
681             
682             
683             
684            </h4>
685       
686            <div class="comments">
687 Used to pass keywords
688</div>
689           
690         
691
692          <h3>Examples</h3><div class="preformat">
693 See the program provided above (testwid and the associated procedure, testwid_event).
694</div>
695          <h3>Version history</h3>
696         
697          <h4>Version</h4><div class="preformat">
698 $Id: cw_slider_pm.pro 295 2007-09-25 10:16:00Z pinsard $
699</div>
700          <h4>History</h4><div class="preformat">
701 Sebastien Masson (smasson@lodyc.jussieu.fr)
702                      5/9/1999
703</div>
704         
705         
706          <h3>Known issues</h3>
707         
708         
709          <h4>Todo items</h4><div class="preformat">
710 seb: documenter
711</div>
712          <h4>Restrictions</h4><div class="preformat">
713
714  Widget Events Returned by the CW_SLIDER_PM Widget
715
716  Slider widgets generate events when the mouse is used to change
717  their value. The event structure returned by the WIDGET_EVENT
718  function is defined by the following statement:
719
720  {CW_SLIDER_PM, ID:0L, TOP:0L, HANDLER:0L, VALUE:0L, DRAG:0, OUT:0}
721
722  ID is the widget ID of the button generating the event. TOP is the
723  widget ID of the top level widget containing ID.
724  HANDLER contains the widget ID of the widget associated with the
725  handler routine.
726  VALUE returns the new value of the slider.
727  DRAG returns integer 1 if the slider event was generated as part of
728  a drag operation, or zero if the event was generated when the user
729  had finished positioning the slider. Note that the slider widget
730  only generates events during the drag operation if the DRAG keyword
731  is set, and if the application is running under Motif. When the
732  DRAG keyword is set, the DRAG field can be used to avoid
733  computationally expensive operations until the user releases the
734  slider.
735  OUT:It is an integer which can take 3 values:
736       1 : If we press + when the index is already at the max
737       Comment: In this case, the index stay at the max
738       -1: If we press - when the index is already at the min
739       Comment: In this case, the index stay at the min
740       0 : In other cases
741
742   Keywords to WIDGET_CONTROL
743
744   A number of keywords to the WIDGET_CONTROL procedure affect the
745   behavior of cw_slider_pm widget: GET_VALUE and SET_VALUE.
746       1) GET_VALUE
747   widget_control,wid_id,get_value=resultat
748   Send back in the result variable a structure of 2 elements whose name
749   are inspired from keywords we can pass at
750   widget_control when we use WIDGET_SLIDER:
751            VALUE:the value setting of the widget
752            SLIDER_MIN_MAX: a 2 elements array: The minimum and the
753            maximum value of the range encompassed by the slider
754       2) SET_VALUE
755   widget_control,wid_id,set_value=impose
756   Allows to modify the state of the combobox like we can do it for
757   WIDGET_COMBOBOX. May impose:
758       a) a integer: give the new position of the slider.
759       b) A structure which can have for elements (from 1 to 3):
760            VALUE: an integer which give the new position of the slider
761            SLIDER_MIN:Set to a new minimum value for the specified
762            slider widget.
763            SLIDER_MAX:Set to a new minimum value for the specified
764            slider widget.
765
766</div>
767       
768         
769         
770         
771         
772         
773         
774         
775       
776          <h3>Statistics</h3>
777          <table class="statistics">
778            <tr><td>McCabe cyclic</td><td>           9</td></tr>
779            <tr><td>McCabe essential</td><td>           1</td></tr>
780            <tr><td>McCabe modular design</td><td>           1</td></tr>
781          </table>
782         
783       
784        </div>
785       
786      </div>
787
788     
789
790      <div id="tagline">Produced by IDLdoc 2.0.</div>
791
792    </div>
793
794  </body>
795</html>
Note: See TracBrowser for help on using the repository browser.