source: trunk/SRC/Documentation/idldoc_assistant_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: 5.8 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>report.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="pwd.html"><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="routine_name.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Utilities/</font></h1>
58    <h2>report.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Like <a href="/Applications/itt/idl64/help/online_help/DIALOG_MESSAGE.html">DIALOG_MESSAGE</a> if there is already some widget
65 active or like <a href="/Applications/itt/idl64/help/online_help/MESSAGE.html">MESSAGE</a> if there is not any widget active.
66 To ask a question whose answer is not yes/no, use <a href="..//ToBeReviewed/WIDGET/xquestion.html">xquestion</a>.
67
68
69   
70
71     
72      <a name="#_report"></a>
73
74      <h2>report  </h2>
75
76      <p><font face="Courier"><i>result = </i>report(<i><a href="#_report_keyword_textin">textin</a></i>, <a href="#_report_keyword_DEFAULT_NO">DEFAULT_NO</a>=<i>DEFAULT_NO</i>, <a href="#_report_keyword_PARENT">PARENT</a>=<i>PARENT</i>, <a href="#_report_keyword_QUESTION">QUESTION</a>=<i>QUESTION</i>, <a href="#_report_keyword_SIMPLE">SIMPLE</a>=<i>SIMPLE</i>, <a href="#_report_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
77
78   
79
80
81    <h3>Return value</h3>
82 -1 if the keyword QUESTION is not activated
83 If the keyword QUESTION is activated, return 1 for yes and 0 for no.
84
85
86   
87    <h3>Parameters</h3>
88   
89
90    <a name="#_report_keyword_textin"></a>
91    <h4>textin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
92      <font size="-1" color="#006633">in</font>
93     
94     
95      <font size="-1" color="#006633">required</font>
96     
97      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string or arrays of string</i></font>
98     
99     
100    </h4>
101
102   
103 If textin is a scalar string, we look for the line feed character "!C".
104 If textin is set to an array of strings, each
105 array element is displayed as a separate line of text.
106
107   
108   
109
110   
111    <h3>Keywords</h3>
112
113   
114    <a name="#_report_keyword_DEFAULT_NO"></a>
115    <h4>DEFAULT_NO&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
116     
117     
118     
119     
120     
121     
122      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>"Yes"</i></font>
123     
124    </h4>
125
126   
127 Set this keyword to make the "No" button the default selection for
128 "Question" dialog.
129
130   
131    <a name="#_report_keyword_PARENT"></a>
132    <h4>PARENT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
133     
134     
135     
136     
137     
138     
139     
140     
141    </h4>
142
143   
144 same as DIALOG_PARENT of <a href="/Applications/itt/idl64/help/online_help/DIALOG_MESSAGE.html">DIALOG_MESSAGE</a>
145
146   
147    <a name="#_report_keyword_QUESTION"></a>
148    <h4>QUESTION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
149     
150     
151     
152     
153     
154     
155      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>"Warning"</i></font>
156     
157    </h4>
158
159   
160 Set this keyword to create a "Question" dialog.
161
162   
163    <a name="#_report_keyword_SIMPLE"></a>
164    <h4>SIMPLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
165     
166     
167     
168     
169     
170     
171     
172     
173    </h4>
174
175   
176 activate to print only the message without the name
177 and the line of the routine (defined by calling <a href="..//Utilities/routine_name.html">routine_name</a>)
178 or++
179 Activate to print the error message without printing the routine name with
180 its full path.
181
182   
183    <a name="#_report_keyword__EXTRA"></a>
184    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
185     
186     
187     
188     
189     
190     
191     
192     
193    </h4>
194
195   
196 Used to pass keywords to <a href="/Applications/itt/idl64/help/online_help/DIALOG_MESSAGE.html">DIALOG_MESSAGE</a> and
197 <a href="/Applications/itt/idl64/help/online_help/MESSAGE.html">MESSAGE</a>
198
199   
200   
201
202    <h3>Examples</h3><pre>
203 If there is not any widget activated:
204
205 IDL> help, report('toto tata')
206 % $MAIN$: toto tata
207 <Expression>    INT       =       -1
208 IDL> help, report('does it works ?',/question)
209 does it works ? y/n (default answer is y)
210 <Expression>    BYTE      =    1
211 IDL> help, report('question1: !C does it works ?',/question)
212 question1:
213 does it works ? y/n (default answer is y)
214 <Expression>    BYTE      =    1
215
216 If widgets are already activated, it is the same thing but with widgets!
217
218    </pre><h3>Version history</h3>
219   
220    <h4>Version</h4>
221 $Id: report.pro 327 2007-12-13 16:22:35Z pinsard $
222
223    <h4>History</h4>
224 Sebastien Masson (smasson@lodyc.jussieu.fr)
225                      21/10/1999
226
227   
228
229   
230   
231   
232   
233   
234
235   
236   
237   
238   
239   
240   
241   
242
243    <font size="-3"><p>&nbsp;</p></font>
244    <hr size="1" color="#CCCCCC"/>
245     
246
247   
248
249    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
250
251  </body>
252</html>
Note: See TracBrowser for help on using the repository browser.