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

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation

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