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