Context Navigation

cw_bgroup.html @ 338

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

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

Context Navigation

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

Download in other formats: