source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/UTILITAIRE/report.html @ 157

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

header improvements + xxx doc
File size: 18.4 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>report.pro (SAXO Documentation)</title>
10
11   
12    <style type="text/css" media="all">
13     
14/* CSS for all files which appear in the "main" viewing area: overview,
15   directory overviews, warnings, index, search, pro files, source
16   code, help, and etc files. */
17
18/* Link styles --------------------------------------------------------------- */
19
20a { text-decoration: none; }
21
22a:link, a:visited { 
23  color: #660000; 
24  border-bottom: 1px dotted #C0C0F0;   
25}
26
27a:hover, a:focus { 
28  color: #993333; 
29  background: #FFFFCC; 
30  border-bottom: 1px dotted #303099; 
31}
32
33
34/* Main styles --------------------------------------------------------------- */
35p.preformat {
36  font-family: Courier;
37}
38p.preformat {
39  font-family: Courier;
40}
41p.preformat {
42  font-family: Courier;
43}
44p.preformat {
45  font-family: Courier;
46}
47p.preformat {
48  font-family: Courier;
49}
50p.preformat {
51  font-family: Courier;
52}
53p.preformat {
54  font-family: Courier;
55}
56p.preformat {
57  font-family: Courier;
58}
59p.preformat {
60  font-family: Courier;
61}
62p.preformat {
63  font-family: Courier;
64}
65p.preformat {
66  font-family: Courier;
67}
68p.preformat {
69  font-family: Courier;
70}
71p.preformat {
72  font-family: Courier;
73}
74p.preformat {
75  font-family: Courier;
76}
77p.preformat {
78  font-family: Courier;
79}
80p.preformat {
81  font-family: Courier;
82}
83p.preformat {
84  font-family: Courier;
85}
86p.preformat {
87  font-family: Courier;
88}
89p.preformat {
90  font-family: Courier;
91}
92p.preformat {
93  font-family: Courier;
94}
95p.preformat {
96  font-family: Courier;
97}
98p.preformat {
99  font-family: Courier;
100}
101
102body {
103  margin: 0;
104  padding: 0;
105  font-size: 10pt;
106  font-family: Verdana, Helvetica, Arial, sans-serif;
107  background-color: #FFFFFF;
108}
109
110p {
111  margin-top: 0.5em;
112  margin-bottom: 0;
113}
114
115#container { margin: 1em; }
116
117code.section { white-space: pre; }
118
119pre.snippet {
120  margin-left: 5%;
121  background: #F0F0F0;
122  border: 1px dashed #999999;
123  width: 43em;
124  padding: 0.5em 0.5em 0.5em 0.5em;
125  white-space: pre;
126}
127
128/* Navbar styles ------------------------------------------------------------- */
129
130#navbar_title {
131  color: #000033;
132  background-color: #F0F0FF;
133  font-family: Arial, Helvetica, sans-serif;
134  padding: 20px 30px;
135  border-bottom: 1px solid #000033;
136}
137
138#navbar_title * {
139  margin: 0;
140  padding: 0;
141}
142
143#navbar_title h1 {
144  letter-spacing: 0.1em;
145  font-variant: small-caps;
146  font-size: 250%;
147  text-indent: -1em;
148  padding-left: 1em; 
149}
150
151#navbar_title h2 {
152  font-size: 110%;
153  font-weight: normal;
154  color: #333399;
155}
156
157#main_navbar table {
158  width: 100%;
159  border-bottom: 1px solid #666699;
160}
161
162#main_navbar td {
163  background: #CCCCFF;
164  font-size: 80%;
165  font-weight: bold;
166  font-family: Arial, Helvetica, sans-serif;
167  border-top: 3px solid #CCCCFF;
168  border-bottom: 3px solid #CCCCFF;
169  padding-left: 6px;
170  padding-right: 6px;
171  margin: 0;
172}
173
174#main_navbar td#selected {
175  background: #CCCCFF;
176  font-size: 80%;
177  font-weight: bold;
178  font-family: Arial, Helvetica, sans-serif;
179  border-top: 3px solid #333399;
180  border-bottom: 3px solid #CCCCFF;
181  padding-left: 6px;
182  padding-right: 6px;
183  margin: 0;
184}
185
186#main_navbar td#flexible {
187  width: 100%;
188  text-align: right;
189  padding-right: 1em;
190  background: #CCCCFF;
191  font-size: 70%;
192  font-weight: normal;
193  font-family: Arial, Helvetica, sans-serif;
194  text-transform: uppercase;
195  border-top: 3px solid #CCCCFF;
196  border-bottom: 3px solid #CCCCFF;
197}
198
199#main_navbar a:link, #main_navbar a:visited { color: #660000; border: 0; }
200
201#main_navbar a:hover, #main_navbar a:focus {
202  color: #FFFF66;
203  background: #CCCCFF;
204  border-bottom: 1px none #606099; 
205  border: 0;
206}
207
208#secondary_navbar {
209  font-size: 80%;
210  font-weight: normal;
211  font-family: Arial, Helvetica, sans-serif;
212  margin-top: 4px;
213  margin-left: 20px;
214  white-space: nowrap;
215}
216
217
218/* Tagline and footer styles ------------------------------------------------- */
219
220div#tagline {
221  margin-top: 6px;
222  border-top: 1px dotted lightsteelblue;
223  padding-top: 6px;
224  font-size: 66%;
225  font-style: italic;
226}
227
228div#footer {
229  margin-top: 6px;
230  border-top: 1px dotted lightsteelblue;
231  padding-top: 6px;
232  font-size: 66%;
233  font-style: italic;
234}
235
236/* Basic data presenation styles -------------------------------------------- */
237
238.index_letter { 
239  font-size: 300%;
240  font-weight: bold;
241  color: #000066; 
242  margin: 0.5em 0 0 -0.1em;
243}
244
245h1, h2, h3, h4 {
246  font-weight: normal;
247  color: #3333CC;
248}
249
250h1 {
251  padding-top: 0.75em;
252  font-size: 160%;
253}
254
255h2 {
256  padding-top: 1em;
257  font-size: 120%;
258  }
259
260h3 {
261  padding-top: 0.75em;
262  margin-bottom: 0.25em;
263  font-size: 100%;
264}
265
266h4 {
267  padding: 0;
268  margin: 0.5em 0 0 0;
269  font-size: 80%;
270}
271
272table.basic {
273  empty-cells: show;
274  margin: 1.5em 1em 0 1em;
275  border: 1px dotted #CFCFFF;
276  font-size: 80%;
277}
278
279table.basic th {
280  background-color: #F0F0FF;
281  font-weight: bold;
282  text-align: left;
283  padding: 4px 1em 4px 4px;
284  border-bottom: 1px dotted #666699;
285}
286
287table.basic td {
288  vertical-align: top;
289  padding: 4px 1em 4px 4px;
290}
291
292dd {
293  margin-bottom: 0.25em;
294  font-size: 80%;
295}
296
297
298/* Warnings styles ----------------------------------------------------------- */
299
300
301#todo dl, #bugs dl { 
302  margin: 0 0 0 1.5em;
303  font-size: 80%;
304}
305
306#todo dd, #bugs dd { 
307  margin-left: 3em; 
308  font-size: 100%;
309}
310
311#undoc table, #obsolete table, #statistics table {
312  width: 80%;
313  margin-left: 2em;
314}
315
316#undoc td, #obsolete td, #statistics td { 
317  padding: 0 0 0 0;
318  font-size: 80%;
319  white-space: nowrap;
320}
321
322#undoc td.docroutine, #obsolete td.obsroutine, #statistics td.statroutine { width: 50%; }
323
324#undoc td.docstat, #statistics td.stat { 
325  width: 50%;
326  text-align: right;
327}
328
329#undoc td.partialdoc, #statistics td.caution { color: #CC6600; }
330
331#undoc td.notdoc, #statistics td.warning { color: #993333; }
332
333/* File + routine styles ----------------------------------------------------- */
334
335h1.directory { 
336  padding: 1em 0 0 0;
337  margin: 0;
338  font-size: 66%;
339}
340
341h1.directory a { border-bottom: 0; }
342
343h2.pro_file { 
344  padding: 0;
345  margin: 0;
346  font-size: 140%;
347}
348
349div#file_attr {
350  padding: 0 1em 0 1em;
351  margin: 1em;
352  background: #F6F6F6;
353  border: 1px dotted #999999;
354}
355
356div#file_attr dt {
357  font-size: 80%;
358  font-weight: bold;
359}
360
361div#file_attr dd {
362  font-size: 80%;
363}
364
365div#class_diagram { 
366  padding: 1em 0 1em 0; 
367  white-space: pre;
368  font-family: 'Courier New';
369}
370
371table#sav_attr { 
372  font-size: 90%; 
373  margin: 1em; 
374  padding: 1em 1em 1em 1em;
375  background: #F6F6F6;
376  border: 1px dotted #999999;
377}
378
379table#sav_attr th { text-align: left; }
380
381table#sav_attr td { vertical-align: top; padding-right: 2em; }
382
383table#sav_attr td.value { width: 20em; padding-right: 0em; font-style: italic; }
384
385p.sav_warning { margin-left: 4em; font-family: 80%; }
386
387table.variables { 
388  font-family: 'Courier New', monospace; 
389  font-size: 80%; 
390  text-indent: -2em; 
391  padding-left: 2em; 
392}
393
394table.variables td.image { width: 64px; }
395
396div#file_comments { white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; white-space: pre; 
397  margin: 2em;
398  font-size: 80%;
399}
400
401
402div.field_summary {
403  padding: 0 1em 0 1em;
404  margin: 1em;
405  background: #FFFFF0;
406  border: 1px dotted #C0C000;
407}
408
409div#routine_summary { 
410  padding: 0 1em 0 1em;
411  margin: 1em;
412  background: #F0F0FF;
413  border: 1px dotted #9999FF;
414}
415
416div.field_summary h2, div#routine_summary h2 { 
417  padding: 0.5em 0 0 0;
418  margin: 0;
419}
420
421div.field_summary table, div.field_summary p { 
422  margin: 1em 1em;
423}
424
425div.field_summary td.name { 
426  vertical-align: top;
427  padding-bottom: 0.25em;
428  color: #3333CC;
429}
430
431div.field_summary span.field_type { 
432  font-weight: normal;
433  font-size: 80%;
434  color: black;
435}
436
437div.field_summary td.comments { 
438  vertical-align: top;
439  padding-left: 2em;
440  font-size: 80%;
441}
442
443p.commaList { 
444  margin: 1em 1em 1em 1em;
445}
446
447span.warning { 
448  color: #CC6633;
449  font-weight: bold;
450  font-size: 66%;
451  text-transform: uppercase;
452}
453
454span.categories { 
455  color: #006633;
456  font-weight: bold;
457  font-size: 66%;
458  text-transform: uppercase;
459}
460
461span.undoc { 
462  color: #FF6633;
463  font-weight: bold;
464  font-size: 80%;
465  text-transform: uppercase;
466}
467
468span.attr { 
469  color: #006633;
470  font-weight: bold;
471  font-size: 80%;
472  text-transform: uppercase;
473}
474
475span.value { 
476  color: #006633;
477  font-weight: normal;
478  text-transform: none;
479}
480
481a.top { 
482  font-weight: bold;
483  font-size: 66%;
484  text-transform: uppercase;
485  float: right;
486}
487
488span.result { 
489  font-family: Verdana, Arial, Helvetica, sans-serif;
490  font-style: italic;
491  font-size: 80%;
492}
493
494div#routine_summary p, div.routine_details p.header { 
495  padding-top: 0.5em;
496  margin-left: 1.5em;
497  text-indent: -1.5em;
498  font-family: 'Courier New', monospace;
499}
500
501div.routine_details { 
502  padding: 0.5em 1em 0.5em 1em;
503  margin: 1em;
504  border: 1px dotted #CCCCCC;
505}
506
507div.routine_details h2 { 
508  padding-top: 0;
509  margin-top: 0;
510}
511
512div.routine_details div.value { 
513  margin: 0 1em 0 1em;
514  font-size: 80%;
515}
516
517div.routine_details div.comments { 
518  font-size: 80%;
519  margin: 0.75em 1em 1em 1em;
520}
521
522div.routine_details div.preformat { 
523  white-space: pre;
524}
525
526table.statistics { 
527  font-size: 80%;
528  margin-left: 1em;
529}
530
531table.statistics td { 
532  padding: 0 2em 0 0;
533}
534
535/* Overview styles ----------------------------------------------------------- */
536
537div.overview { 
538  width: 100%;
539  margin-top: 1em;
540  clear: both;
541}
542
543div.overview table {
544  empty-cells: show;
545  font-size: 90%;
546  margin: 1em 1em 1em 1em;
547  padding: 1em 0.5em 1em 0.5em;
548  background: #F6F6F6;
549  border: 1px dotted #999999;
550}
551
552div.overview td {
553  padding: 3px 1em 3px 1em;
554}
555
556div.overview td.dir {
557  width: 1%;
558  vertical-align: top;
559  text-align: right;
560  padding-right: 1em;
561}
562
563
564/* Navigation list styles for tree structures -------------------------------- */
565
566#tree {
567  text-align: left;
568  font-size: 90%;
569  margin: 0.75em 0 0.75em 0;
570  padding: 0;
571}
572
573#tree ul {
574  text-align: left;
575  margin: 0;
576  padding: 0;
577}
578
579#tree li {
580  margin: 0 0 0 15px;
581  padding: 0;
582  list-style-type: none;
583}
584
585#tree .symbols {
586  float: left;
587  width: 12px;
588  height: 1em;
589  padding-left: 4px;
590  background-position: 0 100%;
591  background-repeat: no-repeat;
592}
593
594/* Search styles ------------------------------------------------------------- */
595
596input.writein { 
597  padding-left: 0.5em;
598  border: 1px solid #CCCCCC;
599  font-family: 'Courier New';
600  background: #FFFFF3;
601}
602
603#search form { 
604  margin-left: 2em;
605}
606
607#search table { 
608  margin: 1em 1em 0 2em;
609  padding: 1em 2em 1em 2em;
610  background: #F6F6F6;
611  border: 1px dotted #999999;
612}
613
614#search tr { 
615  text-align: center;
616}
617
618#search td { 
619  font-size: 80%; 
620  text-align: left;
621}
622
623#search td * { 
624  vertical-align: middle;
625}
626
627#search p { 
628  font-size: 66%;
629  margin: 0 3em 2em 3em;
630}
631
632/* Help styles --------------------------------------------------------------- */
633
634div.toc { 
635  padding: 0 1em 0 1em;
636  margin: 1em;
637  background: #F0F0FF;
638  border: 1px dotted #9999FF; 
639  width: 19em;
640}
641
642div.right { 
643  float: right;
644  width: 22em;
645}
646
647ol.toc { 
648  list-style-type: upper-roman;
649}
650
651ol.toc ol { 
652  padding-left: 3em;
653  margin-left: 0;
654  list-style-type: lower-alpha;
655}
656
657dl.variables dt { font-size: 80%; }
658dl.variables dd { margin-bottom: 0.5em; }
659
660    </style>
661    <style type="text/css" media="print">
662      #navbar_title { 
663  background-color: #FFFFFF; 
664}
665
666#main_navbar td {
667  background: #FFFFFF;
668  border-top: 0.25em solid #FFFFFF;
669  border-bottom: 0.25em solid #FFFFFF;
670}
671
672#main_navbar td#selected {
673  background: #FFFFFF;
674  border-top: 0.25em solid #333399;
675  border-bottom: 0.25em solid #FFFFFF;
676}
677
678#main_navbar td#flexible {
679  background: #FFFFFF;
680  border-top: 0.25em solid #FFFFFF;
681  border-bottom: 0.25em solid #FFFFFF;
682}
683
684#secondary_navbar {
685  display: none;
686}
687
688    </style>
689   
690
691    <script type="text/javascript">
692      function setTitle() {
693        parent.document.title="report.pro (SAXO Documentation)";
694      }
695    </script>
696  </head>
697
698  <body onload="setTitle();">
699
700    <div id="navbar_title">
701  <h1>SAXO Documentation</h1>
702</div>
703
704
705<div id="main_navbar">
706
707  <table cellspacing="0">
708    <tr>
709     
710      <td><a href="./../../overview.html?format=raw" title="Overview of library">Overview</a></td>
711     
712
713     
714      <td >Directory</td>
715     
716
717     
718      <td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
719     
720
721     
722      <td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
723     
724
725     
726      <td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td>
727     
728
729      <td id="selected">File</td>
730
731     
732      <td >Source</td>
733     
734
735     
736      <td><a href="./../../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td>
737     
738
739      <td >Etc</td>
740
741      <td id="flexible">Developer&nbsp;documentation</td>
742    </tr>
743  </table>
744
745</div>
746
747<div id="secondary_navbar">
748
749<a href="pwd.html?format=raw">&lt;&lt;prev file</a> | <a href="routine_name.html?format=raw">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="report.html?format=raw" target="_TOP">view single page</a> | <a href="./../../index.html?format=raw" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
750
751</div>
752
753
754    <div id="container">
755
756      <h1 class="directory"><a href="directory-overview.html?format=raw">ToBeReviewed/UTILITAIRE/</a></h1>
757      <h2 class="pro_file">report.pro</h2>
758
759      <div id="file_attr">
760        <dl>
761        </dl>
762      </div>
763
764      <div id="file_comments"></div>
765
766     
767
768     
769
770     
771
772     
773
774      <div id="routine_details">
775       
776
777        <div class="routine_details" id="_report">
778
779          <h2><a class="top" href="#container">top</a>report </h2>
780       
781          <p class="header">
782            <span class="result">result = </span>report(<span class="result"><a href="#_report_param_text">text</a></span>, <a href="#_report_keyword_DEFAULT_NO">DEFAULT_NO</a>=<span class="result">DEFAULT_NO</span>, <a href="#_report_keyword_PARENT">PARENT</a>=<span class="result">PARENT</span>, <a href="#_report_keyword_QUESTION">QUESTION</a>=<span class="result">QUESTION</span>, <a href="#_report_keyword_SIMPLE">SIMPLE</a>=<span class="result">SIMPLE</span>, <a href="#_report_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p>
783       
784          <div class="comments">
785 NAME:report
786
787 PURPOSE: comme dialog_message.pro si il y a deja des widgets actives
788 ou comme message.pro si il n''y a pas de widgets actives. pour poser
789 des question dont la reponse n''est pas oui/non utiliser xquestion
790
791 CATEGORY:
792
793 CALLING SEQUENCE:res = report(text)
794 
795 INPUTS: text: un string on un vecteur de string. Si le string ne
796 comporte qu''un element, on cherche les eventuels characteres de
797 retour a la ligne: '!C'. If text is set to an array of strings, each
798 array element is displayed as a separate line of text.
799
800 KEYWORD PARAMETERS:
801         SIMPLE: activate to print only the message without the name
802             and the line of the routine (defined by calling routine_name)
803
804 ceux dialog_message.pro et message.pro avec en +
805 PARENT qui fait la meme chose que DIALOG_PARENT de dialog_message.pro
806
807 OUTPUTS: -1 si le mot cle QUESTION n''est pas activer
808          si le mot cle est active la fonction retourne 1 pour yes et
809          0 pour no.
810
811 COMMON BLOCKS:
812
813 SIDE EFFECTS:
814
815 RESTRICTIONS:
816
817 EXAMPLE:
818 
819 si aucun widget n''est active:
820
821     IDL> help, report('toto tata')
822     % $MAIN$: toto tata
823     <Expression>    INT       =       -1
824     IDL> help, report('ca marche ?',/question)
825     ca marche ? y/n (default answer is y)
826     <Expression>    BYTE      =    1
827     IDL> help, report('question1: !C ca marche ?',/question)
828     question1:
829     ca marche ? y/n (default answer is y)
830     <Expression>    BYTE      =    1
831
832 si des widgets sont deja actives, c''est la meme chose mais avec des
833 widgets!
834</div>
835
836         
837
838         
839            <h3>Parameters</h3>
840       
841           
842            <h4 id="_report_param_text">text&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
843             
844             
845             
846             
847             
848             
849             
850             
851            </h4>
852       
853          <div class="comments"></div>
854           
855
856         
857
858         
859
860            <h3>Keywords</h3>
861           
862            <h4 id="_report_keyword_DEFAULT_NO">DEFAULT_NO&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
863             
864             
865             
866             
867             
868             
869             
870             
871            </h4>
872       
873            <div class="comments"></div>
874           
875            <h4 id="_report_keyword_PARENT">PARENT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
876             
877             
878             
879             
880             
881             
882             
883             
884            </h4>
885       
886            <div class="comments"></div>
887           
888            <h4 id="_report_keyword_QUESTION">QUESTION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
889             
890             
891             
892             
893             
894             
895             
896             
897            </h4>
898       
899            <div class="comments"></div>
900           
901            <h4 id="_report_keyword_SIMPLE">SIMPLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
902             
903             
904             
905             
906             
907             
908             
909             
910            </h4>
911       
912            <div class="comments"></div>
913           
914            <h4 id="_report_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
915             
916             
917             
918             
919             
920             
921             
922             
923            </h4>
924       
925            <div class="comments"></div>
926           
927         
928
929         
930         
931         
932         
933         
934         
935         
936         
937         
938         
939         
940         
941       
942         
943         
944         
945         
946         
947         
948         
949       
950         
951       
952        </div>
953       
954      </div>
955
956     
957
958      <div id="tagline">Produced by IDLdoc 2.0.</div>
959
960    </div>
961
962  </body>
963</html>
Note: See TracBrowser for help on using the repository browser.