Context Navigation

source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/WIDGET/COMPOUND_WIDGET/cw_droplist_pm.html @ 321

Last change on this file since 321 was 321, checked in by smasson, 17 years ago
update documentation
File size: 14.4 KB

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

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

Download in other formats: