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

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

update documentation
File size: 7.1 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    <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" />
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     
35      <td><a href="./../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../Utilities//report.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
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
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>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">Utilities/</a></h1>
82      <h2 class="pro_file">report.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
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.
92 To ask a question whose answer is not yes/no, use <a href="..//ToBeReviewed/WIDGET/xquestion.html">xquestion</a>.
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">
111            <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>
112       
113          <div class="comments">
114</div>
115
116          <h3>Return value</h3><div class="preformat">
117 -1 if the keyword QUESTION is not activated
118 If the keyword QUESTION is activated, return 1 for yes and 0 for no.
119</div>
120
121         
122            <h3>Parameters</h3>
123       
124           
125            <h4 id="_report_param_textin">textin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126              <span class="attr">in</span>
127             
128             
129              <span class="attr">required</span>
130             
131              <span class="attr">type:</span> <span class="value">scalar string or arrays of string</span>
132             
133             
134            </h4>
135       
136          <div class="comments">
137 If textin is a scalar string, we look for the line feed character "!C".
138 If textin is set to an array of strings, each
139 array element is displayed as a separate line of text.
140</div>
141           
142
143         
144
145         
146
147            <h3>Keywords</h3>
148           
149            <h4 id="_report_keyword_DEFAULT_NO">DEFAULT_NO&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
150             
151             
152             
153             
154             
155             
156              <span class="attr">default:</span> <span class="value">"Yes"</span>
157             
158            </h4>
159       
160            <div class="comments">
161 Set this keyword to make the "No" button the default selection for
162 "Question" dialog.
163</div>
164           
165            <h4 id="_report_keyword_PARENT">PARENT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
166             
167             
168             
169             
170             
171             
172             
173             
174            </h4>
175       
176            <div class="comments">
177 same as DIALOG_PARENT of <a href="/Applications/itt/idl64/help/online_help/DIALOG_MESSAGE.html">DIALOG_MESSAGE</a>
178</div>
179           
180            <h4 id="_report_keyword_QUESTION">QUESTION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
181             
182             
183             
184             
185             
186             
187              <span class="attr">default:</span> <span class="value">"Warning"</span>
188             
189            </h4>
190       
191            <div class="comments">
192 Set this keyword to create a "Question" dialog.
193</div>
194           
195            <h4 id="_report_keyword_SIMPLE">SIMPLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
196             
197             
198             
199             
200             
201             
202             
203             
204            </h4>
205       
206            <div class="comments">
207 activate to print only the message without the name
208 and the line of the routine (defined by calling <a href="..//Utilities/routine_name.html">routine_name</a>)
209 or++
210 Activate to print the error message without printing the routine name with
211 its full path.
212</div>
213           
214            <h4 id="_report_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
215             
216             
217             
218             
219             
220             
221             
222             
223            </h4>
224       
225            <div class="comments">
226 Used to pass keywords to <a href="/Applications/itt/idl64/help/online_help/DIALOG_MESSAGE.html">DIALOG_MESSAGE</a> and
227 <a href="/Applications/itt/idl64/help/online_help/MESSAGE.html">MESSAGE</a>
228</div>
229           
230         
231
232          <h3>Examples</h3><div class="preformat">
233 If there is not any widget activated:
234
235 IDL> help, report('toto tata')
236 % $MAIN$: toto tata
237 <Expression>    INT       =       -1
238 IDL> help, report('does it works ?',/question)
239 does it works ? y/n (default answer is y)
240 <Expression>    BYTE      =    1
241 IDL> help, report('question1: !C does it works ?',/question)
242 question1:
243 does it works ? y/n (default answer is y)
244 <Expression>    BYTE      =    1
245
246 If widgets are already activated, it is the same thing but with widgets!
247</div>
248          <h3>Version history</h3>
249         
250          <h4>Version</h4><div class="preformat">
251 $Id: report.pro 327 2007-12-13 16:22:35Z pinsard $
252</div>
253          <h4>History</h4><div class="preformat">
254 Sebastien Masson (smasson@lodyc.jussieu.fr)
255                      21/10/1999
256</div>
257         
258         
259         
260         
261         
262         
263         
264       
265         
266         
267         
268         
269         
270         
271         
272       
273          <h3>Statistics</h3>
274          <table class="statistics">
275            <tr><td>McCabe cyclic</td><td>          17</td></tr>
276            <tr><td>McCabe essential</td><td>           1</td></tr>
277            <tr><td>McCabe modular design</td><td>           1</td></tr>
278          </table>
279         
280       
281        </div>
282       
283      </div>
284
285     
286
287      <div id="tagline">Produced by IDLdoc 2.0.</div>
288
289    </div>
290
291  </body>
292</html>
Note: See TracBrowser for help on using the repository browser.