Context Navigation

source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/WIDGET/COMPOUND_WIDGET/cw_droplist_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: 14.4 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_droplist_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_droplist_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_droplist_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_domain.html"><<prev file</a> \| <a href="cw_pagelayout.html">next file >></a>    <a href="cw_droplist_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_droplist_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	Compound widget
94
95
96	Compound widget
97
98
99	Like WIDGET_DROPLIST but here, their are 2 buttons + and - to move the widget from +/- 1
100	</div>
101
102
103
104
105
106
107
108
109	<div id="routine_summary">
110	<h2>Routine summary</h2>
111
112	<dl>
113
114	<dt><p><a href="#_cw_droplist_pm_set_value">cw_droplist_pm_set_value<span class="result">, id, value</span></a></p><dt>
115	<dd></dd>
116
117	<dt><p><a href="#_cw_droplist_pm_get_value"><span class="result">result = </span>cw_droplist_pm_get_value(<span class="result">id</span>)</a></p><dt>
118	<dd></dd>
119
120	<dt><p><a href="#_cw_droplist_pm_event"><span class="result">result = </span>cw_droplist_pm_event(<span class="result">event</span>)</a></p><dt>
121	<dd></dd>
122
123	<dt><p><a href="#_cw_droplist_pm"><span class="result">result = </span>cw_droplist_pm(<span class="result">parent</span>, UVALUE=<span class="result">UVALUE</span>, UNAME=<span class="result">UNAME</span>, ROW=<span class="result">ROW</span>, COLUMN=<span class="result">COLUMN</span>, _extra=<span class="result">_extra</span>)</a></p><dt>
124	<dd> </dd>
125
126	</dl>
127	</div>
128
129
130	<div id="routine_details">
131
132
133	<div class="routine_details" id="_cw_droplist_pm_set_value">
134
135	<h2><a class="top" href="#container">top</a>cw_droplist_pm_set_value <span class="categories">
136	Compound widget
137	</span></h2>
138
139	<p class="header">
140	cw_droplist_pm_set_value<span class="result">, <a href="#_cw_droplist_pm_set_value_param_id">id</a>, <a href="#_cw_droplist_pm_set_value_param_value">value</a></span></p>
141
142	<div class="comments"></div>
143
144	<h3>Return value</h3><div class="preformat">
145
146	</div>
147
148
149	<h3>Parameters</h3>
150
151
152	<h4 id="_cw_droplist_pm_set_value_param_id">id
153
154
155
156
157
158
159
160
161	</h4>
162
163	<div class="comments">
164
165	</div>
166
167	<h4 id="_cw_droplist_pm_set_value_param_value">value
168
169
170
171
172
173
174
175
176	</h4>
177
178	<div class="comments">
179	It is the default tick mark value (a floating-point number).
180	</div>
181
182
183
184
185
186
187	<h3>Examples</h3><div class="preformat">
188
189	</div>
190	<h3>Version history</h3>
191
192	<h4>Version</h4><div class="preformat">
193	$Id: cw_droplist_pm.pro 157 2006-08-21 09:01:50Z navarro $</div>
194	<h4>History</h4><div class="preformat">
195
196	</div>
197
198
199	<h3>Known issues</h3>
200
201
202
203	<h4>Restrictions</h4><div class="preformat">
204
205	</div>
206
207	<h3>Other attributes</h3>
208
209
210	<h4>Uses routines</h4><div class="preformat">
211
212	</div>
213
214
215
216
217	<h3>Statistics</h3>
218	<table class="statistics">
219	<tr><td>McCabe cyclic</td><td> 7</td></tr>
220	<tr><td>McCabe essential</td><td> 1</td></tr>
221	<tr><td>McCabe modular design</td><td> 1</td></tr>
222	</table>
223
224
225	</div>
226
227
228	<div class="routine_details" id="_cw_droplist_pm_get_value">
229
230	<h2><a class="top" href="#container">top</a>cw_droplist_pm_get_value <span class="categories">
231	Compound widget
232	</span></h2>
233
234	<p class="header">
235	<span class="result">result = </span>cw_droplist_pm_get_value(<span class="result"><a href="#_cw_droplist_pm_get_value_param_id">id</a></span>)</p>
236
237	<div class="comments"></div>
238
239	<h3>Return value</h3><div class="preformat">
240
241	</div>
242
243
244	<h3>Parameters</h3>
245
246
247	<h4 id="_cw_droplist_pm_get_value_param_id">id
248
249
250
251
252
253
254
255
256	</h4>
257
258	<div class="comments">
259	</div>
260
261
262
263
264
265
266	<h3>Examples</h3><div class="preformat">
267
268	</div>
269	<h3>Version history</h3>
270
271	<h4>Version</h4><div class="preformat">
272	$Id: cw_droplist_pm.pro 157 2006-08-21 09:01:50Z navarro $</div>
273	<h4>History</h4><div class="preformat">
274
275	</div>
276
277
278	<h3>Known issues</h3>
279
280
281
282	<h4>Restrictions</h4><div class="preformat">
283
284	</div>
285
286	<h3>Other attributes</h3>
287
288
289	<h4>Uses routines</h4><div class="preformat">
290
291	</div>
292
293
294
295
296	<h3>Statistics</h3>
297	<table class="statistics">
298	<tr><td>McCabe cyclic</td><td> 1</td></tr>
299	<tr><td>McCabe essential</td><td> 1</td></tr>
300	<tr><td>McCabe modular design</td><td> 1</td></tr>
301	</table>
302
303
304	</div>
305
306
307	<div class="routine_details" id="_cw_droplist_pm_event">
308
309	<h2><a class="top" href="#container">top</a>cw_droplist_pm_event <span class="categories">
310	Compound widget
311	</span></h2>
312
313	<p class="header">
314	<span class="result">result = </span>cw_droplist_pm_event(<span class="result"><a href="#_cw_droplist_pm_event_param_event">event</a></span>)</p>
315
316	<div class="comments"></div>
317
318	<h3>Return value</h3><div class="preformat">
319
320	</div>
321
322
323	<h3>Parameters</h3>
324
325
326	<h4 id="_cw_droplist_pm_event_param_event">event
327
328
329
330
331
332
333
334
335	</h4>
336
337	<div class="comments">
338
339	</div>
340
341
342
343
344
345
346	<h3>Examples</h3><div class="preformat">
347
348	</div>
349	<h3>Version history</h3>
350
351	<h4>Version</h4><div class="preformat">
352	$Id: cw_droplist_pm.pro 157 2006-08-21 09:01:50Z navarro $</div>
353	<h4>History</h4><div class="preformat">
354
355	</div>
356
357
358	<h3>Known issues</h3>
359
360
361
362	<h4>Restrictions</h4><div class="preformat">
363
364	</div>
365
366	<h3>Other attributes</h3>
367
368
369	<h4>Uses routines</h4><div class="preformat">
370
371	</div>
372
373
374
375
376	<h3>Statistics</h3>
377	<table class="statistics">
378	<tr><td>McCabe cyclic</td><td> 6</td></tr>
379	<tr><td>McCabe essential</td><td> 1</td></tr>
380	<tr><td>McCabe modular design</td><td> 1</td></tr>
381	</table>
382
383
384	</div>
385
386
387	<div class="routine_details" id="_cw_droplist_pm">
388
389	<h2><a class="top" href="#container">top</a>cw_droplist_pm <span class="categories">
390	Compound widget
391	</span></h2>
392
393	<p class="header">
394	<span class="result">result = </span>cw_droplist_pm(<span class="result"><a href="#_cw_droplist_pm_param_parent">parent</a></span>, <a href="#_cw_droplist_pm_keyword_UVALUE">UVALUE</a>=<span class="result">UVALUE</span>, <a href="#_cw_droplist_pm_keyword_UNAME">UNAME</a>=<span class="result">UNAME</span>, <a href="#_cw_droplist_pm_keyword_ROW">ROW</a>=<span class="result">ROW</span>, <a href="#_cw_droplist_pm_keyword_COLUMN">COLUMN</a>=<span class="result">COLUMN</span>, <a href="#_cw_droplist_pm_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p>
395
396	<div class="comments">
397	</div>
398
399	<h3>Return value</h3><div class="preformat">
400	The returned value of this function is the widget ID of the
401	newly-created animation widget.
402	</div>
403
404
405	<h3>Parameters</h3>
406
407
408	<h4 id="_cw_droplist_pm_param_parent">parent
409	<span class="attr">in</span>
410
411
412	<span class="attr">required</span>
413
414
415
416
417	</h4>
418
419	<div class="comments">
420	The widget ID of the parent widget.
421	</div>
422
423
424
425
426
427
428	<h3>Keywords</h3>
429
430	<h4 id="_cw_droplist_pm_keyword_UVALUE">UVALUE
431
432
433
434
435
436
437
438
439	</h4>
440
441	<div class="comments">
442	The user value to be associated with the widget.
443	</div>
444
445	<h4 id="_cw_droplist_pm_keyword_UNAME">UNAME
446
447
448
449
450
451
452
453
454	</h4>
455
456	<div class="comments">
457	The user name to be associated with the widget.
458	</div>
459
460	<h4 id="_cw_droplist_pm_keyword_ROW">ROW
461
462
463
464
465
466
467
468
469	</h4>
470
471	<div class="comments">
472	Buttons will be arranged in the number of rows
473	specified by this keyword.
474	</div>
475
476	<h4 id="_cw_droplist_pm_keyword_COLUMN">COLUMN
477
478
479
480
481
482
483
484
485	</h4>
486
487	<div class="comments">
488	Buttons will be arranged in the number of columns
489	specified by this keyword.
490	</div>
491
492	<h4 id="_cw_droplist_pm_keyword__extra">_extra
493
494
495
496
497
498
499
500
501	</h4>
502
503	<div class="comments">
504	Used to pass your keywords
505	</div>
506
507
508
509	<h3>Examples</h3><div class="preformat">
510	See the program provided above (testwid and the associated procedure, testwid_event).
511	</div>
512	<h3>Version history</h3>
513
514	<h4>Version</h4><div class="preformat">
515	$Id: cw_droplist_pm.pro 157 2006-08-21 09:01:50Z navarro $
516	</div>
517	<h4>History</h4><div class="preformat">
518	Sebastien Masson (smasson@lodyc.jussieu.fr)
519	6/9/1999
520	</div>
521
522
523	<h3>Known issues</h3>
524
525
526
527	<h4>Restrictions</h4><div class="preformat">
528
529	Widget Events Returned by Droplist Widgets
530
531	Pressing the mouse button while the mouse cursor is over an
532	element of a droplist widget causes the widget to change the label
533	on the droplist button and to generate an event. The appearance of
534	any previously selected element is restored to normal at the same
535	time. The event structure returned by the WIDGET_EVENT function is
536	defined by the following statement:
537
538	{ CW_DROPLIST_PM, ID:0L, TOP:0L, HANDLER:0L, INDEX:0L, OUT:0 }
539
540	The first three fields are the standard fields found in every
541	widget event.
542	INDEX returns the index of the selected item. This can be used to
543	index the array of names originally used to set the widget''s
544	value
545	OUT:It is an integer which can take 3 values:
546	1 : If we press + when the index is already at the max
547	Comment: In this case, the index stay at the max
548	-1: If we press - when the index is already at the min
549	Comment: In this case, the index stay at the min
550	0 : In other cases
551
552	Keywords to WIDGET_CONTROL
553
554	A number of keywords to the WIDGET_CONTROL procedure affect the
555	behavior of cw_slider_pm widget: GET_VALUE and SET_VALUE.
556	1) GET_VALUE
557	widget_control,wid_id,get_value=resultat
558	Send back, in the result variable, a structure of 3 elements whose
559	names are inspired by keywords we can pass at widget_control when
560	we use WIDGET_COMBOBOX:
561	DROPLIST_NUMBER: the number of elements currently
562	contained in the specified droplist widget.
563	DROPLIST_SELECT: the zero-based number of the
564	currently-selected element (i.e., the currently-displayed
565	element) in the specified droplist widget.
566	DYNAMIC_RESIZE: a True value (1) if the widget specified
567	by Widget_ID is a button, droplist, or label widget that
568	has had its DYNAMIC_RESIZE attribute set. Otherwise,
569	False (0) is returned.
570	2) SET_VALUE
571	widget_control,wid_id,set_value=impose
572	permet de modifier l''etat de la droplist comme on peut le faire
573	pour WIDGET_DROPLIST Impose peut etre:
574	a) The contents of the list widget (string or string array)
575	b) A structure which can have for elements (from 1 to 3):
576	DYNAMIC_RESIZE:Set this keyword to activate (if set to 1)
577	or deactivate (if set to 0) dynamic resizing of the
578	specified CW_DROPLIST_PM widget (see the documentation
579	for the DYNAMIC_RESIZE keyword to WIDGET_DROPLIST
580	procedure for more information about dynamic widget
581	resizing).
582	DROPLIST_SELECT:Set this keyword to return the zero-based
583	number of the currently-selected element (i.e., the
584	currently-displayed element) in the specified droplist
585	widget.
586	VALUE: The contents of the list widget (string or string
587	array)
588	</div>
589
590
591
592
593
594
595
596
597
598	<h3>Statistics</h3>
599	<table class="statistics">
600	<tr><td>McCabe cyclic</td><td> 6</td></tr>
601	<tr><td>McCabe essential</td><td> 1</td></tr>
602	<tr><td>McCabe modular design</td><td> 1</td></tr>
603	</table>
604
605
606	</div>
607
608	</div>
609
610
611
612	<div id="tagline">Produced by IDLdoc 2.0.</div>
613
614	</div>
615
616	</body>
617	</html>

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

Download in other formats: