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

Last change on this file since 163 was 163, checked in by navarro, 18 years ago

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)

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