source: trunk/SRC/Documentation/idldoc_assistant_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: 13.6 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>cw_slider_pm.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="cw_slide_slice.html"><img src="./../../../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../../../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="cw_specifie.html"><img src="./../../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/WIDGET/COMPOUND_WIDGET/</font></h1>
58    <h2>cw_slider_pm.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64
65
66
67
68
69
70
71
72
73
74
75 Like WIDGET_SLIDER but here, there are 2 buttons + and - to move the widget from +/- 1
76
77
78   
79    <h2>Routine summary</h2>
80
81    <dl>
82     
83      <dt><a href="#_decvalue"><i>result = </i>decvalue(<i>value</i>)</a><dt>
84      <dd><font size="-1"> </font></dd>
85     
86      <dt><a href="#_decind"><i>result = </i>decind(<i>value</i>)</a><dt>
87      <dd><font size="-1"> </font></dd>
88     
89      <dt><a href="#_cw_slider_pm_set_value">cw_slider_pm_set_value<i>, id, value</i></a><dt>
90      <dd><font size="-1"> </font></dd>
91     
92      <dt><a href="#_cw_slider_pm_get_value"><i>result = </i>cw_slider_pm_get_value(<i>id</i>)</a><dt>
93      <dd><font size="-1"> </font></dd>
94     
95      <dt><a href="#_cw_slider_pm_event"><i>result = </i>cw_slider_pm_event(<i>event</i>)</a><dt>
96      <dd><font size="-1"> </font></dd>
97     
98      <dt><a href="#_cw_slider_pm"><i>result = </i>cw_slider_pm(<i>parent</i>, MAXIMUM=<i>MAXIMUM</i>, MINIMUM=<i>MINIMUM</i>, STRMINLEN=<i>STRMINLEN</i>, VALUE=<i>VALUE</i>, UVALUE=<i>UVALUE</i>, UNAME=<i>UNAME</i>, TITLE=<i>TITLE</i>, _EXTRA=<i>_EXTRA</i>)</a><dt>
99      <dd><font size="-1"> </font></dd>
100     
101    </dl>
102
103    <p>&nbsp;</p>
104   
105
106     
107      <a name="#_decvalue"></a>
108
109      <h2>decvalue  <font size="-1" color="#006633">
110 Compound widget
111</font></h2>
112
113      <p><font face="Courier"><i>result = </i>decvalue(<i><a href="#_decvalue_keyword_value">value</a></i>)</font></p>
114
115   
116
117
118    <h3>Return value</h3>
119
120
121   
122    <h3>Parameters</h3>
123   
124
125    <a name="#_decvalue_keyword_value"></a>
126    <h4>value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
127     
128     
129     
130     
131     
132     
133     
134     
135    </h4>
136
137   
138 It is the default tick mark value (a floating-point number).
139
140   
141   
142
143   
144
145    <h3>Examples</h3><pre>
146
147    </pre><h3>Version history</h3>
148   
149    <h4>Version</h4>
150 $Id: cw_slider_pm.pro 327 2007-12-13 16:22:35Z pinsard $
151
152    <h4>History</h4>
153
154   
155
156    <h3>Known issues</h3>
157   
158   
159   
160    <h4>Restrictions</h4>
161
162
163    <h3>Other attributes</h3>
164   
165   
166    <h4>Uses routines</h4>
167
168   
169   
170   
171
172    <font size="-3"><p>&nbsp;</p></font>
173    <hr size="1" color="#CCCCCC"/>
174     
175      <a name="#_decind"></a>
176
177      <h2>decind  <font size="-1" color="#006633">
178 Compound widget
179</font></h2>
180
181      <p><font face="Courier"><i>result = </i>decind(<i><a href="#_decind_keyword_value">value</a></i>)</font></p>
182
183   
184
185
186    <h3>Return value</h3>
187
188
189   
190    <h3>Parameters</h3>
191   
192
193    <a name="#_decind_keyword_value"></a>
194    <h4>value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
195     
196     
197     
198     
199     
200     
201     
202     
203    </h4>
204
205   
206 It is the default tick mark value (a floating-point number).
207
208   
209   
210
211   
212
213    <h3>Examples</h3><pre>
214
215    </pre><h3>Version history</h3>
216   
217    <h4>Version</h4>
218 $Id: cw_slider_pm.pro 327 2007-12-13 16:22:35Z pinsard $
219
220    <h4>History</h4>
221
222   
223
224    <h3>Known issues</h3>
225   
226   
227   
228    <h4>Restrictions</h4>
229
230
231    <h3>Other attributes</h3>
232   
233   
234    <h4>Uses routines</h4>
235
236   
237   
238   
239
240    <font size="-3"><p>&nbsp;</p></font>
241    <hr size="1" color="#CCCCCC"/>
242     
243      <a name="#_cw_slider_pm_set_value"></a>
244
245      <h2>cw_slider_pm_set_value  <font size="-1" color="#006633">
246 Compound widget
247</font></h2>
248
249      <p><font face="Courier">cw_slider_pm_set_value<i>, <a href="#_cw_slider_pm_set_value_keyword_id">id</a>, <a href="#_cw_slider_pm_set_value_keyword_value">value</a></i></font></p>
250
251   
252
253
254    <h3>Return value</h3>
255
256
257   
258    <h3>Parameters</h3>
259   
260
261    <a name="#_cw_slider_pm_set_value_keyword_id"></a>
262    <h4>id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
263     
264     
265     
266     
267     
268     
269     
270     
271    </h4>
272
273   
274
275   
276
277    <a name="#_cw_slider_pm_set_value_keyword_value"></a>
278    <h4>value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
279     
280     
281     
282     
283     
284     
285     
286     
287    </h4>
288
289   
290 It is the default tick mark value (a floating-point number).
291
292   
293   
294
295   
296
297    <h3>Examples</h3><pre>
298
299    </pre><h3>Version history</h3>
300   
301    <h4>Version</h4>
302 $Id: cw_slider_pm.pro 327 2007-12-13 16:22:35Z pinsard $
303
304    <h4>History</h4>
305
306   
307
308    <h3>Known issues</h3>
309   
310   
311   
312    <h4>Restrictions</h4>
313
314
315    <h3>Other attributes</h3>
316   
317   
318    <h4>Uses routines</h4>
319
320   
321   
322   
323
324    <font size="-3"><p>&nbsp;</p></font>
325    <hr size="1" color="#CCCCCC"/>
326     
327      <a name="#_cw_slider_pm_get_value"></a>
328
329      <h2>cw_slider_pm_get_value  <font size="-1" color="#006633">
330 Compound widget
331</font></h2>
332
333      <p><font face="Courier"><i>result = </i>cw_slider_pm_get_value(<i><a href="#_cw_slider_pm_get_value_keyword_id">id</a></i>)</font></p>
334
335   
336
337
338    <h3>Return value</h3>
339
340
341   
342    <h3>Parameters</h3>
343   
344
345    <a name="#_cw_slider_pm_get_value_keyword_id"></a>
346    <h4>id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
347     
348     
349     
350     
351     
352     
353     
354     
355    </h4>
356
357   
358
359   
360   
361
362   
363
364    <h3>Examples</h3><pre>
365
366    </pre><h3>Version history</h3>
367   
368    <h4>Version</h4>
369 $Id: cw_slider_pm.pro 327 2007-12-13 16:22:35Z pinsard $
370
371    <h4>History</h4>
372
373   
374
375    <h3>Known issues</h3>
376   
377   
378   
379    <h4>Restrictions</h4>
380
381
382    <h3>Other attributes</h3>
383   
384   
385    <h4>Uses routines</h4>
386
387   
388   
389   
390
391    <font size="-3"><p>&nbsp;</p></font>
392    <hr size="1" color="#CCCCCC"/>
393     
394      <a name="#_cw_slider_pm_event"></a>
395
396      <h2>cw_slider_pm_event  <font size="-1" color="#006633">
397 Compound widget
398</font></h2>
399
400      <p><font face="Courier"><i>result = </i>cw_slider_pm_event(<i><a href="#_cw_slider_pm_event_keyword_event">event</a></i>)</font></p>
401
402   
403
404
405    <h3>Return value</h3>
406
407
408   
409    <h3>Parameters</h3>
410   
411
412    <a name="#_cw_slider_pm_event_keyword_event"></a>
413    <h4>event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
414     
415     
416     
417     
418     
419     
420     
421     
422    </h4>
423
424   
425
426   
427   
428
429   
430
431    <h3>Examples</h3><pre>
432
433    </pre><h3>Version history</h3>
434   
435    <h4>Version</h4>
436 $Id: cw_slider_pm.pro 327 2007-12-13 16:22:35Z pinsard $
437
438    <h4>History</h4>
439
440   
441
442    <h3>Known issues</h3>
443   
444   
445   
446    <h4>Restrictions</h4>
447
448
449    <h3>Other attributes</h3>
450   
451   
452    <h4>Uses routines</h4>
453
454   
455   
456   
457
458    <font size="-3"><p>&nbsp;</p></font>
459    <hr size="1" color="#CCCCCC"/>
460     
461      <a name="#_cw_slider_pm"></a>
462
463      <h2>cw_slider_pm  <font size="-1" color="#006633">
464 Compound widget
465</font></h2>
466
467      <p><font face="Courier"><i>result = </i>cw_slider_pm(<i><a href="#_cw_slider_pm_keyword_parent">parent</a></i>, <a href="#_cw_slider_pm_keyword_MAXIMUM">MAXIMUM</a>=<i>MAXIMUM</i>, <a href="#_cw_slider_pm_keyword_MINIMUM">MINIMUM</a>=<i>MINIMUM</i>, <a href="#_cw_slider_pm_keyword_STRMINLEN">STRMINLEN</a>=<i>STRMINLEN</i>, <a href="#_cw_slider_pm_keyword_VALUE">VALUE</a>=<i>VALUE</i>, <a href="#_cw_slider_pm_keyword_UVALUE">UVALUE</a>=<i>UVALUE</i>, <a href="#_cw_slider_pm_keyword_UNAME">UNAME</a>=<i>UNAME</i>, <a href="#_cw_slider_pm_keyword_TITLE">TITLE</a>=<i>TITLE</i>, <a href="#_cw_slider_pm_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
468
469   
470
471
472    <h3>Return value</h3>
473 The returned value of this function is the widget ID of the
474 newly-created animation widget.
475
476
477   
478    <h3>Parameters</h3>
479   
480
481    <a name="#_cw_slider_pm_keyword_parent"></a>
482    <h4>parent&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
483      <font size="-1" color="#006633">in</font>
484     
485     
486      <font size="-1" color="#006633">required</font>
487     
488     
489     
490     
491    </h4>
492
493   
494 The widget ID of the parent widget.
495
496   
497   
498
499   
500    <h3>Keywords</h3>
501
502   
503    <a name="#_cw_slider_pm_keyword_MAXIMUM"></a>
504    <h4>MAXIMUM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
505     
506     
507     
508     
509     
510     
511     
512     
513    </h4>
514
515   
516
517   
518    <a name="#_cw_slider_pm_keyword_MINIMUM"></a>
519    <h4>MINIMUM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
520     
521     
522     
523     
524     
525     
526     
527     
528    </h4>
529
530   
531
532   
533    <a name="#_cw_slider_pm_keyword_STRMINLEN"></a>
534    <h4>STRMINLEN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
535     
536     
537     
538     
539     
540     
541     
542     
543    </h4>
544
545   
546
547   
548    <a name="#_cw_slider_pm_keyword_VALUE"></a>
549    <h4>VALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
550     
551     
552     
553     
554     
555     
556     
557     
558    </h4>
559
560   
561
562   
563    <a name="#_cw_slider_pm_keyword_UVALUE"></a>
564    <h4>UVALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
565     
566     
567     
568     
569     
570     
571     
572     
573    </h4>
574
575   
576 The user value to be associated with the widget.
577
578   
579    <a name="#_cw_slider_pm_keyword_UNAME"></a>
580    <h4>UNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
581     
582     
583     
584     
585     
586     
587     
588     
589    </h4>
590
591   
592 The user name to be associated with the widget.
593
594   
595    <a name="#_cw_slider_pm_keyword_TITLE"></a>
596    <h4>TITLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
597     
598     
599     
600     
601     
602     
603     
604     
605    </h4>
606
607   
608   
609    <a name="#_cw_slider_pm_keyword__EXTRA"></a>
610    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
611     
612     
613     
614     
615     
616     
617     
618     
619    </h4>
620
621   
622 Used to pass keywords
623
624   
625   
626
627    <h3>Examples</h3><pre>
628 See the program provided above (testwid and the associated procedure, testwid_event).
629
630    </pre><h3>Version history</h3>
631   
632    <h4>Version</h4>
633 $Id: cw_slider_pm.pro 327 2007-12-13 16:22:35Z pinsard $
634
635    <h4>History</h4>
636 Sebastien Masson (smasson@lodyc.jussieu.fr)
637                      5/9/1999
638
639   
640
641    <h3>Known issues</h3>
642   
643   
644    <h4>Todo items</h4>
645 seb: documenter
646
647    <h4>Restrictions</h4>
648
649  Widget Events Returned by the CW_SLIDER_PM Widget
650
651  Slider widgets generate events when the mouse is used to change
652  their value. The event structure returned by the WIDGET_EVENT
653  function is defined by the following statement:
654
655  {CW_SLIDER_PM, ID:0L, TOP:0L, HANDLER:0L, VALUE:0L, DRAG:0, OUT:0}
656
657  ID is the widget ID of the button generating the event. TOP is the
658  widget ID of the top level widget containing ID.
659  HANDLER contains the widget ID of the widget associated with the
660  handler routine.
661  VALUE returns the new value of the slider.
662  DRAG returns integer 1 if the slider event was generated as part of
663  a drag operation, or zero if the event was generated when the user
664  had finished positioning the slider. Note that the slider widget
665  only generates events during the drag operation if the DRAG keyword
666  is set, and if the application is running under Motif. When the
667  DRAG keyword is set, the DRAG field can be used to avoid
668  computationally expensive operations until the user releases the
669  slider.
670  OUT:It is an integer which can take 3 values:
671       1 : If we press + when the index is already at the max
672       Comment: In this case, the index stay at the max
673       -1: If we press - when the index is already at the min
674       Comment: In this case, the index stay at the min
675       0 : In other cases
676
677   Keywords to WIDGET_CONTROL
678
679   A number of keywords to the WIDGET_CONTROL procedure affect the
680   behavior of cw_slider_pm widget: GET_VALUE and SET_VALUE.
681       1) GET_VALUE
682   widget_control,wid_id,get_value=resultat
683   Send back in the result variable a structure of 2 elements whose name
684   are inspired from keywords we can pass at
685   widget_control when we use WIDGET_SLIDER:
686            VALUE:the value setting of the widget
687            SLIDER_MIN_MAX: a 2 elements array: The minimum and the
688            maximum value of the range encompassed by the slider
689       2) SET_VALUE
690   widget_control,wid_id,set_value=impose
691   Allows to modify the state of the combobox like we can do it for
692   WIDGET_COMBOBOX. May impose:
693       a) a integer: give the new position of the slider.
694       b) A structure which can have for elements (from 1 to 3):
695            VALUE: an integer which give the new position of the slider
696            SLIDER_MIN:Set to a new minimum value for the specified
697            slider widget.
698            SLIDER_MAX:Set to a new minimum value for the specified
699            slider widget.
700
701
702
703   
704   
705   
706   
707   
708   
709   
710
711    <font size="-3"><p>&nbsp;</p></font>
712    <hr size="1" color="#CCCCCC"/>
713     
714
715   
716
717    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
718
719  </body>
720</html>
Note: See TracBrowser for help on using the repository browser.