source: trunk/SRC/Documentation/idldoc_html_output/Utilities/report.html @ 234

Last change on this file since 234 was 234, checked in by pinsard, 17 years ago

new idldoc html and assistant outputs
File size: 6.7 KB
RevLine 
[138]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   
[191]12    <link rel="stylesheet" type="text/css" media="all" href="./../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../main_files_print.css" />
[138]14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="report.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
[189]35      <td><a href="./../overview.html" title="Overview of library">Overview</a></td>
[138]36     
37
38     
39      <td >Directory</td>
40     
41
42     
[189]43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
[138]44     
45
46     
[189]47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
[138]48     
49
50     
[189]51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
[138]52     
53
54      <td id="selected">File</td>
55
56     
[189]57      <td><a href="../../../Utilities//report.pro" title="Source code of a file">Source</a></td>
[138]58     
59
60     
[189]61      <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
[138]62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
[189]74<a href="pwd.html">&lt;&lt;prev file</a> | <a href="routine_name.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="report.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
[138]75
76</div>
77
78
79    <div id="container">
80
[189]81      <h1 class="directory"><a href="directory-overview.html">Utilities/</a></h1>
[138]82      <h2 class="pro_file">report.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
[234]89      <div id="file_comments">
90 Like <proidl>dialog_message</proidl> if there is already some widget
91 active or like <proidl>message</proidl> if there is not any widget active.
[138]92 To ask a question whose answer is not yes/no,use xquestion.
93</div>
94
95     
96
97     
98
99     
100
101     
102
103      <div id="routine_details">
104       
105
106        <div class="routine_details" id="_report">
107
108          <h2><a class="top" href="#container">top</a>report </h2>
109       
110          <p class="header">
[234]111            <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>
[138]112       
113          <div class="comments">
114</div>
115
[234]116          <h3>Return value</h3><div class="preformat">
[138]117 -1 if the keyword QUESTION is not activated
[234]118 If the keyword QUESTION is activated, return 1 for yes and 0 for no.
119</div>
[138]120
121         
122            <h3>Parameters</h3>
123       
124           
125            <h4 id="_report_param_text">text&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126              <span class="attr">in</span>
127             
128             
129              <span class="attr">required</span>
130             
131             
132             
133             
134            </h4>
135       
[234]136          <div class="comments">
[138]137 one string or one vector of string. Si le string ne
[234]138 comporte qu''un element, on cherche les eventuels caracteres de
[138]139 retour a la ligne: '!C'. If text is set to an array of strings, each
140 array element is displayed as a separate line of text.
141</div>
142           
143
144         
145
146         
147
148            <h3>Keywords</h3>
149           
150            <h4 id="_report_keyword_DEFAULT_NO">DEFAULT_NO&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
151             
152             
153             
154             
155             
156             
157              <span class="attr">default:</span> <span class="value">"Yes"</span>
158             
159            </h4>
160       
161            <div class="comments">
[234]162 Set this keyword to make the "No" button the default selection for
163 "Question" dialog.
[138]164</div>
165           
166            <h4 id="_report_keyword_PARENT">PARENT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
167             
168             
169             
170             
171             
172             
173             
174             
175            </h4>
176       
[234]177            <div class="comments">
178 same as DIALOG_PARENT of <proidl>dialog_message</proidl>
[138]179</div>
180           
181            <h4 id="_report_keyword_QUESTION">QUESTION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
182             
183             
184             
185             
186             
187             
188              <span class="attr">default:</span> <span class="value">"Warning"</span>
189             
190            </h4>
191       
192            <div class="comments">
193 Set this keyword to create a "Question" dialog.
194</div>
195           
196            <h4 id="_report_keyword_SIMPLE">SIMPLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
197             
198             
199             
200             
201             
202             
203             
204             
205            </h4>
206       
[234]207            <div class="comments">
[138]208 activate to print only the message without the name
209 and the line of the routine (defined by calling routine_name)
210
[234]211
212 Activate to print the error message without printing the routine name with
[138]213 its full path.
214</div>
215           
[234]216            <h4 id="_report_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[138]217             
218             
219             
220             
221             
222             
223             
224             
225            </h4>
226       
[234]227            <div class="comments">
228 Used to pass keywords to <proidl>dialog_message</proidl> and
229 <proidl>message</proidl>
[138]230</div>
231           
232         
233
[234]234          <h3>Examples</h3><div class="preformat">
[138]235 If there is not any widget activated:
236
237 IDL> help, report('toto tata')
238 % $MAIN$: toto tata
239 <Expression>    INT       =       -1
240 IDL> help, report('does it works ?',/question)
241 does it works ? y/n (default answer is y)
242 <Expression>    BYTE      =    1
243 IDL> help, report('question1: !C does it works ?',/question)
244 question1:
245 does it works ? y/n (default answer is y)
246 <Expression>    BYTE      =    1
247
248 If widgets are already activated, it is the same thing but with widgets!
249</div>
250          <h3>Version history</h3>
251         
[234]252          <h4>Version</h4><div class="preformat">
253 $Id: report.pro 232 2007-03-20 16:59:36Z pinsard $
[138]254</div>
[234]255          <h4>History</h4><div class="preformat">
256 Sebastien Masson (smasson@lodyc.jussieu.fr)
[138]257                      21/10/1999
258</div>
259         
260         
261         
262         
263         
264         
265         
266       
267         
268         
269         
270         
271         
272         
273         
274       
[163]275          <h3>Statistics</h3>
276          <table class="statistics">
277            <tr><td>McCabe cyclic</td><td>          15</td></tr>
278            <tr><td>McCabe essential</td><td>           1</td></tr>
279            <tr><td>McCabe modular design</td><td>           1</td></tr>
280          </table>
[138]281         
282       
283        </div>
284       
285      </div>
286
287     
288
289      <div id="tagline">Produced by IDLdoc 2.0.</div>
290
291    </div>
292
293  </body>
[234]294</html>
Note: See TracBrowser for help on using the repository browser.