Context Navigation

source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/UTILITAIRE/report.html @ 89

Last change on this file since 89 was 89, checked in by pinsard, 18 years ago
add idldoc html output. see Documentation/idldoc_html_output/index.html
File size: 6.0 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 (IDLdoc API 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 (IDLdoc API documentation)";
19	}
20	</script>
21	</head>
22
23	<body onload="setTitle();">
24
25	<div id="navbar_title">
26	<h1>IDLdoc API 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?format=raw" title="Overview of library">Overview</a></td>
36
37
38
39	<td >Directory</td>
40
41
42
43	<td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44
45
46
47	<td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48
49
50
51	<td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td>
52
53
54	<td id="selected">File</td>
55
56
57	<td >Source</td>
58
59
60
61	<td><a href="./../../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td>
62
63
64	<td >Etc</td>
65
66	<td id="flexible">Developer documentation</td>
67	</tr>
68	</table>
69
70	</div>
71
72	<div id="secondary_navbar">
73
74	<a href="pwd.html"><<prev file</a> \| <a href="routine_name.html">next file >></a>    <a href="report.html" target="_TOP">view single page</a> \| <a href="./../../index.html?format=raw" target="_TOP">view frames</a>    summary: fields \| routine    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?format=raw">ToBeReviewed/UTILITAIRE/</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"></div>
90
91
92
93
94
95
96
97
98
99	<div id="routine_details">
100
101
102	<div class="routine_details" id="_report">
103
104	<h2><a class="top" href="#container">top</a>report </h2>
105
106	<p class="header">
107	<span class="result">result = </span>report(<span class="result"><a href="#_report_param_text">text</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>
108
109	<div class="comments">
110	NAME:report
111
112	PURPOSE: comme dialog_message.pro si il y a deja des widgets actives
113	ou comme message.pro si il n''y a pas de widgets actives. pour poser
114	des question dont la reponse n''est pas oui/non utiliser xquestion
115
116	CATEGORY:
117
118	CALLING SEQUENCE:res = report(text)
119
120	INPUTS: text: un string on un vecteur de string. Si le string ne
121	comporte qu''un element, on cherche les eventuels characteres de
122	retour a la ligne: '!C'. If text is set to an array of strings, each
123	array element is displayed as a separate line of text.
124
125	KEYWORD PARAMETERS:
126	SIMPLE: activate to print only the message without the name
127	and the line of the routine (defined by calling routine_name)
128
129	ceux dialog_message.pro et message.pro avec en +
130	PARENT qui fait la meme chose que DIALOG_PARENT de dialog_message.pro
131
132	OUTPUTS: -1 si le mot cle QUESTION n''est pas activer
133	si le mot cle est active la fonction retourne 1 pour yes et
134	0 pour no.
135
136	COMMON BLOCKS:
137
138	SIDE EFFECTS:
139
140	RESTRICTIONS:
141
142	EXAMPLE:
143
144	si aucun widget n''est active:
145
146	IDL> help, report('toto tata')
147	% $MAIN$: toto tata
148	<Expression> INT = -1
149	IDL> help, report('ca marche ?',/question)
150	ca marche ? y/n (default answer is y)
151	<Expression> BYTE = 1
152	IDL> help, report('question1: !C ca marche ?',/question)
153	question1:
154	ca marche ? y/n (default answer is y)
155	<Expression> BYTE = 1
156
157	si des widgets sont deja actives, c''est la meme chose mais avec des
158	widgets!
159	</div>
160
161
162
163
164	<h3>Parameters</h3>
165
166
167	<h4 id="_report_param_text">text
168
169
170
171
172
173
174
175
176	</h4>
177
178	<div class="comments"></div>
179
180
181
182
183
184
185	<h3>Keywords</h3>
186
187	<h4 id="_report_keyword_DEFAULT_NO">DEFAULT_NO
188
189
190
191
192
193
194
195
196	</h4>
197
198	<div class="comments"></div>
199
200	<h4 id="_report_keyword_PARENT">PARENT
201
202
203
204
205
206
207
208
209	</h4>
210
211	<div class="comments"></div>
212
213	<h4 id="_report_keyword_QUESTION">QUESTION
214
215
216
217
218
219
220
221
222	</h4>
223
224	<div class="comments"></div>
225
226	<h4 id="_report_keyword_SIMPLE">SIMPLE
227
228
229
230
231
232
233
234
235	</h4>
236
237	<div class="comments"></div>
238
239	<h4 id="_report_keyword__extra">_extra
240
241
242
243
244
245
246
247
248	</h4>
249
250	<div class="comments"></div>
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277	</div>
278
279	</div>
280
281
282
283	<div id="tagline">Produced by IDLdoc 2.0.</div>
284
285	</div>
286
287	</body>
288	</html>

Note: See TracBrowser for help on using the repository browser.

Download in other formats: