Context Navigation

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

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

Note: See TracBrowser for help on using the repository browser.

Download in other formats: