Context Navigation

source: trunk/SRC/Documentation/idldoc_assistant_output/buildinit.html @ 290

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

Line
1
2
3	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4	<head>
5	<title>buildinit.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=""><img src="./next.gif" border="0" alt="Next"></a></td>
53	</tr>
54	</table>
55
56
57	<h1><font size="-2">./</font></h1>
58	<h2>buildinit.pro</h2>
59
60	<dl>
61	</dl>
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80	<h2>Routine summary</h2>
81
82	<dl>
83
84	<dt><a href="#_cw_field2"><i>result = </i>cw_field2(<i>parent</i>, COLUMN=<i>COLUMN</i>, ROW=<i>ROW</i>, EVENT_FUNC=<i>EVENT_FUNC</i>, FLOATING=<i>FLOATING</i>, INTEGER=<i>INTEGER</i>, LONG=<i>LONG</i>, STRING=<i>STRING</i>, FONT=<i>FONT</i>, FRAME=<i>FRAME</i>, TITLE=<i>TITLE</i>, UVALUE=<i>UVALUE</i>, VALUE=<i>VALUE</i>, RETURN_EVENTS=<i>RETURN_EVENTS</i>, ALL_EVENTS=<i>ALL_EVENTS</i>, FIELDFONT=<i>FIELDFONT</i>, NOEDIT=<i>NOEDIT</i>, TEXT_FRAME=<i>TEXT_FRAME</i>, XSIZE=<i>XSIZE</i>, YSIZE=<i>YSIZE</i>, UNAME=<i>UNAME</i>)</a><dt>
85	<dd><font size="-1"> </font></dd>
86
87	<dt><a href="#_printerdef_event">printerdef_event<i>, event</i></a><dt>
88	<dd><font size="-1"></font></dd>
89
90	<dt><a href="#_papsize_event">papsize_event<i>, event</i></a><dt>
91	<dd><font size="-1"> </font></dd>
92
93	<dt><a href="#_xask_event">xask_event<i>, event</i></a><dt>
94	<dd><font size="-1"></font></dd>
95
96	<dt><a href="#_xask"><i>result = </i>xask(_EXTRA=<i>_EXTRA</i>)</a><dt>
97	<dd><font size="-1"> </font></dd>
98
99	<dt><a href="#_getdir"><i>result = </i>getdir(title=<i>title</i>, nomark=<i>nomark</i>, nowrite=<i>nowrite</i>)</a><dt>
100	<dd><font size="-1"> </font></dd>
101
102	<dt><a href="#_buildinit">buildinit</a><dt>
103	<dd><font size="-1"> </font></dd>
104
105	</dl>
106
107	<p> </p>
108
109
110
111	<a name="#_cw_field2"></a>
112
113	<h2>cw_field2 <font size="-1" color="#006633">
114	</font></h2>
115
116	<p><font face="Courier"><i>result = </i>cw_field2(<i><a href="#_cw_field2_keyword_parent">parent</a></i>, <a href="#_cw_field2_keyword_COLUMN">COLUMN</a>=<i>COLUMN</i>, <a href="#_cw_field2_keyword_ROW">ROW</a>=<i>ROW</i>, <a href="#_cw_field2_keyword_EVENT_FUNC">EVENT_FUNC</a>=<i>EVENT_FUNC</i>, <a href="#_cw_field2_keyword_FLOATING">FLOATING</a>=<i>FLOATING</i>, <a href="#_cw_field2_keyword_INTEGER">INTEGER</a>=<i>INTEGER</i>, <a href="#_cw_field2_keyword_LONG">LONG</a>=<i>LONG</i>, <a href="#_cw_field2_keyword_STRING">STRING</a>=<i>STRING</i>, <a href="#_cw_field2_keyword_FONT">FONT</a>=<i>FONT</i>, <a href="#_cw_field2_keyword_FRAME">FRAME</a>=<i>FRAME</i>, <a href="#_cw_field2_keyword_TITLE">TITLE</a>=<i>TITLE</i>, <a href="#_cw_field2_keyword_UVALUE">UVALUE</a>=<i>UVALUE</i>, <a href="#_cw_field2_keyword_VALUE">VALUE</a>=<i>VALUE</i>, <a href="#_cw_field2_keyword_RETURN_EVENTS">RETURN_EVENTS</a>=<i>RETURN_EVENTS</i>, <a href="#_cw_field2_keyword_ALL_EVENTS">ALL_EVENTS</a>=<i>ALL_EVENTS</i>, <a href="#_cw_field2_keyword_FIELDFONT">FIELDFONT</a>=<i>FIELDFONT</i>, <a href="#_cw_field2_keyword_NOEDIT">NOEDIT</a>=<i>NOEDIT</i>, <a href="#_cw_field2_keyword_TEXT_FRAME">TEXT_FRAME</a>=<i>TEXT_FRAME</i>, <a href="#_cw_field2_keyword_XSIZE">XSIZE</a>=<i>XSIZE</i>, <a href="#_cw_field2_keyword_YSIZE">YSIZE</a>=<i>YSIZE</i>, <a href="#_cw_field2_keyword_UNAME">UNAME</a>=<i>UNAME</i>)</font></p>
117
118
119
120
121	<h3>Return value</h3>
122
123
124
125	<h3>Parameters</h3>
126
127
128	<a name="#_cw_field2_keyword_parent"></a>
129	<h4>parent
130	<font size="-1" color="#006633">in</font>
131
132
133	<font size="-1" color="#006633">required</font>
134
135
136
137
138	</h4>
139
140
141	The ID of the parent widget.
142
143
144
145
146
147	<h3>Keywords</h3>
148
149
150	<a name="#_cw_field2_keyword_COLUMN"></a>
151	<h4>COLUMN
152
153
154
155
156
157
158
159
160	</h4>
161
162
163	Buttons will be arranged in the number of columns specified by this keyword.
164
165
166	<a name="#_cw_field2_keyword_ROW"></a>
167	<h4>ROW
168
169
170
171
172
173
174
175
176	</h4>
177
178
179	Buttons will be arranged in the number of rows specified by this keyword.
180
181
182	<a name="#_cw_field2_keyword_EVENT_FUNC"></a>
183	<h4>EVENT_FUNC
184
185
186
187
188
189
190
191
192	</h4>
193
194
195	The name of an optional user-supplied event function for buttons.
196	This function is called with the return value structure whenever a
197	button is pressed, and follows the conventions for user-written event functions.
198
199
200	<a name="#_cw_field2_keyword_FLOATING"></a>
201	<h4>FLOATING
202
203
204
205
206
207
208
209
210	</h4>
211
212
213
214
215	<a name="#_cw_field2_keyword_INTEGER"></a>
216	<h4>INTEGER
217
218
219
220
221
222
223
224
225	</h4>
226
227
228
229
230	<a name="#_cw_field2_keyword_LONG"></a>
231	<h4>LONG
232
233
234
235
236
237
238
239
240	</h4>
241
242
243
244
245	<a name="#_cw_field2_keyword_STRING"></a>
246	<h4>STRING
247
248
249
250
251
252
253
254
255	</h4>
256
257
258
259
260	<a name="#_cw_field2_keyword_FONT"></a>
261	<h4>FONT
262
263
264
265
266
267
268
269
270	</h4>
271
272
273	The name of the font to be used for the button titles. If this keyword
274	is not specified, the default font is used.
275
276
277	<a name="#_cw_field2_keyword_FRAME"></a>
278	<h4>FRAME
279
280
281
282
283
284
285
286
287	</h4>
288
289
290	Specifies the width of the frame to be drawn around the base.
291
292
293	<a name="#_cw_field2_keyword_TITLE"></a>
294	<h4>TITLE
295
296
297
298
299
300
301
302
303	</h4>
304
305
306	The title of the window
307
308
309	<a name="#_cw_field2_keyword_UVALUE"></a>
310	<h4>UVALUE
311
312
313
314
315
316
317
318
319	</h4>
320
321
322	The user value to be associated with the widget.
323
324
325	<a name="#_cw_field2_keyword_VALUE"></a>
326	<h4>VALUE
327
328
329
330
331
332
333
334
335	</h4>
336
337
338
339
340	<a name="#_cw_field2_keyword_RETURN_EVENTS"></a>
341	<h4>RETURN_EVENTS
342
343
344
345
346
347
348
349
350	</h4>
351
352
353
354
355	<a name="#_cw_field2_keyword_ALL_EVENTS"></a>
356	<h4>ALL_EVENTS
357
358
359
360
361
362
363
364
365	</h4>
366
367
368
369
370	<a name="#_cw_field2_keyword_FIELDFONT"></a>
371	<h4>FIELDFONT
372
373
374
375
376
377
378
379
380	</h4>
381
382
383
384
385	<a name="#_cw_field2_keyword_NOEDIT"></a>
386	<h4>NOEDIT
387
388
389
390
391
392
393
394
395	</h4>
396
397
398
399
400	<a name="#_cw_field2_keyword_TEXT_FRAME"></a>
401	<h4>TEXT_FRAME
402
403
404
405
406
407
408
409
410	</h4>
411
412
413
414
415	<a name="#_cw_field2_keyword_XSIZE"></a>
416	<h4>XSIZE
417
418
419
420
421
422
423
424
425	</h4>
426
427
428	The width of the base
429
430
431	<a name="#_cw_field2_keyword_YSIZE"></a>
432	<h4>YSIZE
433
434
435
436
437
438
439
440
441	</h4>
442
443
444	The height of the base.
445
446
447	<a name="#_cw_field2_keyword_UNAME"></a>
448	<h4>UNAME
449
450
451
452
453
454
455
456
457	</h4>
458
459
460	The user name to be associated with the widget.
461
462
463
464
465	<h3>Examples</h3><pre>
466
467	</pre><h3>Version history</h3>
468
469	<h4>Version</h4>
470	$Id: buildinit.pro 237 2007-03-26 15:37:03Z pinsard $
471	<h4>History</h4>
472
473
474
475	<h3>Known issues</h3>
476
477
478
479	<h4>Restrictions</h4>
480
481
482	<h3>Other attributes</h3>
483
484
485	<h4>Uses routines</h4>
486
487
488
489
490
491	<font size="-3"><p> </p></font>
492	<hr size="1" color="#CCCCCC"/>
493
494	<a name="#_printerdef_event"></a>
495
496	<h2>printerdef_event <font size="-1" color="#006633">
497
498	</font></h2>
499
500	<p><font face="Courier">printerdef_event<i>, <a href="#_printerdef_event_keyword_event">event</a></i></font></p>
501
502
503
504	<h3>Return value</h3>
505
506
507
508	<h3>Parameters</h3>
509
510
511	<a name="#_printerdef_event_keyword_event"></a>
512	<h4>event
513
514
515
516
517
518
519
520
521	</h4>
522
523
524
525
526
527
528
529
530
531	<h3>Examples</h3><pre>
532
533	</pre><h3>Version history</h3>
534
535	<h4>Version</h4>
536	$Id: buildinit.pro 237 2007-03-26 15:37:03Z pinsard $
537	<h4>History</h4>
538
539
540
541	<h3>Known issues</h3>
542
543
544
545	<h4>Restrictions</h4>
546
547
548	<h3>Other attributes</h3>
549
550
551	<h4>Uses routines</h4>
552
553
554
555
556
557	<font size="-3"><p> </p></font>
558	<hr size="1" color="#CCCCCC"/>
559
560	<a name="#_papsize_event"></a>
561
562	<h2>papsize_event <font size="-1" color="#006633">
563	</font></h2>
564
565	<p><font face="Courier">papsize_event<i>, <a href="#_papsize_event_keyword_event">event</a></i></font></p>
566
567
568
569
570	<h3>Return value</h3>
571
572
573
574	<h3>Parameters</h3>
575
576
577	<a name="#_papsize_event_keyword_event"></a>
578	<h4>event
579
580
581
582
583
584
585
586
587	</h4>
588
589
590
591
592
593
594
595
596	<h3>Examples</h3><pre>
597
598	</pre><h3>Version history</h3>
599
600	<h4>Version</h4>
601	$Id: buildinit.pro 237 2007-03-26 15:37:03Z pinsard $
602	<h4>History</h4>
603
604
605
606	<h3>Known issues</h3>
607
608
609
610	<h4>Restrictions</h4>
611
612
613	<h3>Other attributes</h3>
614
615
616	<h4>Uses routines</h4>
617
618
619
620
621
622	<font size="-3"><p> </p></font>
623	<hr size="1" color="#CCCCCC"/>
624
625	<a name="#_xask_event"></a>
626
627	<h2>xask_event <font size="-1" color="#006633">
628	</font></h2>
629
630	<p><font face="Courier">xask_event<i>, <a href="#_xask_event_keyword_event">event</a></i></font></p>
631
632
633
634	<h3>Return value</h3>
635
636
637
638	<h3>Parameters</h3>
639
640
641	<a name="#_xask_event_keyword_event"></a>
642	<h4>event
643
644
645
646
647
648
649
650
651	</h4>
652
653
654
655
656
657
658
659
660	<h3>Examples</h3><pre>
661
662	</pre><h3>Version history</h3>
663
664	<h4>Version</h4>
665	$Id: buildinit.pro 237 2007-03-26 15:37:03Z pinsard $
666	<h4>History</h4>
667
668
669
670	<h3>Known issues</h3>
671
672
673
674	<h4>Restrictions</h4>
675
676
677	<h3>Other attributes</h3>
678
679
680	<h4>Uses routines</h4>
681
682
683
684
685
686	<font size="-3"><p> </p></font>
687	<hr size="1" color="#CCCCCC"/>
688
689	<a name="#_xask"></a>
690
691	<h2>xask <font size="-1" color="#006633">
692	</font></h2>
693
694	<p><font face="Courier"><i>result = </i>xask(<a href="#_xask_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
695
696
697
698
699	<h3>Return value</h3>
700
701
702
703
704
705	<h3>Keywords</h3>
706
707
708	<a name="#_xask_keyword__EXTRA"></a>
709	<h4>_EXTRA
710
711
712
713
714
715
716
717
718	</h4>
719
720
721	Used to pass keywords
722
723
724
725
726	<h3>Examples</h3><pre>
727
728	</pre><h3>Version history</h3>
729
730	<h4>Version</h4>
731	$Id: buildinit.pro 237 2007-03-26 15:37:03Z pinsard $
732	<h4>History</h4>
733
734
735
736	<h3>Known issues</h3>
737
738
739
740	<h4>Restrictions</h4>
741
742
743	<h3>Other attributes</h3>
744
745
746	<h4>Uses routines</h4>
747
748
749
750
751
752	<font size="-3"><p> </p></font>
753	<hr size="1" color="#CCCCCC"/>
754
755	<a name="#_getdir"></a>
756
757	<h2>getdir <font size="-1" color="#006633">
758	</font></h2>
759
760	<p><font face="Courier"><i>result = </i>getdir(<a href="#_getdir_keyword_title">title</a>=<i>title</i>, <a href="#_getdir_keyword_nomark">nomark</a>=<i>nomark</i>, <a href="#_getdir_keyword_nowrite">nowrite</a>=<i>nowrite</i>)</font></p>
761
762
763
764
765	<h3>Return value</h3>
766
767
768
769
770
771	<h3>Keywords</h3>
772
773
774	<a name="#_getdir_keyword_title"></a>
775	<h4>title
776
777
778
779
780
781
782
783
784	</h4>
785
786
787	The title of the window
788
789
790	<a name="#_getdir_keyword_nomark"></a>
791	<h4>nomark
792
793
794
795
796
797
798
799
800	</h4>
801
802
803
804
805	<a name="#_getdir_keyword_nowrite"></a>
806	<h4>nowrite
807
808
809
810
811
812
813
814
815	</h4>
816
817
818
819
820
821
822	<h3>Examples</h3><pre>
823
824	</pre><h3>Version history</h3>
825
826	<h4>Version</h4>
827	$Id: buildinit.pro 237 2007-03-26 15:37:03Z pinsard $
828	<h4>History</h4>
829
830
831
832	<h3>Known issues</h3>
833
834
835
836	<h4>Restrictions</h4>
837
838
839	<h3>Other attributes</h3>
840
841
842	<h4>Uses routines</h4>
843
844
845
846
847
848	<font size="-3"><p> </p></font>
849	<hr size="1" color="#CCCCCC"/>
850
851	<a name="#_buildinit"></a>
852
853	<h2>buildinit <font size="-1" color="#006633">
854	</font></h2>
855
856	<p><font face="Courier">buildinit</font></p>
857
858
859
860
861	<h3>Return value</h3>
862
863
864
865
866
867
868	<h3>Examples</h3><pre>
869
870	</pre><h3>Version history</h3>
871
872	<h4>Version</h4>
873	$Id: buildinit.pro 237 2007-03-26 15:37:03Z pinsard $
874	<h4>History</h4>
875
876
877
878	<h3>Known issues</h3>
879
880
881
882	<h4>Restrictions</h4>
883
884
885	<h3>Other attributes</h3>
886
887
888	<h4>Uses routines</h4>
889
890
891
892
893
894	<font size="-3"><p> </p></font>
895	<hr size="1" color="#CCCCCC"/>
896
897
898
899
900	<p><font color="gray" size="-3">  Produced by IDLdoc 2.0.</font></p>
901
902	</body>
903	</html>

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

Download in other formats: