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

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