source: trunk/SRC/Documentation/idldoc_assistant_output/Utilities/report.html @ 163

Last change on this file since 163 was 163, checked in by navarro, 18 years ago

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)
File size: 5.4 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 dialog_message.pro if there is already some widget
65 active or like message.pro if there is not any widget active.
66 To ask a question whose answer is not yes/no,use xquestion.
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_text">text</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 is activated, return 1 for yes and 0 for no.
84 
85
86   
87    <h3>Parameters</h3>
88   
89
90    <a name="#_report_keyword_text"></a>
91    <h4>text&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     
98     
99     
100    </h4>
101
102     
103 one string or one vector of string. Si le string ne
104 comporte qu''un element, on cherche les eventuels characteres de
105 retour a la ligne: '!C'. If text is set to an array of strings, each
106 array element is displayed as a separate line of text.
107
108   
109   
110
111   
112    <h3>Keywords</h3>
113
114   
115    <a name="#_report_keyword_DEFAULT_NO"></a>
116    <h4>DEFAULT_NO&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
117     
118     
119     
120     
121     
122     
123      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>"Yes"</i></font>
124     
125    </h4>
126
127   
128 Set this keyword to make the "No" button the default selection for
129 "Question" dialog.
130
131   
132    <a name="#_report_keyword_PARENT"></a>
133    <h4>PARENT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
134     
135     
136     
137     
138     
139     
140     
141     
142    </h4>
143
144     
145 same as DIALOG_PARENT de dialog_message.pro
146
147   
148    <a name="#_report_keyword_QUESTION"></a>
149    <h4>QUESTION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
150     
151     
152     
153     
154     
155     
156      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>"Warning"</i></font>
157     
158    </h4>
159
160   
161 Set this keyword to create a "Question" dialog.
162
163   
164    <a name="#_report_keyword_SIMPLE"></a>
165    <h4>SIMPLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
166     
167     
168     
169     
170     
171     
172     
173     
174    </h4>
175
176     
177 activate to print only the message without the name
178 and the line of the routine (defined by calling routine_name)
179
180 
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&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
187     
188     
189     
190     
191     
192     
193     
194     
195    </h4>
196
197     
198 used to pass keywords from dialog_message.pro and message.pro
199
200   
201   
202
203    <h3>Examples</h3> 
204 If there is not any widget activated:
205
206 IDL> help, report('toto tata')
207 % $MAIN$: toto tata
208 <Expression>    INT       =       -1
209 IDL> help, report('does it works ?',/question)
210 does it works ? y/n (default answer is y)
211 <Expression>    BYTE      =    1
212 IDL> help, report('question1: !C does it works ?',/question)
213 question1:
214 does it works ? y/n (default answer is y)
215 <Expression>    BYTE      =    1
216
217 If widgets are already activated, it is the same thing but with widgets!
218
219    <h3>Version history</h3>
220   
221    <h4>Version</h4> $Id: report.pro 136 2006-07-10 15:20:19Z pinsard $
222
223    <h4>History</h4> Sebastien Masson (smasson@lodyc.jussieu.fr)
224                      21/10/1999
225
226   
227
228   
229   
230   
231   
232   
233
234   
235   
236   
237   
238   
239   
240   
241
242    <font size="-3"><p>&nbsp;</p></font>
243    <hr size="1" color="#CCCCCC"/>
244     
245
246   
247
248    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Tue Aug 29 14:50:57 2006.</font></p>
249
250  </body>
251</html>
Note: See TracBrowser for help on using the repository browser.