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

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation
File size: 7.1 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">
[338]90 Like <a href="/Applications/itt/idl64/help/online_help/DIALOG_MESSAGE.html">DIALOG_MESSAGE</a> if there is already some widget
91 active or like <a href="/Applications/itt/idl64/help/online_help/MESSAGE.html">MESSAGE</a> if there is not any widget active.
[402]92
[290]93 To ask a question whose answer is not yes/no, use <a href="..//ToBeReviewed/WIDGET/xquestion.html">xquestion</a>.
[138]94</div>
95
96     
97
98     
99
100     
101
102     
103
104      <div id="routine_details">
105       
106
107        <div class="routine_details" id="_report">
108
109          <h2><a class="top" href="#container">top</a>report </h2>
110       
111          <p class="header">
[290]112            <span class="result">result = </span>report(<span class="result"><a href="#_report_param_textin">textin</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]113       
114          <div class="comments">
115</div>
116
[234]117          <h3>Return value</h3><div class="preformat">
[138]118 -1 if the keyword QUESTION is not activated
[234]119 If the keyword QUESTION is activated, return 1 for yes and 0 for no.
120</div>
[138]121
122         
123            <h3>Parameters</h3>
124       
125           
[290]126            <h4 id="_report_param_textin">textin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[138]127              <span class="attr">in</span>
128             
129             
130              <span class="attr">required</span>
131             
[242]132              <span class="attr">type:</span> <span class="value">scalar string or arrays of string</span>
[138]133             
134             
135            </h4>
136       
[234]137          <div class="comments">
[338]138 If textin is a scalar string, we look for the line feed character "!C".
[402]139
[338]140 If textin is set to an array of strings, each
[138]141 array element is displayed as a separate line of text.
142</div>
143           
144
145         
146
147         
148
149            <h3>Keywords</h3>
150           
151            <h4 id="_report_keyword_DEFAULT_NO">DEFAULT_NO&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
152             
153             
154             
155             
156             
157             
158              <span class="attr">default:</span> <span class="value">"Yes"</span>
159             
160            </h4>
161       
162            <div class="comments">
[234]163 Set this keyword to make the "No" button the default selection for
164 "Question" dialog.
[138]165</div>
166           
167            <h4 id="_report_keyword_PARENT">PARENT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
168             
169             
170             
171             
172             
173             
174             
175             
176            </h4>
177       
[234]178            <div class="comments">
[338]179 same as DIALOG_PARENT of <a href="/Applications/itt/idl64/help/online_help/DIALOG_MESSAGE.html">DIALOG_MESSAGE</a>
[138]180</div>
181           
182            <h4 id="_report_keyword_QUESTION">QUESTION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
183             
184             
185             
186             
187             
188             
189              <span class="attr">default:</span> <span class="value">"Warning"</span>
190             
191            </h4>
192       
193            <div class="comments">
194 Set this keyword to create a "Question" dialog.
195</div>
196           
197            <h4 id="_report_keyword_SIMPLE">SIMPLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
198             
199             
200             
201             
202             
203             
204             
205             
206            </h4>
207       
[234]208            <div class="comments">
[138]209 activate to print only the message without the name
[290]210 and the line of the routine (defined by calling <a href="..//Utilities/routine_name.html">routine_name</a>)
[242]211 or++
[234]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">
[338]228 Used to pass keywords to <a href="/Applications/itt/idl64/help/online_help/DIALOG_MESSAGE.html">DIALOG_MESSAGE</a> and
229 <a href="/Applications/itt/idl64/help/online_help/MESSAGE.html">MESSAGE</a>
[138]230</div>
231           
232         
233
[234]234          <h3>Examples</h3><div class="preformat">
[138]235 If there is not any widget activated:
236
[402]237   IDL> help, report('toto tata')
[138]238 % $MAIN$: toto tata
239 <Expression>    INT       =       -1
[402]240   IDL> help, report('does it works ?',/question)
[138]241 does it works ? y/n (default answer is y)
242 <Expression>    BYTE      =    1
[402]243   IDL> help, report('question1: !C does it works ?',/question)
[138]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">
[402]253 $Id: report.pro 375 2008-08-08 15:55:40Z 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">
[321]277            <tr><td>McCabe cyclic</td><td>          17</td></tr>
[163]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>
[249]294</html>
Note: See TracBrowser for help on using the repository browser.