Context Navigation

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

Last change on this file since 89 was 89, checked in by pinsard, 18 years ago
add idldoc html output. see Documentation/idldoc_html_output/index.html
File size: 21.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_bgroup.pro (IDLdoc API 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_bgroup.pro (IDLdoc API documentation)";
19	}
20	</script>
21	</head>
22
23	<body onload="setTitle();">
24
25	<div id="navbar_title">
26	<h1>IDLdoc API 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?format=raw" title="Overview of library">Overview</a></td>
36
37
38
39	<td >Directory</td>
40
41
42
43	<td><a href="./../../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44
45
46
47	<td><a href="./../../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48
49
50
51	<td><a href="./../../../search-page.html?format=raw" title="Search library">Search</a></td>
52
53
54	<td id="selected">File</td>
55
56
57	<td >Source</td>
58
59
60
61	<td><a href="./../../../idldoc-help.html?format=raw" 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	<< prev file \| <a href="cw_calendar.html">next file >></a>    <a href="cw_bgroup.html" 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>
75
76	</div>
77
78
79	<div id="container">
80
81	<h1 class="directory"><a href="directory-overview.html?format=raw">ToBeReviewed/WIDGET/COMPOUND_WIDGET/</a></h1>
82	<h2 class="pro_file">cw_bgroup.pro</h2>
83
84	<div id="file_attr">
85	<dl>
86	</dl>
87	</div>
88
89	<div id="file_comments"></div>
90
91
92
93
94
95
96
97
98	<div id="routine_summary">
99	<h2>Routine summary</h2>
100
101	<dl>
102
103	<dt><p><a href="#_CW_BGROUP_SETV">CW_BGROUP_SETV<span class="result">, id, value</span></a></p><dt>
104	<dd> NAME: CW_BGROUP PURPOSE: CW_BGROUP is a compound widget that simplifies creating a base of buttons.</dd>
105
106	<dt><p><a href="#_CW_BGROUP_GETV"><span class="result">result = </span>CW_BGROUP_GETV(<span class="result">id, value</span>)</a></p><dt>
107	<dd></dd>
108
109	<dt><p><a href="#_CW_BGROUP_EVENT"><span class="result">result = </span>CW_BGROUP_EVENT(<span class="result">ev</span>)</a></p><dt>
110	<dd></dd>
111
112	<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>
113	<dd></dd>
114
115	</dl>
116	</div>
117
118
119	<div id="routine_details">
120
121
122	<div class="routine_details" id="_CW_BGROUP_SETV">
123
124	<h2><a class="top" href="#container">top</a>CW_BGROUP_SETV </h2>
125
126	<p class="header">
127	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>
128
129	<div class="comments">
130	NAME:
131	CW_BGROUP
132
133	PURPOSE:
134	CW_BGROUP is a compound widget that simplifies creating
135	a base of buttons. It handles the details of creating the
136	proper base (standard, exclusive, or non-exclusive) and filling
137	in the desired buttons. Events for the individual buttons are
138	handled transparently, and a CW_BGROUP event returned. This
139	event can return any one of the following:
140	- The Index of the button within the base.
141	- The widget ID of the button.
142	- The name of the button.
143	- An arbitrary value taken from an array of User values.
144
145	CATEGORY:
146	Compound widgets.
147
148	CALLING SEQUENCE:
149	Widget = CW_BGROUP(Parent, Names)
150
151	To get or set the value of a CW_BGROUP, use the GET_VALUE and
152	SET_VALUE keywords to WIDGET_CONTROL. The value of a CW_BGROUP
153	is:
154
155	-----------------------------------------------
156	Type Value
157	-----------------------------------------------
158	normal None
159	exclusive Index of currently set button
160	non-exclusive Vector indicating the position
161	of each button (1-set, 0-unset)
162	-----------------------------------------------
163
164
165	INPUTS:
166	Parent: The ID of the parent widget.
167	Names: A string array, containing one string per button,
168	giving the name of each button.
169
170	KEYWORD PARAMETERS:
171
172	BUTTON_UVALUE: An array of user values to be associated with
173	each button and returned in the event structure.
174	COLUMN: Buttons will be arranged in the number of columns
175	specified by this keyword.
176	EVENT_FUNCT: The name of an optional user-supplied event function
177	for buttons. This function is called with the return
178	value structure whenever a button is pressed, and
179	follows the conventions for user-written event
180	functions.
181	EXCLUSIVE: Buttons will be placed in an exclusive base, with
182	only one button allowed to be selected at a time.
183	FONT: The name of the font to be used for the button
184	titles. If this keyword is not specified, the default
185	font is used.
186	FRAME: Specifies the width of the frame to be drawn around
187	the base.
188	IDS: A named variable into which the button IDs will be
189	stored, as a longword vector.
190	LABEL_LEFT: Creates a text label to the left of the buttons.
191	LABEL_TOP: Creates a text label above the buttons.
192	MAP: If set, the base will be mapped when the widget
193	is realized (the default).
194	NONEXCLUSIVE: Buttons will be placed in an non-exclusive base.
195	The buttons will be independent.
196	NO_RELEASE: If set, button release events will not be returned.
197	RETURN_ID: If set, the VALUE field of returned events will be
198	the widget ID of the button.
199	RETURN_INDEX: If set, the VALUE field of returned events will be
200	the zero-based index of the button within the base.
201	THIS IS THE DEFAULT.
202	RETURN_NAME: If set, the VALUE field of returned events will be
203	the name of the button within the base.
204	ROW: Buttons will be arranged in the number of rows
205	specified by this keyword.
206	SCROLL: If set, the base will include scroll bars to allow
207	viewing a large base through a smaller viewport.
208	SET_VALUE: The initial value of the buttons. This is equivalent
209	to the later statement:
210
211	WIDGET_CONTROL, widget, set_value=value
212
213	SPACE: The space, in pixels, to be left around the edges
214	of a row or column major base. This keyword is
215	ignored if EXCLUSIVE or NONEXCLUSIVE are specified.
216	UVALUE: The user value to be associated with the widget.
217	UNAME: The user name to be associated with the widget.
218	XOFFSET: The X offset of the widget relative to its parent.
219	XPAD: The horizontal space, in pixels, between children
220	of a row or column major base. Ignored if EXCLUSIVE
221	or NONEXCLUSIVE are specified.
222	XSIZE: The width of the base.
223	X_SCROLL_SIZE: The width of the viewport if SCROLL is specified.
224	YOFFSET: The Y offset of the widget relative to its parent.
225	YPAD: The vertical space, in pixels, between children of
226	a row or column major base. Ignored if EXCLUSIVE
227	or NONEXCLUSIVE are specified.
228	YSIZE: The height of the base.
229	Y_SCROLL_SIZE: The height of the viewport if SCROLL is specified.
230
231	OUTPUTS:
232	The ID of the created widget is returned.
233
234	SIDE EFFECTS:
235	This widget generates event structures with the following definition:
236
237	event = { ID:0L, TOP:0L, HANDLER:0L, SELECT:0, VALUE:0 }
238
239	The SELECT field is passed through from the button event. VALUE is
240	either the INDEX, ID, NAME, or BUTTON_UVALUE of the button,
241	depending on how the widget was created.
242
243	RESTRICTIONS:
244	Only buttons with textual names are handled by this widget.
245	Bitmaps are not understood.
246
247	MODIFICATION HISTORY:
248	15 June 1992, AB
249	7 April 1993, AB, Removed state caching.
250	6 Oct. 1994, KDB, Font keyword is not applied to the label.
251	10 FEB 1995, DJC fixed bad bug in event procedure, getting
252	id of stash widget.
253	11 April 1995, AB Removed Motif special cases.</div>
254
255
256
257
258	<h3>Parameters</h3>
259
260
261	<h4 id="_CW_BGROUP_SETV_param_id">id
262
263
264
265
266
267
268
269
270	</h4>
271
272	<div class="comments"></div>
273
274	<h4 id="_CW_BGROUP_SETV_param_value">value
275
276
277
278
279
280
281
282
283	</h4>
284
285	<div class="comments"></div>
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315	</div>
316
317
318	<div class="routine_details" id="_CW_BGROUP_GETV">
319
320	<h2><a class="top" href="#container">top</a>CW_BGROUP_GETV </h2>
321
322	<p class="header">
323	<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>
324
325	<div class="comments"></div>
326
327
328
329
330	<h3>Parameters</h3>
331
332
333	<h4 id="_CW_BGROUP_GETV_param_id">id
334
335
336
337
338
339
340
341
342	</h4>
343
344	<div class="comments"></div>
345
346	<h4 id="_CW_BGROUP_GETV_param_value">value
347
348
349
350
351
352
353
354
355	</h4>
356
357	<div class="comments"></div>
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387	</div>
388
389
390	<div class="routine_details" id="_CW_BGROUP_EVENT">
391
392	<h2><a class="top" href="#container">top</a>CW_BGROUP_EVENT </h2>
393
394	<p class="header">
395	<span class="result">result = </span>CW_BGROUP_EVENT(<span class="result"><a href="#_CW_BGROUP_EVENT_param_ev">ev</a></span>)</p>
396
397	<div class="comments"></div>
398
399
400
401
402	<h3>Parameters</h3>
403
404
405	<h4 id="_CW_BGROUP_EVENT_param_ev">ev
406
407
408
409
410
411
412
413
414	</h4>
415
416	<div class="comments"></div>
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446	</div>
447
448
449	<div class="routine_details" id="_CW_BGROUP">
450
451	<h2><a class="top" href="#container">top</a>CW_BGROUP </h2>
452
453	<p class="header">
454	<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>
455
456	<div class="comments"></div>
457
458
459
460
461	<h3>Parameters</h3>
462
463
464	<h4 id="_CW_BGROUP_param_parent">parent
465
466
467
468
469
470
471
472
473	</h4>
474
475	<div class="comments"></div>
476
477	<h4 id="_CW_BGROUP_param_names">names
478
479
480
481
482
483
484
485
486	</h4>
487
488	<div class="comments"></div>
489
490
491
492
493
494
495	<h3>Keywords</h3>
496
497	<h4 id="_CW_BGROUP_keyword_BUTTON_UVALUE">BUTTON_UVALUE
498
499
500
501
502
503
504
505
506	</h4>
507
508	<div class="comments"></div>
509
510	<h4 id="_CW_BGROUP_keyword_COLUMN">COLUMN
511
512
513
514
515
516
517
518
519	</h4>
520
521	<div class="comments"></div>
522
523	<h4 id="_CW_BGROUP_keyword_EVENT_FUNCT">EVENT_FUNCT
524
525
526
527
528
529
530
531
532	</h4>
533
534	<div class="comments"></div>
535
536	<h4 id="_CW_BGROUP_keyword_EXCLUSIVE">EXCLUSIVE
537
538
539
540
541
542
543
544
545	</h4>
546
547	<div class="comments"></div>
548
549	<h4 id="_CW_BGROUP_keyword_FONT">FONT
550
551
552
553
554
555
556
557
558	</h4>
559
560	<div class="comments"></div>
561
562	<h4 id="_CW_BGROUP_keyword_FRAME">FRAME
563
564
565
566
567
568
569
570
571	</h4>
572
573	<div class="comments"></div>
574
575	<h4 id="_CW_BGROUP_keyword_IDS">IDS
576
577
578
579
580
581
582
583
584	</h4>
585
586	<div class="comments"></div>
587
588	<h4 id="_CW_BGROUP_keyword_LABEL_TOP">LABEL_TOP
589
590
591
592
593
594
595
596
597	</h4>
598
599	<div class="comments"></div>
600
601	<h4 id="_CW_BGROUP_keyword_LABEL_LEFT">LABEL_LEFT
602
603
604
605
606
607
608
609
610	</h4>
611
612	<div class="comments"></div>
613
614	<h4 id="_CW_BGROUP_keyword_MAP">MAP
615
616
617
618
619
620
621
622
623	</h4>
624
625	<div class="comments"></div>
626
627	<h4 id="_CW_BGROUP_keyword_NONEXCLUSIVE">NONEXCLUSIVE
628
629
630
631
632
633
634
635
636	</h4>
637
638	<div class="comments"></div>
639
640	<h4 id="_CW_BGROUP_keyword_NO_RELEASE">NO_RELEASE
641
642
643
644
645
646
647
648
649	</h4>
650
651	<div class="comments"></div>
652
653	<h4 id="_CW_BGROUP_keyword_RETURN_ID">RETURN_ID
654
655
656
657
658
659
660
661
662	</h4>
663
664	<div class="comments"></div>
665
666	<h4 id="_CW_BGROUP_keyword_RETURN_INDEX">RETURN_INDEX
667
668
669
670
671
672
673
674
675	</h4>
676
677	<div class="comments"></div>
678
679	<h4 id="_CW_BGROUP_keyword_RETURN_NAME">RETURN_NAME
680
681
682
683
684
685
686
687
688	</h4>
689
690	<div class="comments"></div>
691
692	<h4 id="_CW_BGROUP_keyword_ROW">ROW
693
694
695
696
697
698
699
700
701	</h4>
702
703	<div class="comments"></div>
704
705	<h4 id="_CW_BGROUP_keyword_SCROLL">SCROLL
706
707
708
709
710
711
712
713
714	</h4>
715
716	<div class="comments"></div>
717
718	<h4 id="_CW_BGROUP_keyword_SET_VALUE">SET_VALUE
719
720
721
722
723
724
725
726
727	</h4>
728
729	<div class="comments"></div>
730
731	<h4 id="_CW_BGROUP_keyword_SPACE">SPACE
732
733
734
735
736
737
738
739
740	</h4>
741
742	<div class="comments"></div>
743
744	<h4 id="_CW_BGROUP_keyword_TAB_MODE">TAB_MODE
745
746
747
748
749
750
751
752
753	</h4>
754
755	<div class="comments"></div>
756
757	<h4 id="_CW_BGROUP_keyword_UVALUE">UVALUE
758
759
760
761
762
763
764
765
766	</h4>
767
768	<div class="comments"></div>
769
770	<h4 id="_CW_BGROUP_keyword_XOFFSET">XOFFSET
771
772
773
774
775
776
777
778
779	</h4>
780
781	<div class="comments"></div>
782
783	<h4 id="_CW_BGROUP_keyword_XPAD">XPAD
784
785
786
787
788
789
790
791
792	</h4>
793
794	<div class="comments"></div>
795
796	<h4 id="_CW_BGROUP_keyword_XSIZE">XSIZE
797
798
799
800
801
802
803
804
805	</h4>
806
807	<div class="comments"></div>
808
809	<h4 id="_CW_BGROUP_keyword_X_SCROLL_SIZE">X_SCROLL_SIZE
810
811
812
813
814
815
816
817
818	</h4>
819
820	<div class="comments"></div>
821
822	<h4 id="_CW_BGROUP_keyword_YOFFSET">YOFFSET
823
824
825
826
827
828
829
830
831	</h4>
832
833	<div class="comments"></div>
834
835	<h4 id="_CW_BGROUP_keyword_YPAD">YPAD
836
837
838
839
840
841
842
843
844	</h4>
845
846	<div class="comments"></div>
847
848	<h4 id="_CW_BGROUP_keyword_YSIZE">YSIZE
849
850
851
852
853
854
855
856
857	</h4>
858
859	<div class="comments"></div>
860
861	<h4 id="_CW_BGROUP_keyword_Y_SCROLL_SIZE">Y_SCROLL_SIZE
862
863
864
865
866
867
868
869
870	</h4>
871
872	<div class="comments"></div>
873
874	<h4 id="_CW_BGROUP_keyword_UNAME">UNAME
875
876
877
878
879
880
881
882
883	</h4>
884
885	<div class="comments"></div>
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912	</div>
913
914	</div>
915
916
917
918	<div id="tagline">Produced by IDLdoc 2.0.</div>
919
920	</div>
921
922	</body>
923	</html>

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

Download in other formats: