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