source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/WIDGET/COMPOUND_WIDGET/cw_slider_pm.html @ 187

Last change on this file since 187 was 187, checked in by pinsard, 18 years ago

introducing hyperlinks in idldoc outputs (2/2)

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