Context Navigation

source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/WIDGET/COMPOUND_WIDGET/cw_bgroup.html @ 249

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

Line
1
2
3	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4	<head>
5	<title>cw_bgroup.pro (SAXO Documentation Assistant)</title>
6	</head>
7
8	<body text="#000000" bgcolor="#FFFFFF">
9
10
11	<!-- Navbar template takes a structure with the following fields:
12	overview_href :
13	overview_selected :
14	dir_overview_href :
15	dir_overview_selected :
16	categories_href :
17	categories_selected :
18	index_href :
19	index_selected :
20	search_href :
21	search_selected :
22	file_selected :
23	source_href :
24	source_selected :
25	help_href :
26	help_selected :
27	etc_selected :
28
29	prev_file_href :
30	next_file_href :
31
32	view_single_page_href :
33	view_frames_href :
34
35	summary_fields_href :
36	summary_routine_href :
37	details_routine_href :
38
39	title :
40	subtitle :
41	user :
42	-->
43
44
45	<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46	<tr>
47	<td width="10%">
48	<a href=""><img src="./../../../prev.gif" border="0" alt="Previous"></a></td>
49	<td width="80%" align="center" valign="center">
50	<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../../../home.html">Overview</a></font></td>
51	<td width="10%" align="right">
52	<a href="cw_calendar.html"><img src="./../../../next.gif" border="0" alt="Next"></a></td>
53	</tr>
54	</table>
55
56
57	<h1><font size="-2">ToBeReviewed/WIDGET/COMPOUND_WIDGET/</font></h1>
58	<h2>cw_bgroup.pro</h2>
59
60	<dl>
61	</dl>
62
63
64
65
66	Compound widget
67
68
69	Compound widget
70
71
72	CW_BGROUP is a compound widget that simplifies creating
73	a base of buttons. It handles the details of creating the
74	proper base (standard, exclusive, or non-exclusive) and filling
75	in the desired buttons. Events for the individual buttons are
76	handled transparently, and a CW_BGROUP event returned. This
77	event can return any one of the following:
78	- The Index of the button within the base.
79	- The widget ID of the button.
80	- The name of the button.
81	- An arbitrary value taken from an array of User values.
82
83
84
85	<h2>Routine summary</h2>
86
87	<dl>
88
89	<dt><a href="#_cw_bgroup_setv">cw_bgroup_setv<i>, id, value</i></a><dt>
90	<dd><font size="-1"> </font></dd>
91
92	<dt><a href="#_cw_bgroup_getv"><i>result = </i>cw_bgroup_getv(<i>id, value</i>)</a><dt>
93	<dd><font size="-1"></font></dd>
94
95	<dt><a href="#_cw_bgroup_event"><i>result = </i>cw_bgroup_event(<i>ev</i>)</a><dt>
96	<dd><font size="-1"> </font></dd>
97
98	<dt><a href="#_cw_bgroup"><i>result = </i>cw_bgroup(<i>parent, names</i>, BUTTON_UVALUE=<i>array</i>, COLUMN=<i>COLUMN</i>, EVENT_FUNCT=<i>EVENT_FUNCT</i>, EXCLUSIVE=<i>EXCLUSIVE</i>, FONT=<i>FONT</i>, FRAME=<i>FRAME</i>, IDS=<i>IDS</i>, LABEL_TOP=<i>LABEL_TOP</i>, LABEL_LEFT=<i>LABEL_LEFT</i>, MAP=<i>MAP</i>, NONEXCLUSIVE=<i>NONEXCLUSIVE</i>, NO_RELEASE=<i>NO_RELEASE</i>, RETURN_ID=<i>RETURN_ID</i>, RETURN_INDEX=<i>RETURN_INDEX</i>, RETURN_NAME=<i>RETURN_NAME</i>, ROW=<i>ROW</i>, SCROLL=<i>SCROLL</i>, SET_VALUE=<i>SET_VALUE</i>, SPACE=<i>SPACE</i>, TAB_MODE=<i>TAB_MODE</i>, UVALUE=<i>UVALUE</i>, XOFFSET=<i>XOFFSET</i>, XPAD=<i>XPAD</i>, XSIZE=<i>XSIZE</i>, X_SCROLL_SIZE=<i>X_SCROLL_SIZE</i>, YOFFSET=<i>YOFFSET</i>, YPAD=<i>YPAD</i>, YSIZE=<i>YSIZE</i>, Y_SCROLL_SIZE=<i>Y_SCROLL_SIZE</i>, UNAME=<i>UNAME</i>)</a><dt>
99	<dd><font size="-1"></font></dd>
100
101	</dl>
102
103	<p> </p>
104
105
106
107	<a name="#_cw_bgroup_setv"></a>
108
109	<h2>cw_bgroup_setv <font size="-1" color="#006633">
110	Compound widget
111	</font></h2>
112
113	<p><font face="Courier">cw_bgroup_setv<i>, <a href="#_cw_bgroup_setv_keyword_id">id</a>, <a href="#_cw_bgroup_setv_keyword_value">value</a></i></font></p>
114
115
116
117
118	<h3>Return value</h3>
119
120
121
122	<h3>Parameters</h3>
123
124
125	<a name="#_cw_bgroup_setv_keyword_id"></a>
126	<h4>id
127
128
129
130
131
132
133
134
135	</h4>
136
137
138
139
140
141	<a name="#_cw_bgroup_setv_keyword_value"></a>
142	<h4>value
143
144
145
146
147
148
149
150
151	</h4>
152
153
154	It is the default tick mark value (a floating-point number).
155
156
157
158
159
160
161	<h3>Examples</h3><pre>
162
163	</pre><h3>Version history</h3>
164
165	<h4>Version</h4>
166	$Id: cw_bgroup.pro 242 2007-04-06 08:35:17Z pinsard $
167	<h4>History</h4>
168
169
170
171	<h3>Known issues</h3>
172
173
174
175	<h4>Restrictions</h4>
176
177
178	<h3>Other attributes</h3>
179
180
181	<h4>Uses routines</h4>
182
183
184
185
186
187	<font size="-3"><p> </p></font>
188	<hr size="1" color="#CCCCCC"/>
189
190	<a name="#_cw_bgroup_getv"></a>
191
192	<h2>cw_bgroup_getv <font size="-1" color="#006633">
193	</font></h2>
194
195	<p><font face="Courier"><i>result = </i>cw_bgroup_getv(<i><a href="#_cw_bgroup_getv_keyword_id">id</a>, <a href="#_cw_bgroup_getv_keyword_value">value</a></i>)</font></p>
196
197
198
199	<h3>Return value</h3>
200
201
202
203	<h3>Parameters</h3>
204
205
206	<a name="#_cw_bgroup_getv_keyword_id"></a>
207	<h4>id
208
209
210
211
212
213
214
215
216	</h4>
217
218
219
220
221
222
223	<a name="#_cw_bgroup_getv_keyword_value"></a>
224	<h4>value
225
226
227
228
229
230
231
232
233	</h4>
234
235
236	It is the default tick mark value (a floating-point number).
237
238
239
240
241
242
243	<h3>Examples</h3><pre>
244
245	</pre><h3>Version history</h3>
246
247	<h4>Version</h4>
248	$Id: cw_bgroup.pro 242 2007-04-06 08:35:17Z pinsard $
249	<h4>History</h4>
250
251
252
253	<h3>Known issues</h3>
254
255
256
257	<h4>Restrictions</h4>
258
259
260	<h3>Other attributes</h3>
261
262
263	<h4>Uses routines</h4>
264
265
266
267
268
269	<font size="-3"><p> </p></font>
270	<hr size="1" color="#CCCCCC"/>
271
272	<a name="#_cw_bgroup_event"></a>
273
274	<h2>cw_bgroup_event <font size="-1" color="#006633">
275	</font></h2>
276
277	<p><font face="Courier"><i>result = </i>cw_bgroup_event(<i><a href="#_cw_bgroup_event_keyword_ev">ev</a></i>)</font></p>
278
279
280
281
282	<h3>Return value</h3>
283
284
285
286	<h3>Parameters</h3>
287
288
289	<a name="#_cw_bgroup_event_keyword_ev"></a>
290	<h4>ev
291
292
293
294
295
296
297
298
299	</h4>
300
301
302
303
304
305
306
307
308	<h3>Examples</h3><pre>
309
310	</pre><h3>Version history</h3>
311
312	<h4>Version</h4>
313	$Id: cw_bgroup.pro 242 2007-04-06 08:35:17Z pinsard $
314	<h4>History</h4>
315
316
317
318	<h3>Known issues</h3>
319
320
321
322	<h4>Restrictions</h4>
323
324
325	<h3>Other attributes</h3>
326
327
328	<h4>Uses routines</h4>
329
330
331
332
333
334	<font size="-3"><p> </p></font>
335	<hr size="1" color="#CCCCCC"/>
336
337	<a name="#_cw_bgroup"></a>
338
339	<h2>cw_bgroup <font size="-1" color="#006633">
340	Compound widget
341	</font></h2>
342
343	<p><font face="Courier"><i>result = </i>cw_bgroup(<i><a href="#_cw_bgroup_keyword_parent">parent</a>, <a href="#_cw_bgroup_keyword_names">names</a></i>, <a href="#_cw_bgroup_keyword_BUTTON_UVALUE">BUTTON_UVALUE</a>=<i>array</i>, <a href="#_cw_bgroup_keyword_COLUMN">COLUMN</a>=<i>COLUMN</i>, <a href="#_cw_bgroup_keyword_EVENT_FUNCT">EVENT_FUNCT</a>=<i>EVENT_FUNCT</i>, <a href="#_cw_bgroup_keyword_EXCLUSIVE">EXCLUSIVE</a>=<i>EXCLUSIVE</i>, <a href="#_cw_bgroup_keyword_FONT">FONT</a>=<i>FONT</i>, <a href="#_cw_bgroup_keyword_FRAME">FRAME</a>=<i>FRAME</i>, <a href="#_cw_bgroup_keyword_IDS">IDS</a>=<i>IDS</i>, <a href="#_cw_bgroup_keyword_LABEL_TOP">LABEL_TOP</a>=<i>LABEL_TOP</i>, <a href="#_cw_bgroup_keyword_LABEL_LEFT">LABEL_LEFT</a>=<i>LABEL_LEFT</i>, <a href="#_cw_bgroup_keyword_MAP">MAP</a>=<i>MAP</i>, <a href="#_cw_bgroup_keyword_NONEXCLUSIVE">NONEXCLUSIVE</a>=<i>NONEXCLUSIVE</i>, <a href="#_cw_bgroup_keyword_NO_RELEASE">NO_RELEASE</a>=<i>NO_RELEASE</i>, <a href="#_cw_bgroup_keyword_RETURN_ID">RETURN_ID</a>=<i>RETURN_ID</i>, <a href="#_cw_bgroup_keyword_RETURN_INDEX">RETURN_INDEX</a>=<i>RETURN_INDEX</i>, <a href="#_cw_bgroup_keyword_RETURN_NAME">RETURN_NAME</a>=<i>RETURN_NAME</i>, <a href="#_cw_bgroup_keyword_ROW">ROW</a>=<i>ROW</i>, <a href="#_cw_bgroup_keyword_SCROLL">SCROLL</a>=<i>SCROLL</i>, <a href="#_cw_bgroup_keyword_SET_VALUE">SET_VALUE</a>=<i>SET_VALUE</i>, <a href="#_cw_bgroup_keyword_SPACE">SPACE</a>=<i>SPACE</i>, <a href="#_cw_bgroup_keyword_TAB_MODE">TAB_MODE</a>=<i>TAB_MODE</i>, <a href="#_cw_bgroup_keyword_UVALUE">UVALUE</a>=<i>UVALUE</i>, <a href="#_cw_bgroup_keyword_XOFFSET">XOFFSET</a>=<i>XOFFSET</i>, <a href="#_cw_bgroup_keyword_XPAD">XPAD</a>=<i>XPAD</i>, <a href="#_cw_bgroup_keyword_XSIZE">XSIZE</a>=<i>XSIZE</i>, <a href="#_cw_bgroup_keyword_X_SCROLL_SIZE">X_SCROLL_SIZE</a>=<i>X_SCROLL_SIZE</i>, <a href="#_cw_bgroup_keyword_YOFFSET">YOFFSET</a>=<i>YOFFSET</i>, <a href="#_cw_bgroup_keyword_YPAD">YPAD</a>=<i>YPAD</i>, <a href="#_cw_bgroup_keyword_YSIZE">YSIZE</a>=<i>YSIZE</i>, <a href="#_cw_bgroup_keyword_Y_SCROLL_SIZE">Y_SCROLL_SIZE</a>=<i>Y_SCROLL_SIZE</i>, <a href="#_cw_bgroup_keyword_UNAME">UNAME</a>=<i>UNAME</i>)</font></p>
344
345
346
347	<h3>Return value</h3>
348	The ID of the created widget is returned.
349
350
351
352	<h3>Parameters</h3>
353
354
355	<a name="#_cw_bgroup_keyword_parent"></a>
356	<h4>parent
357	<font size="-1" color="#006633">in</font>
358
359
360	<font size="-1" color="#006633">required</font>
361
362
363
364
365	</h4>
366
367
368	The ID of the parent widget.
369
370
371
372	<a name="#_cw_bgroup_keyword_names"></a>
373	<h4>names
374
375
376
377
378
379	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string array</i></font>
380
381
382	</h4>
383
384
385	A string array, containing one string per button,
386	giving the name of each button.
387
388
389
390
391
392	<h3>Keywords</h3>
393
394
395	<a name="#_cw_bgroup_keyword_BUTTON_UVALUE"></a>
396	<h4>BUTTON_UVALUE
397
398
399
400
401
402	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>array</i></font>
403
404
405	</h4>
406
407
408	An array of user values to be associated with
409	each button and returned in the event structure.
410
411
412	<a name="#_cw_bgroup_keyword_COLUMN"></a>
413	<h4>COLUMN
414
415
416
417
418
419
420
421
422	</h4>
423
424
425	Buttons will be arranged in the number of columns
426	specified by this keyword.
427
428
429	<a name="#_cw_bgroup_keyword_EVENT_FUNCT"></a>
430	<h4>EVENT_FUNCT
431
432
433
434
435
436
437
438
439	</h4>
440
441
442	The name of an optional user-supplied event function
443	for buttons. This function is called with the return
444	value structure whenever a button is pressed, and
445	follows the conventions for user-written event functions.
446
447
448	<a name="#_cw_bgroup_keyword_EXCLUSIVE"></a>
449	<h4>EXCLUSIVE
450
451
452
453
454
455
456
457
458	</h4>
459
460
461	Buttons will be placed in an exclusive base, with
462	only one button allowed to be selected at a time.
463
464
465	<a name="#_cw_bgroup_keyword_FONT"></a>
466	<h4>FONT
467
468
469
470
471
472
473
474
475	</h4>
476
477
478	The name of the font to be used for the button
479	titles. If this keyword is not specified, the default
480	font is used.
481
482
483	<a name="#_cw_bgroup_keyword_FRAME"></a>
484	<h4>FRAME
485
486
487
488
489
490
491
492
493	</h4>
494
495
496	Specifies the width of the frame to be drawn around the base.
497
498
499	<a name="#_cw_bgroup_keyword_IDS"></a>
500	<h4>IDS
501
502
503
504
505
506
507
508
509	</h4>
510
511
512	A named variable into which the button IDs will be
513	stored, as a longword vector.
514
515
516	<a name="#_cw_bgroup_keyword_LABEL_TOP"></a>
517	<h4>LABEL_TOP
518
519
520
521
522
523
524
525
526	</h4>
527
528
529	Creates a text label above the buttons.
530
531
532	<a name="#_cw_bgroup_keyword_LABEL_LEFT"></a>
533	<h4>LABEL_LEFT
534
535
536
537
538
539
540
541
542	</h4>
543
544
545	Creates a text label to the left of the buttons.
546
547
548	<a name="#_cw_bgroup_keyword_MAP"></a>
549	<h4>MAP
550
551
552
553
554
555
556
557
558	</h4>
559
560
561	If set, the base will be mapped when the widget
562	is realized (the default).
563
564
565	<a name="#_cw_bgroup_keyword_NONEXCLUSIVE"></a>
566	<h4>NONEXCLUSIVE
567
568
569
570
571
572
573
574
575	</h4>
576
577
578	Buttons will be placed in an non-exclusive base.
579	The buttons will be independent.
580
581
582	<a name="#_cw_bgroup_keyword_NO_RELEASE"></a>
583	<h4>NO_RELEASE
584
585
586
587
588
589
590
591
592	</h4>
593
594
595	If set, button release events will not be returned.
596
597
598	<a name="#_cw_bgroup_keyword_RETURN_ID"></a>
599	<h4>RETURN_ID
600
601
602
603
604
605
606
607
608	</h4>
609
610
611	If set, the VALUE field of returned events will be
612	the widget ID of the button.
613
614
615	<a name="#_cw_bgroup_keyword_RETURN_INDEX"></a>
616	<h4>RETURN_INDEX
617
618
619
620
621
622
623
624
625	</h4>
626
627
628	If set, the VALUE field of returned events will be
629	the zero-based index of the button within the base.
630	THIS IS THE DEFAULT.
631
632
633	<a name="#_cw_bgroup_keyword_RETURN_NAME"></a>
634	<h4>RETURN_NAME
635
636
637
638
639
640
641
642
643	</h4>
644
645
646	If set, the VALUE field of returned events will be
647	the name of the button within the base.
648
649
650	<a name="#_cw_bgroup_keyword_ROW"></a>
651	<h4>ROW
652
653
654
655
656
657
658
659
660	</h4>
661
662
663	Buttons will be arranged in the number of rows
664	specified by this keyword.
665
666
667	<a name="#_cw_bgroup_keyword_SCROLL"></a>
668	<h4>SCROLL
669
670
671
672
673
674
675
676
677	</h4>
678
679
680	If set, the base will include scroll bars to allow
681	viewing a large base through a smaller viewport.
682
683
684	<a name="#_cw_bgroup_keyword_SET_VALUE"></a>
685	<h4>SET_VALUE
686
687
688
689
690
691
692
693
694	</h4>
695
696
697	The initial value of the buttons. This is equivalent
698	to the later statement:
699
700	WIDGET_CONTROL, widget, set_value=value
701
702
703	<a name="#_cw_bgroup_keyword_SPACE"></a>
704	<h4>SPACE
705
706
707
708
709
710
711
712
713	</h4>
714
715
716	The space, in pixels, to be left around the edges
717	of a row or column major base. This keyword is
718	ignored if EXCLUSIVE or NONEXCLUSIVE are specified.
719
720
721	<a name="#_cw_bgroup_keyword_TAB_MODE"></a>
722	<h4>TAB_MODE
723
724
725
726
727
728
729
730
731	</h4>
732
733
734
735	<a name="#_cw_bgroup_keyword_UVALUE"></a>
736	<h4>UVALUE
737
738
739
740
741
742
743
744
745	</h4>
746
747
748	The user value to be associated with the widget.
749
750
751	<a name="#_cw_bgroup_keyword_XOFFSET"></a>
752	<h4>XOFFSET
753
754
755
756
757
758
759
760
761	</h4>
762
763
764	The X offset of the widget relative to its parent.
765
766
767	<a name="#_cw_bgroup_keyword_XPAD"></a>
768	<h4>XPAD
769
770
771
772
773
774
775
776
777	</h4>
778
779
780	The horizontal space, in pixels, between children
781	of a row or column major base. Ignored if EXCLUSIVE
782	or NONEXCLUSIVE are specified.
783
784
785	<a name="#_cw_bgroup_keyword_XSIZE"></a>
786	<h4>XSIZE
787
788
789
790
791
792
793
794
795	</h4>
796
797
798	The width of the base.
799
800	<a name="#_cw_bgroup_keyword_X_SCROLL_SIZE"></a>
801	<h4>X_SCROLL_SIZE
802
803
804
805
806
807
808
809
810	</h4>
811
812
813	The width of the viewport if SCROLL is specified.
814
815
816	<a name="#_cw_bgroup_keyword_YOFFSET"></a>
817	<h4>YOFFSET
818
819
820
821
822
823
824
825
826	</h4>
827
828
829	The Y offset of the widget relative to its parent.
830
831
832	<a name="#_cw_bgroup_keyword_YPAD"></a>
833	<h4>YPAD
834
835
836
837
838
839
840
841
842	</h4>
843
844
845	The vertical space, in pixels, between children of
846	a row or column major base. Ignored if EXCLUSIVE
847	or NONEXCLUSIVE are specified.
848
849
850	<a name="#_cw_bgroup_keyword_YSIZE"></a>
851	<h4>YSIZE
852
853
854
855
856
857
858
859
860	</h4>
861
862
863	The height of the base.
864
865
866	<a name="#_cw_bgroup_keyword_Y_SCROLL_SIZE"></a>
867	<h4>Y_SCROLL_SIZE
868
869
870
871
872
873
874
875
876	</h4>
877
878
879	The height of the viewport if SCROLL is specified.
880
881
882	<a name="#_cw_bgroup_keyword_UNAME"></a>
883	<h4>UNAME
884
885
886
887
888
889
890
891
892	</h4>
893
894
895	The user name to be associated with the widget.
896
897
898
899
900
901	</pre><h3>Version history</h3>
902
903	<h4>Version</h4>
904	$Id: cw_bgroup.pro 242 2007-04-06 08:35:17Z pinsard $
905
906	<h4>History</h4>
907	15 June 1992, AB
908	7 April 1993, AB, Removed state caching.
909	6 Oct. 1994, KDB, Font keyword is not applied to the label.
910	10 FEB 1995, DJC fixed bad bug in event procedure, getting
911	id of stash widget.
912	11 April 1995, AB Removed Motif special cases.
913
914	Copyright (c) 1992-2005, Research Systems, Inc. All rights reserved.
915	Unauthorized reproduction prohibited.
916
917
918
919	<h3>Known issues</h3>
920
921
922
923	<h4>Restrictions</h4>
924	This widget generates event structures with the following definition:
925
926	event = { ID:0L, TOP:0L, HANDLER:0L, SELECT:0, VALUE:0 }
927
928	The SELECT field is passed through from the button event. VALUE is
929	either the INDEX, ID, NAME, or BUTTON_UVALUE of the button,
930	depending on how the widget was created.
931
932
933	Only buttons with textual names are handled by this widget.
934	Bitmaps are not understood.
935
936
937
938
939
940
941
942
943
944
945	<font size="-3"><p> </p></font>
946	<hr size="1" color="#CCCCCC"/>
947
948
949
950
951	<p><font color="gray" size="-3">  Produced by IDLdoc 2.0.</font></p>
952
953	</body>
954	</html>

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

Download in other formats: