Context Navigation

source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/WIDGET/COMPOUND_WIDGET/cw_bgroup.html @ 157

Last change on this file since 157 was 157, checked in by navarro, 18 years ago
header improvements + xxx doc
File size: 32.5 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_bgroup.pro (SAXO Documentation)</title>
10
11
12	<style type="text/css" media="all">
13
14	/* CSS for all files which appear in the "main" viewing area: overview,
15	directory overviews, warnings, index, search, pro files, source
16	code, help, and etc files. */
17
18	/* Link styles --------------------------------------------------------------- */
19
20	a { text-decoration: none; }
21
22	a:link, a:visited {
23	color: #660000;
24	border-bottom: 1px dotted #C0C0F0;
25	}
26
27	a:hover, a:focus {
28	color: #993333;
29	background: #FFFFCC;
30	border-bottom: 1px dotted #303099;
31	}
32
33
34	/* Main styles --------------------------------------------------------------- */
35	p.preformat {
36	font-family: Courier;
37	}
38
39	body {
40	margin: 0;
41	padding: 0;
42	font-size: 10pt;
43	font-family: Verdana, Helvetica, Arial, sans-serif;
44	background-color: #FFFFFF;
45	}
46
47	p {
48	margin-top: 0.5em;
49	margin-bottom: 0;
50	}
51
52	#container { margin: 1em; }
53
54	code.section { white-space: pre; }
55
56	pre.snippet {
57	margin-left: 5%;
58	background: #F0F0F0;
59	border: 1px dashed #999999;
60	width: 43em;
61	padding: 0.5em 0.5em 0.5em 0.5em;
62	white-space: pre;
63	}
64
65	/* Navbar styles ------------------------------------------------------------- */
66
67	#navbar_title {
68	color: #000033;
69	background-color: #F0F0FF;
70	font-family: Arial, Helvetica, sans-serif;
71	padding: 20px 30px;
72	border-bottom: 1px solid #000033;
73	}
74
75	#navbar_title * {
76	margin: 0;
77	padding: 0;
78	}
79
80	#navbar_title h1 {
81	letter-spacing: 0.1em;
82	font-variant: small-caps;
83	font-size: 250%;
84	text-indent: -1em;
85	padding-left: 1em;
86	}
87
88	#navbar_title h2 {
89	font-size: 110%;
90	font-weight: normal;
91	color: #333399;
92	}
93
94	#main_navbar table {
95	width: 100%;
96	border-bottom: 1px solid #666699;
97	}
98
99	#main_navbar td {
100	background: #CCCCFF;
101	font-size: 80%;
102	font-weight: bold;
103	font-family: Arial, Helvetica, sans-serif;
104	border-top: 3px solid #CCCCFF;
105	border-bottom: 3px solid #CCCCFF;
106	padding-left: 6px;
107	padding-right: 6px;
108	margin: 0;
109	}
110
111	#main_navbar td#selected {
112	background: #CCCCFF;
113	font-size: 80%;
114	font-weight: bold;
115	font-family: Arial, Helvetica, sans-serif;
116	border-top: 3px solid #333399;
117	border-bottom: 3px solid #CCCCFF;
118	padding-left: 6px;
119	padding-right: 6px;
120	margin: 0;
121	}
122
123	#main_navbar td#flexible {
124	width: 100%;
125	text-align: right;
126	padding-right: 1em;
127	background: #CCCCFF;
128	font-size: 70%;
129	font-weight: normal;
130	font-family: Arial, Helvetica, sans-serif;
131	text-transform: uppercase;
132	border-top: 3px solid #CCCCFF;
133	border-bottom: 3px solid #CCCCFF;
134	}
135
136	#main_navbar a:link, #main_navbar a:visited { color: #660000; border: 0; }
137
138	#main_navbar a:hover, #main_navbar a:focus {
139	color: #FFFF66;
140	background: #CCCCFF;
141	border-bottom: 1px none #606099;
142	border: 0;
143	}
144
145	#secondary_navbar {
146	font-size: 80%;
147	font-weight: normal;
148	font-family: Arial, Helvetica, sans-serif;
149	margin-top: 4px;
150	margin-left: 20px;
151	white-space: nowrap;
152	}
153
154
155	/* Tagline and footer styles ------------------------------------------------- */
156
157	div#tagline {
158	margin-top: 6px;
159	border-top: 1px dotted lightsteelblue;
160	padding-top: 6px;
161	font-size: 66%;
162	font-style: italic;
163	}
164
165	div#footer {
166	margin-top: 6px;
167	border-top: 1px dotted lightsteelblue;
168	padding-top: 6px;
169	font-size: 66%;
170	font-style: italic;
171	}
172
173	/* Basic data presenation styles -------------------------------------------- */
174
175	.index_letter {
176	font-size: 300%;
177	font-weight: bold;
178	color: #000066;
179	margin: 0.5em 0 0 -0.1em;
180	}
181
182	h1, h2, h3, h4 {
183	font-weight: normal;
184	color: #3333CC;
185	}
186
187	h1 {
188	padding-top: 0.75em;
189	font-size: 160%;
190	}
191
192	h2 {
193	padding-top: 1em;
194	font-size: 120%;
195	}
196
197	h3 {
198	padding-top: 0.75em;
199	margin-bottom: 0.25em;
200	font-size: 100%;
201	}
202
203	h4 {
204	padding: 0;
205	margin: 0.5em 0 0 0;
206	font-size: 80%;
207	}
208
209	table.basic {
210	empty-cells: show;
211	margin: 1.5em 1em 0 1em;
212	border: 1px dotted #CFCFFF;
213	font-size: 80%;
214	}
215
216	table.basic th {
217	background-color: #F0F0FF;
218	font-weight: bold;
219	text-align: left;
220	padding: 4px 1em 4px 4px;
221	border-bottom: 1px dotted #666699;
222	}
223
224	table.basic td {
225	vertical-align: top;
226	padding: 4px 1em 4px 4px;
227	}
228
229	dd {
230	margin-bottom: 0.25em;
231	font-size: 80%;
232	}
233
234
235	/* Warnings styles ----------------------------------------------------------- */
236
237
238	#todo dl, #bugs dl {
239	margin: 0 0 0 1.5em;
240	font-size: 80%;
241	}
242
243	#todo dd, #bugs dd {
244	margin-left: 3em;
245	font-size: 100%;
246	}
247
248	#undoc table, #obsolete table, #statistics table {
249	width: 80%;
250	margin-left: 2em;
251	}
252
253	#undoc td, #obsolete td, #statistics td {
254	padding: 0 0 0 0;
255	font-size: 80%;
256	white-space: nowrap;
257	}
258
259	#undoc td.docroutine, #obsolete td.obsroutine, #statistics td.statroutine { width: 50%; }
260
261	#undoc td.docstat, #statistics td.stat {
262	width: 50%;
263	text-align: right;
264	}
265
266	#undoc td.partialdoc, #statistics td.caution { color: #CC6600; }
267
268	#undoc td.notdoc, #statistics td.warning { color: #993333; }
269
270	/* File + routine styles ----------------------------------------------------- */
271
272	h1.directory {
273	padding: 1em 0 0 0;
274	margin: 0;
275	font-size: 66%;
276	}
277
278	h1.directory a { border-bottom: 0; }
279
280	h2.pro_file {
281	padding: 0;
282	margin: 0;
283	font-size: 140%;
284	}
285
286	div#file_attr {
287	padding: 0 1em 0 1em;
288	margin: 1em;
289	background: #F6F6F6;
290	border: 1px dotted #999999;
291	}
292
293	div#file_attr dt {
294	font-size: 80%;
295	font-weight: bold;
296	}
297
298	div#file_attr dd {
299	font-size: 80%;
300	}
301
302	div#class_diagram {
303	padding: 1em 0 1em 0;
304	white-space: pre;
305	font-family: 'Courier New';
306	}
307
308	table#sav_attr {
309	font-size: 90%;
310	margin: 1em;
311	padding: 1em 1em 1em 1em;
312	background: #F6F6F6;
313	border: 1px dotted #999999;
314	}
315
316	table#sav_attr th { text-align: left; }
317
318	table#sav_attr td { vertical-align: top; padding-right: 2em; }
319
320	table#sav_attr td.value { width: 20em; padding-right: 0em; font-style: italic; }
321
322	p.sav_warning { margin-left: 4em; font-family: 80%; }
323
324	table.variables {
325	font-family: 'Courier New', monospace;
326	font-size: 80%;
327	text-indent: -2em;
328	padding-left: 2em;
329	}
330
331	table.variables td.image { width: 64px; }
332
333	div#file_comments { white-space: pre;
334	margin: 2em;
335	font-size: 80%;
336	}
337
338
339	div.field_summary {
340	padding: 0 1em 0 1em;
341	margin: 1em;
342	background: #FFFFF0;
343	border: 1px dotted #C0C000;
344	}
345
346	div#routine_summary {
347	padding: 0 1em 0 1em;
348	margin: 1em;
349	background: #F0F0FF;
350	border: 1px dotted #9999FF;
351	}
352
353	div.field_summary h2, div#routine_summary h2 {
354	padding: 0.5em 0 0 0;
355	margin: 0;
356	}
357
358	div.field_summary table, div.field_summary p {
359	margin: 1em 1em;
360	}
361
362	div.field_summary td.name {
363	vertical-align: top;
364	padding-bottom: 0.25em;
365	color: #3333CC;
366	}
367
368	div.field_summary span.field_type {
369	font-weight: normal;
370	font-size: 80%;
371	color: black;
372	}
373
374	div.field_summary td.comments {
375	vertical-align: top;
376	padding-left: 2em;
377	font-size: 80%;
378	}
379
380	p.commaList {
381	margin: 1em 1em 1em 1em;
382	}
383
384	span.warning {
385	color: #CC6633;
386	font-weight: bold;
387	font-size: 66%;
388	text-transform: uppercase;
389	}
390
391	span.categories {
392	color: #006633;
393	font-weight: bold;
394	font-size: 66%;
395	text-transform: uppercase;
396	}
397
398	span.undoc {
399	color: #FF6633;
400	font-weight: bold;
401	font-size: 80%;
402	text-transform: uppercase;
403	}
404
405	span.attr {
406	color: #006633;
407	font-weight: bold;
408	font-size: 80%;
409	text-transform: uppercase;
410	}
411
412	span.value {
413	color: #006633;
414	font-weight: normal;
415	text-transform: none;
416	}
417
418	a.top {
419	font-weight: bold;
420	font-size: 66%;
421	text-transform: uppercase;
422	float: right;
423	}
424
425	span.result {
426	font-family: Verdana, Arial, Helvetica, sans-serif;
427	font-style: italic;
428	font-size: 80%;
429	}
430
431	div#routine_summary p, div.routine_details p.header {
432	padding-top: 0.5em;
433	margin-left: 1.5em;
434	text-indent: -1.5em;
435	font-family: 'Courier New', monospace;
436	}
437
438	div.routine_details {
439	padding: 0.5em 1em 0.5em 1em;
440	margin: 1em;
441	border: 1px dotted #CCCCCC;
442	}
443
444	div.routine_details h2 {
445	padding-top: 0;
446	margin-top: 0;
447	}
448
449	div.routine_details div.value {
450	margin: 0 1em 0 1em;
451	font-size: 80%;
452	}
453
454	div.routine_details div.comments {
455	font-size: 80%;
456	margin: 0.75em 1em 1em 1em;
457	}
458
459	div.routine_details div.preformat {
460	white-space: pre;
461	}
462
463	table.statistics {
464	font-size: 80%;
465	margin-left: 1em;
466	}
467
468	table.statistics td {
469	padding: 0 2em 0 0;
470	}
471
472	/* Overview styles ----------------------------------------------------------- */
473
474	div.overview {
475	width: 100%;
476	margin-top: 1em;
477	clear: both;
478	}
479
480	div.overview table {
481	empty-cells: show;
482	font-size: 90%;
483	margin: 1em 1em 1em 1em;
484	padding: 1em 0.5em 1em 0.5em;
485	background: #F6F6F6;
486	border: 1px dotted #999999;
487	}
488
489	div.overview td {
490	padding: 3px 1em 3px 1em;
491	}
492
493	div.overview td.dir {
494	width: 1%;
495	vertical-align: top;
496	text-align: right;
497	padding-right: 1em;
498	}
499
500
501	/* Navigation list styles for tree structures -------------------------------- */
502
503	#tree {
504	text-align: left;
505	font-size: 90%;
506	margin: 0.75em 0 0.75em 0;
507	padding: 0;
508	}
509
510	#tree ul {
511	text-align: left;
512	margin: 0;
513	padding: 0;
514	}
515
516	#tree li {
517	margin: 0 0 0 15px;
518	padding: 0;
519	list-style-type: none;
520	}
521
522	#tree .symbols {
523	float: left;
524	width: 12px;
525	height: 1em;
526	padding-left: 4px;
527	background-position: 0 100%;
528	background-repeat: no-repeat;
529	}
530
531	/* Search styles ------------------------------------------------------------- */
532
533	input.writein {
534	padding-left: 0.5em;
535	border: 1px solid #CCCCCC;
536	font-family: 'Courier New';
537	background: #FFFFF3;
538	}
539
540	#search form {
541	margin-left: 2em;
542	}
543
544	#search table {
545	margin: 1em 1em 0 2em;
546	padding: 1em 2em 1em 2em;
547	background: #F6F6F6;
548	border: 1px dotted #999999;
549	}
550
551	#search tr {
552	text-align: center;
553	}
554
555	#search td {
556	font-size: 80%;
557	text-align: left;
558	}
559
560	#search td * {
561	vertical-align: middle;
562	}
563
564	#search p {
565	font-size: 66%;
566	margin: 0 3em 2em 3em;
567	}
568
569	/* Help styles --------------------------------------------------------------- */
570
571	div.toc {
572	padding: 0 1em 0 1em;
573	margin: 1em;
574	background: #F0F0FF;
575	border: 1px dotted #9999FF;
576	width: 19em;
577	}
578
579	div.right {
580	float: right;
581	width: 22em;
582	}
583
584	ol.toc {
585	list-style-type: upper-roman;
586	}
587
588	ol.toc ol {
589	padding-left: 3em;
590	margin-left: 0;
591	list-style-type: lower-alpha;
592	}
593
594	dl.variables dt { font-size: 80%; }
595	dl.variables dd { margin-bottom: 0.5em; }
596
597	</style>
598	<style type="text/css" media="print">
599	#navbar_title {
600	background-color: #FFFFFF;
601	}
602
603	#main_navbar td {
604	background: #FFFFFF;
605	border-top: 0.25em solid #FFFFFF;
606	border-bottom: 0.25em solid #FFFFFF;
607	}
608
609	#main_navbar td#selected {
610	background: #FFFFFF;
611	border-top: 0.25em solid #333399;
612	border-bottom: 0.25em solid #FFFFFF;
613	}
614
615	#main_navbar td#flexible {
616	background: #FFFFFF;
617	border-top: 0.25em solid #FFFFFF;
618	border-bottom: 0.25em solid #FFFFFF;
619	}
620
621	#secondary_navbar {
622	display: none;
623	}
624
625	</style>
626
627
628	<script type="text/javascript">
629	function setTitle() {
630	parent.document.title="cw_bgroup.pro (SAXO Documentation)";
631	}
632	</script>
633	</head>
634
635	<body onload="setTitle();">
636
637	<div id="navbar_title">
638	<h1>SAXO Documentation</h1>
639	</div>
640
641
642	<div id="main_navbar">
643
644	<table cellspacing="0">
645	<tr>
646
647	<td><a href="./../../../overview.html?format=raw" title="Overview of library">Overview</a></td>
648
649
650
651	<td >Directory</td>
652
653
654
655	<td><a href="./../../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
656
657
658
659	<td><a href="./../../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
660
661
662
663	<td><a href="./../../../search-page.html?format=raw" title="Search library">Search</a></td>
664
665
666	<td id="selected">File</td>
667
668
669	<td >Source</td>
670
671
672
673	<td><a href="./../../../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td>
674
675
676	<td >Etc</td>
677
678	<td id="flexible">Developer documentation</td>
679	</tr>
680	</table>
681
682	</div>
683
684	<div id="secondary_navbar">
685
686	<< prev file \| <a href="cw_calendar.html?format=raw">next file >></a>    <a href="cw_bgroup.html?format=raw" target="_TOP">view single page</a> \| <a href="./../../../index.html?format=raw" target="_TOP">view frames</a>    summary: fields \| <a href="#routine_summary">routine</a>    details: <a href="#routine_details">routine</a>
687
688	</div>
689
690
691	<div id="container">
692
693	<h1 class="directory"><a href="directory-overview.html?format=raw">ToBeReviewed/WIDGET/COMPOUND_WIDGET/</a></h1>
694	<h2 class="pro_file">cw_bgroup.pro</h2>
695
696	<div id="file_attr">
697	<dl>
698	</dl>
699	</div>
700
701	<div id="file_comments">
702
703
704
705	Compound widget
706
707
708	Compound widget
709
710
711	CW_BGROUP is a compound widget that simplifies creating
712	a base of buttons. It handles the details of creating the
713	proper base (standard, exclusive, or non-exclusive) and filling
714	in the desired buttons. Events for the individual buttons are
715	handled transparently, and a CW_BGROUP event returned. This
716	event can return any one of the following:
717	- The Index of the button within the base.
718	- The widget ID of the button.
719	- The name of the button.
720	- An arbitrary value taken from an array of User values.
721	</div>
722
723
724
725
726
727
728
729
730	<div id="routine_summary">
731	<h2>Routine summary</h2>
732
733	<dl>
734
735	<dt><p><a href="#_CW_BGROUP_SETV">CW_BGROUP_SETV<span class="result">, id, value</span></a></p><dt>
736	<dd></dd>
737
738	<dt><p><a href="#_CW_BGROUP_GETV"><span class="result">result = </span>CW_BGROUP_GETV(<span class="result">id, value</span>)</a></p><dt>
739	<dd></dd>
740
741	<dt><p><a href="#_CW_BGROUP_EVENT"><span class="result">result = </span>CW_BGROUP_EVENT(<span class="result">ev</span>)</a></p><dt>
742	<dd></dd>
743
744	<dt><p><a href="#_CW_BGROUP"><span class="result">result = </span>CW_BGROUP(<span class="result">parent, names</span>, BUTTON_UVALUE=<span class="result">BUTTON_UVALUE</span>, COLUMN=<span class="result">COLUMN</span>, EVENT_FUNCT=<span class="result">EVENT_FUNCT</span>, EXCLUSIVE=<span class="result">EXCLUSIVE</span>, FONT=<span class="result">FONT</span>, FRAME=<span class="result">FRAME</span>, IDS=<span class="result">IDS</span>, LABEL_TOP=<span class="result">LABEL_TOP</span>, LABEL_LEFT=<span class="result">LABEL_LEFT</span>, MAP=<span class="result">MAP</span>, NONEXCLUSIVE=<span class="result">NONEXCLUSIVE</span>, NO_RELEASE=<span class="result">NO_RELEASE</span>, RETURN_ID=<span class="result">RETURN_ID</span>, RETURN_INDEX=<span class="result">RETURN_INDEX</span>, RETURN_NAME=<span class="result">RETURN_NAME</span>, ROW=<span class="result">ROW</span>, SCROLL=<span class="result">SCROLL</span>, SET_VALUE=<span class="result">SET_VALUE</span>, SPACE=<span class="result">SPACE</span>, TAB_MODE=<span class="result">TAB_MODE</span>, UVALUE=<span class="result">UVALUE</span>, XOFFSET=<span class="result">XOFFSET</span>, XPAD=<span class="result">XPAD</span>, XSIZE=<span class="result">XSIZE</span>, X_SCROLL_SIZE=<span class="result">X_SCROLL_SIZE</span>, YOFFSET=<span class="result">YOFFSET</span>, YPAD=<span class="result">YPAD</span>, YSIZE=<span class="result">YSIZE</span>, Y_SCROLL_SIZE=<span class="result">Y_SCROLL_SIZE</span>, UNAME=<span class="result">UNAME</span>)</a></p><dt>
745	<dd></dd>
746
747	</dl>
748	</div>
749
750
751	<div id="routine_details">
752
753
754	<div class="routine_details" id="_CW_BGROUP_SETV">
755
756	<h2><a class="top" href="#container">top</a>CW_BGROUP_SETV <span class="categories">
757	Compound widget
758	</span></h2>
759
760	<p class="header">
761	CW_BGROUP_SETV<span class="result">, <a href="#_CW_BGROUP_SETV_param_id">id</a>, <a href="#_CW_BGROUP_SETV_param_value">value</a></span></p>
762
763	<div class="comments"></div>
764
765	<h3>Return value</h3><div class="preformat">
766
767	</div>
768
769
770	<h3>Parameters</h3>
771
772
773	<h4 id="_CW_BGROUP_SETV_param_id">id
774
775
776
777
778
779
780
781
782	</h4>
783
784	<div class="comments">
785
786	</div>
787
788	<h4 id="_CW_BGROUP_SETV_param_value">value
789
790
791
792
793
794
795
796
797	</h4>
798
799	<div class="comments">
800	It is the default tick mark value (a floating-point number).
801	</div>
802
803
804
805
806
807
808	<h3>Examples</h3><div class="preformat">
809
810	</div>
811	<h3>Version history</h3>
812
813	<h4>Version</h4><div class="preformat">
814	$Id$</div>
815	<h4>History</h4><div class="preformat">
816
817	</div>
818
819
820	<h3>Known issues</h3>
821
822
823
824	<h4>Restrictions</h4><div class="preformat">
825
826	</div>
827
828	<h3>Other attributes</h3>
829
830
831	<h4>Uses routines</h4><div class="preformat">
832
833	</div>
834
835
836
837
838
839
840	</div>
841
842
843	<div class="routine_details" id="_CW_BGROUP_GETV">
844
845	<h2><a class="top" href="#container">top</a>CW_BGROUP_GETV <span class="categories">
846
847	</span></h2>
848
849	<p class="header">
850	<span class="result">result = </span>CW_BGROUP_GETV(<span class="result"><a href="#_CW_BGROUP_GETV_param_id">id</a>, <a href="#_CW_BGROUP_GETV_param_value">value</a></span>)</p>
851
852	<div class="comments"></div>
853
854	<h3>Return value</h3><div class="preformat">
855
856	</div>
857
858
859	<h3>Parameters</h3>
860
861
862	<h4 id="_CW_BGROUP_GETV_param_id">id
863
864
865
866
867
868
869
870
871	</h4>
872
873	<div class="comments">
874
875	</div>
876
877	<h4 id="_CW_BGROUP_GETV_param_value">value
878
879
880
881
882
883
884
885
886	</h4>
887
888	<div class="comments">
889	It is the default tick mark value (a floating-point number).
890	</div>
891
892
893
894
895
896
897	<h3>Examples</h3><div class="preformat">
898
899	</div>
900	<h3>Version history</h3>
901
902	<h4>Version</h4><div class="preformat">
903	$Id$</div>
904	<h4>History</h4><div class="preformat">
905
906	</div>
907
908
909	<h3>Known issues</h3>
910
911
912
913	<h4>Restrictions</h4><div class="preformat">
914
915	</div>
916
917	<h3>Other attributes</h3>
918
919
920	<h4>Uses routines</h4><div class="preformat">
921
922	</div>
923
924
925
926
927
928
929	</div>
930
931
932	<div class="routine_details" id="_CW_BGROUP_EVENT">
933
934	<h2><a class="top" href="#container">top</a>CW_BGROUP_EVENT <span class="categories">
935
936	</span></h2>
937
938	<p class="header">
939	<span class="result">result = </span>CW_BGROUP_EVENT(<span class="result"><a href="#_CW_BGROUP_EVENT_param_ev">ev</a></span>)</p>
940
941	<div class="comments"></div>
942
943	<h3>Return value</h3><div class="preformat">
944
945	</div>
946
947
948	<h3>Parameters</h3>
949
950
951	<h4 id="_CW_BGROUP_EVENT_param_ev">ev
952
953
954
955
956
957
958
959
960	</h4>
961
962	<div class="comments">
963
964	</div>
965
966
967
968
969
970
971	<h3>Examples</h3><div class="preformat">
972
973	</div>
974	<h3>Version history</h3>
975
976	<h4>Version</h4><div class="preformat">
977	$Id$</div>
978	<h4>History</h4><div class="preformat">
979
980	</div>
981
982
983	<h3>Known issues</h3>
984
985
986
987	<h4>Restrictions</h4><div class="preformat">
988
989	</div>
990
991	<h3>Other attributes</h3>
992
993
994	<h4>Uses routines</h4><div class="preformat">
995
996	</div>
997
998
999
1000
1001
1002
1003	</div>
1004
1005
1006	<div class="routine_details" id="_CW_BGROUP">
1007
1008	<h2><a class="top" href="#container">top</a>CW_BGROUP <span class="categories">
1009	Compound widget
1010	</span></h2>
1011
1012	<p class="header">
1013	<span class="result">result = </span>CW_BGROUP(<span class="result"><a href="#_CW_BGROUP_param_parent">parent</a>, <a href="#_CW_BGROUP_param_names">names</a></span>, <a href="#_CW_BGROUP_keyword_BUTTON_UVALUE">BUTTON_UVALUE</a>=<span class="result">BUTTON_UVALUE</span>, <a href="#_CW_BGROUP_keyword_COLUMN">COLUMN</a>=<span class="result">COLUMN</span>, <a href="#_CW_BGROUP_keyword_EVENT_FUNCT">EVENT_FUNCT</a>=<span class="result">EVENT_FUNCT</span>, <a href="#_CW_BGROUP_keyword_EXCLUSIVE">EXCLUSIVE</a>=<span class="result">EXCLUSIVE</span>, <a href="#_CW_BGROUP_keyword_FONT">FONT</a>=<span class="result">FONT</span>, <a href="#_CW_BGROUP_keyword_FRAME">FRAME</a>=<span class="result">FRAME</span>, <a href="#_CW_BGROUP_keyword_IDS">IDS</a>=<span class="result">IDS</span>, <a href="#_CW_BGROUP_keyword_LABEL_TOP">LABEL_TOP</a>=<span class="result">LABEL_TOP</span>, <a href="#_CW_BGROUP_keyword_LABEL_LEFT">LABEL_LEFT</a>=<span class="result">LABEL_LEFT</span>, <a href="#_CW_BGROUP_keyword_MAP">MAP</a>=<span class="result">MAP</span>, <a href="#_CW_BGROUP_keyword_NONEXCLUSIVE">NONEXCLUSIVE</a>=<span class="result">NONEXCLUSIVE</span>, <a href="#_CW_BGROUP_keyword_NO_RELEASE">NO_RELEASE</a>=<span class="result">NO_RELEASE</span>, <a href="#_CW_BGROUP_keyword_RETURN_ID">RETURN_ID</a>=<span class="result">RETURN_ID</span>, <a href="#_CW_BGROUP_keyword_RETURN_INDEX">RETURN_INDEX</a>=<span class="result">RETURN_INDEX</span>, <a href="#_CW_BGROUP_keyword_RETURN_NAME">RETURN_NAME</a>=<span class="result">RETURN_NAME</span>, <a href="#_CW_BGROUP_keyword_ROW">ROW</a>=<span class="result">ROW</span>, <a href="#_CW_BGROUP_keyword_SCROLL">SCROLL</a>=<span class="result">SCROLL</span>, <a href="#_CW_BGROUP_keyword_SET_VALUE">SET_VALUE</a>=<span class="result">SET_VALUE</span>, <a href="#_CW_BGROUP_keyword_SPACE">SPACE</a>=<span class="result">SPACE</span>, <a href="#_CW_BGROUP_keyword_TAB_MODE">TAB_MODE</a>=<span class="result">TAB_MODE</span>, <a href="#_CW_BGROUP_keyword_UVALUE">UVALUE</a>=<span class="result">UVALUE</span>, <a href="#_CW_BGROUP_keyword_XOFFSET">XOFFSET</a>=<span class="result">XOFFSET</span>, <a href="#_CW_BGROUP_keyword_XPAD">XPAD</a>=<span class="result">XPAD</span>, <a href="#_CW_BGROUP_keyword_XSIZE">XSIZE</a>=<span class="result">XSIZE</span>, <a href="#_CW_BGROUP_keyword_X_SCROLL_SIZE">X_SCROLL_SIZE</a>=<span class="result">X_SCROLL_SIZE</span>, <a href="#_CW_BGROUP_keyword_YOFFSET">YOFFSET</a>=<span class="result">YOFFSET</span>, <a href="#_CW_BGROUP_keyword_YPAD">YPAD</a>=<span class="result">YPAD</span>, <a href="#_CW_BGROUP_keyword_YSIZE">YSIZE</a>=<span class="result">YSIZE</span>, <a href="#_CW_BGROUP_keyword_Y_SCROLL_SIZE">Y_SCROLL_SIZE</a>=<span class="result">Y_SCROLL_SIZE</span>, <a href="#_CW_BGROUP_keyword_UNAME">UNAME</a>=<span class="result">UNAME</span>)</p>
1014
1015	<div class="comments"></div>
1016
1017	<h3>Return value</h3><div class="preformat">
1018	The ID of the created widget is returned.
1019	</div>
1020
1021
1022	<h3>Parameters</h3>
1023
1024
1025	<h4 id="_CW_BGROUP_param_parent">parent
1026	<span class="attr">in</span>
1027
1028
1029	<span class="attr">required</span>
1030
1031
1032
1033
1034	</h4>
1035
1036	<div class="comments">
1037	The ID of the parent widget.
1038	</div>
1039
1040	<h4 id="_CW_BGROUP_param_names">names
1041
1042
1043
1044
1045
1046
1047
1048
1049	</h4>
1050
1051	<div class="comments">
1052	A string array, containing one string per button,
1053	giving the name of each button.
1054	</div>
1055
1056
1057
1058
1059
1060
1061	<h3>Keywords</h3>
1062
1063	<h4 id="_CW_BGROUP_keyword_BUTTON_UVALUE">BUTTON_UVALUE
1064
1065
1066
1067
1068
1069
1070
1071
1072	</h4>
1073
1074	<div class="comments">
1075	An array of user values to be associated with
1076	each button and returned in the event structure.
1077	</div>
1078
1079	<h4 id="_CW_BGROUP_keyword_COLUMN">COLUMN
1080
1081
1082
1083
1084
1085
1086
1087
1088	</h4>
1089
1090	<div class="comments">
1091	Buttons will be arranged in the number of columns
1092	specified by this keyword.
1093	</div>
1094
1095	<h4 id="_CW_BGROUP_keyword_EVENT_FUNCT">EVENT_FUNCT
1096
1097
1098
1099
1100
1101
1102
1103
1104	</h4>
1105
1106	<div class="comments">
1107	The name of an optional user-supplied event function
1108	for buttons. This function is called with the return
1109	value structure whenever a button is pressed, and
1110	follows the conventions for user-written event functions.
1111	</div>
1112
1113	<h4 id="_CW_BGROUP_keyword_EXCLUSIVE">EXCLUSIVE
1114
1115
1116
1117
1118
1119
1120
1121
1122	</h4>
1123
1124	<div class="comments">
1125	Buttons will be placed in an exclusive base, with
1126	only one button allowed to be selected at a time.
1127	</div>
1128
1129	<h4 id="_CW_BGROUP_keyword_FONT">FONT
1130
1131
1132
1133
1134
1135
1136
1137
1138	</h4>
1139
1140	<div class="comments">
1141	The name of the font to be used for the button
1142	titles. If this keyword is not specified, the default
1143	font is used.
1144	</div>
1145
1146	<h4 id="_CW_BGROUP_keyword_FRAME">FRAME
1147
1148
1149
1150
1151
1152
1153
1154
1155	</h4>
1156
1157	<div class="comments">
1158	Specifies the width of the frame to be drawn around the base.
1159	</div>
1160
1161	<h4 id="_CW_BGROUP_keyword_IDS">IDS
1162
1163
1164
1165
1166
1167
1168
1169
1170	</h4>
1171
1172	<div class="comments">
1173	A named variable into which the button IDs will be
1174	stored, as a longword vector.
1175	</div>
1176
1177	<h4 id="_CW_BGROUP_keyword_LABEL_TOP">LABEL_TOP
1178
1179
1180
1181
1182
1183
1184
1185
1186	</h4>
1187
1188	<div class="comments">
1189	Creates a text label above the buttons.
1190	</div>
1191
1192	<h4 id="_CW_BGROUP_keyword_LABEL_LEFT">LABEL_LEFT
1193
1194
1195
1196
1197
1198
1199
1200
1201	</h4>
1202
1203	<div class="comments">
1204	Creates a text label to the left of the buttons.
1205	</div>
1206
1207	<h4 id="_CW_BGROUP_keyword_MAP">MAP
1208
1209
1210
1211
1212
1213
1214
1215
1216	</h4>
1217
1218	<div class="comments">
1219	If set, the base will be mapped when the widget
1220	is realized (the default).
1221	</div>
1222
1223	<h4 id="_CW_BGROUP_keyword_NONEXCLUSIVE">NONEXCLUSIVE
1224
1225
1226
1227
1228
1229
1230
1231
1232	</h4>
1233
1234	<div class="comments">
1235	Buttons will be placed in an non-exclusive base.
1236	The buttons will be independent.
1237	</div>
1238
1239	<h4 id="_CW_BGROUP_keyword_NO_RELEASE">NO_RELEASE
1240
1241
1242
1243
1244
1245
1246
1247
1248	</h4>
1249
1250	<div class="comments">
1251	If set, button release events will not be returned.
1252	</div>
1253
1254	<h4 id="_CW_BGROUP_keyword_RETURN_ID">RETURN_ID
1255
1256
1257
1258
1259
1260
1261
1262
1263	</h4>
1264
1265	<div class="comments">
1266	If set, the VALUE field of returned events will be
1267	the widget ID of the button.
1268	</div>
1269
1270	<h4 id="_CW_BGROUP_keyword_RETURN_INDEX">RETURN_INDEX
1271
1272
1273
1274
1275
1276
1277
1278
1279	</h4>
1280
1281	<div class="comments">
1282	If set, the VALUE field of returned events will be
1283	the zero-based index of the button within the base.
1284	THIS IS THE DEFAULT.
1285	</div>
1286
1287	<h4 id="_CW_BGROUP_keyword_RETURN_NAME">RETURN_NAME
1288
1289
1290
1291
1292
1293
1294
1295
1296	</h4>
1297
1298	<div class="comments">
1299	If set, the VALUE field of returned events will be
1300	the name of the button within the base.
1301	</div>
1302
1303	<h4 id="_CW_BGROUP_keyword_ROW">ROW
1304
1305
1306
1307
1308
1309
1310
1311
1312	</h4>
1313
1314	<div class="comments">
1315	Buttons will be arranged in the number of rows
1316	specified by this keyword.
1317	</div>
1318
1319	<h4 id="_CW_BGROUP_keyword_SCROLL">SCROLL
1320
1321
1322
1323
1324
1325
1326
1327
1328	</h4>
1329
1330	<div class="comments">
1331	If set, the base will include scroll bars to allow
1332	viewing a large base through a smaller viewport.
1333	</div>
1334
1335	<h4 id="_CW_BGROUP_keyword_SET_VALUE">SET_VALUE
1336
1337
1338
1339
1340
1341
1342
1343
1344	</h4>
1345
1346	<div class="comments">
1347	The initial value of the buttons. This is equivalent
1348	to the later statement:
1349
1350	WIDGET_CONTROL, widget, set_value=value
1351	</div>
1352
1353	<h4 id="_CW_BGROUP_keyword_SPACE">SPACE
1354
1355
1356
1357
1358
1359
1360
1361
1362	</h4>
1363
1364	<div class="comments">
1365	The space, in pixels, to be left around the edges
1366	of a row or column major base. This keyword is
1367	ignored if EXCLUSIVE or NONEXCLUSIVE are specified.
1368	</div>
1369
1370	<h4 id="_CW_BGROUP_keyword_TAB_MODE">TAB_MODE
1371
1372
1373
1374
1375
1376
1377
1378
1379	</h4>
1380
1381	<div class="comments"></div>
1382
1383	<h4 id="_CW_BGROUP_keyword_UVALUE">UVALUE
1384
1385
1386
1387
1388
1389
1390
1391
1392	</h4>
1393
1394	<div class="comments">
1395	The user value to be associated with the widget.
1396	</div>
1397
1398	<h4 id="_CW_BGROUP_keyword_XOFFSET">XOFFSET
1399
1400
1401
1402
1403
1404
1405
1406
1407	</h4>
1408
1409	<div class="comments">
1410	The X offset of the widget relative to its parent.
1411	</div>
1412
1413	<h4 id="_CW_BGROUP_keyword_XPAD">XPAD
1414
1415
1416
1417
1418
1419
1420
1421
1422	</h4>
1423
1424	<div class="comments">
1425	The horizontal space, in pixels, between children
1426	of a row or column major base. Ignored if EXCLUSIVE
1427	or NONEXCLUSIVE are specified.
1428	</div>
1429
1430	<h4 id="_CW_BGROUP_keyword_XSIZE">XSIZE
1431
1432
1433
1434
1435
1436
1437
1438
1439	</h4>
1440
1441	<div class="comments">
1442	The width of the base.</div>
1443
1444	<h4 id="_CW_BGROUP_keyword_X_SCROLL_SIZE">X_SCROLL_SIZE
1445
1446
1447
1448
1449
1450
1451
1452
1453	</h4>
1454
1455	<div class="comments">
1456	The width of the viewport if SCROLL is specified.
1457	</div>
1458
1459	<h4 id="_CW_BGROUP_keyword_YOFFSET">YOFFSET
1460
1461
1462
1463
1464
1465
1466
1467
1468	</h4>
1469
1470	<div class="comments">
1471	The Y offset of the widget relative to its parent.
1472	</div>
1473
1474	<h4 id="_CW_BGROUP_keyword_YPAD">YPAD
1475
1476
1477
1478
1479
1480
1481
1482
1483	</h4>
1484
1485	<div class="comments">
1486	The vertical space, in pixels, between children of
1487	a row or column major base. Ignored if EXCLUSIVE
1488	or NONEXCLUSIVE are specified.
1489	</div>
1490
1491	<h4 id="_CW_BGROUP_keyword_YSIZE">YSIZE
1492
1493
1494
1495
1496
1497
1498
1499
1500	</h4>
1501
1502	<div class="comments">
1503	The height of the base.
1504	</div>
1505
1506	<h4 id="_CW_BGROUP_keyword_Y_SCROLL_SIZE">Y_SCROLL_SIZE
1507
1508
1509
1510
1511
1512
1513
1514
1515	</h4>
1516
1517	<div class="comments">
1518	The height of the viewport if SCROLL is specified.
1519	</div>
1520
1521	<h4 id="_CW_BGROUP_keyword_UNAME">UNAME
1522
1523
1524
1525
1526
1527
1528
1529
1530	</h4>
1531
1532	<div class="comments">
1533	The user name to be associated with the widget.
1534	</div>
1535
1536
1537
1538
1539	<h3>Version history</h3>
1540
1541	<h4>Version</h4><div class="preformat">
1542	$Id: cw_bgroup.pro 150 2006-08-09 10:12:54Z navarro $
1543	</div>
1544	<h4>History</h4><div class="preformat">
1545	15 June 1992, AB
1546	7 April 1993, AB, Removed state caching.
1547	6 Oct. 1994, KDB, Font keyword is not applied to the label.
1548	10 FEB 1995, DJC fixed bad bug in event procedure, getting
1549	id of stash widget.
1550	11 April 1995, AB Removed Motif special cases.
1551
1552	Copyright (c) 1992-2005, Research Systems, Inc. All rights reserved.
1553	Unauthorized reproduction prohibited.
1554	</div>
1555
1556
1557	<h3>Known issues</h3>
1558
1559
1560
1561	<h4>Restrictions</h4><div class="preformat">
1562	This widget generates event structures with the following definition:
1563
1564	event = { ID:0L, TOP:0L, HANDLER:0L, SELECT:0, VALUE:0 }
1565
1566	The SELECT field is passed through from the button event. VALUE is
1567	either the INDEX, ID, NAME, or BUTTON_UVALUE of the button,
1568	depending on how the widget was created.
1569
1570
1571	Only buttons with textual names are handled by this widget.
1572	Bitmaps are not understood.
1573	</div>
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585	</div>
1586
1587	</div>
1588
1589
1590
1591	<div id="tagline">Produced by IDLdoc 2.0.</div>
1592
1593	</div>
1594
1595	</body>
1596	</html>

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

Download in other formats: