source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/WIDGET/xquestion.html @ 191

Last change on this file since 191 was 191, checked in by pinsard, 18 years ago

remove format=raw in all html files 2+ : correction for all_plots; suppression of css and correction of Source links in idldoc html output
File size: 7.3 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>xquestion.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="xquestion.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="../../../../ToBeReviewed/WIDGET//xquestion.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="xnotice.html">&lt;&lt;prev file</a> | <a href="xx.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="xquestion.html" target="_TOP">view single page</a> | <a href="./../../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | <a href="#routine_summary">routine</a>&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">ToBeReviewed/WIDGET/</a></h1>
82      <h2 class="pro_file">xquestion.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90
91
92
93 A small widget who ask a question and give an answer.
94   WARNING: For a binary question with yes/no answer use
95   DIALOG_MESSAGE.
96</div>
97
98     
99
100     
101
102     
103
104     
105      <div id="routine_summary">               
106        <h2>Routine summary</h2>
107       
108        <dl>
109         
110          <dt><p><a href="#_xquestion_event">xquestion_event<span class="result">, event</span></a></p><dt>
111          <dd></dd>     
112         
113          <dt><p><a href="#_xquestion"><span class="result">result = </span>xquestion(<span class="result">question, proposedanswer</span>, CHKWIDGET=<span class="result">CHKWIDGET</span>, _extra=<span class="result">_extra</span>)</a></p><dt>
114          <dd> </dd>   
115               
116        </dl>
117      </div>
118     
119
120      <div id="routine_details">
121       
122
123        <div class="routine_details" id="_xquestion_event">
124
125          <h2><a class="top" href="#container">top</a>xquestion_event <span class="categories">
126
127 </span></h2>
128       
129          <p class="header">
130            xquestion_event<span class="result">, <a href="#_xquestion_event_param_event">event</a></span></p>
131       
132          <div class="comments"></div>
133
134          <h3>Return value</h3><div class="preformat">
135 
136 </div>
137
138         
139            <h3>Parameters</h3>
140       
141           
142            <h4 id="_xquestion_event_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
143             
144             
145             
146             
147             
148             
149             
150             
151            </h4>
152       
153          <div class="comments">
154
155</div>
156           
157
158         
159
160         
161
162          <h3>Examples</h3><div class="preformat">
163 
164 </div>
165          <h3>Version history</h3>
166         
167          <h4>Version</h4><div class="preformat"> 
168 $Id: xquestion.pro 163 2006-08-29 12:59:46Z navarro $</div>
169          <h4>History</h4><div class="preformat">
170 
171 </div>
172         
173         
174          <h3>Known issues</h3>
175         
176         
177         
178          <h4>Restrictions</h4><div class="preformat">
179 
180 </div>
181       
182          <h3>Other attributes</h3>
183         
184         
185          <h4>Uses routines</h4><div class="preformat">
186 
187 </div>
188         
189         
190         
191       
192          <h3>Statistics</h3>
193          <table class="statistics">
194            <tr><td>McCabe cyclic</td><td>           1</td></tr>
195            <tr><td>McCabe essential</td><td>           1</td></tr>
196            <tr><td>McCabe modular design</td><td>           1</td></tr>
197          </table>
198         
199       
200        </div>
201       
202
203        <div class="routine_details" id="_xquestion">
204
205          <h2><a class="top" href="#container">top</a>xquestion <span class="categories">
206 Widget
207</span></h2>
208       
209          <p class="header">
210            <span class="result">result = </span>xquestion(<span class="result"><a href="#_xquestion_param_question">question</a>, <a href="#_xquestion_param_proposedanswer">proposedanswer</a></span>, <a href="#_xquestion_keyword_CHKWIDGET">CHKWIDGET</a>=<span class="result">CHKWIDGET</span>, <a href="#_xquestion_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p>
211       
212          <div class="comments">
213</div>
214
215          <h3>Return value</h3><div class="preformat">
216 answer: a string
217</div>
218
219         
220            <h3>Parameters</h3>
221       
222           
223            <h4 id="_xquestion_param_question">question&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
224             
225             
226             
227             
228             
229             
230             
231             
232            </h4>
233       
234          <div class="comments">
235 A scalar string or a array of string. If this
236 argument is set to :
237      + an array of strings: each array element is
238        displayed as a separate line of text.
239      + a scalar string: we are looking for the "separate line
240        character" '!C'
241</div>
242           
243            <h4 id="_xquestion_param_proposedanswer">proposedanswer&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
244             
245             
246             
247             
248             
249              <span class="attr">type:</span> <span class="value">string</span>
250             
251             
252            </h4>
253       
254          <div class="comments">
255 A string proposing a answer
256
257</div>
258           
259
260         
261
262         
263
264            <h3>Keywords</h3>
265           
266            <h4 id="_xquestion_keyword_CHKWIDGET">CHKWIDGET&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
267             
268             
269             
270             
271             
272             
273             
274             
275            </h4>
276       
277            <div class="comments">
278 Active this keyword if you want that xquestion
279 check if managed widget are present. If not, xquestion do not
280 open a widget but print the question in the IDL window.
281</div>
282           
283            <h4 id="_xquestion_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
284             
285             
286             
287             
288             
289             
290             
291             
292            </h4>
293       
294            <div class="comments">
295 Used to pass your keywords
296 </div>
297           
298         
299
300          <h3>Examples</h3><div class="preformat">
301 IDL> help, xquestion('Postscript name')
302 <Expression>    STRING    = 'toto.ps'
303</div>
304          <h3>Version history</h3>
305         
306          <h4>Version</h4><div class="preformat">
307 $Id: xquestion.pro 163 2006-08-29 12:59:46Z navarro $
308</div>
309          <h4>History</h4><div class="preformat">
310 Sebastien Masson (smasson@lodyc.jussieu.fr)
311                      13/10/1999
312</div>
313         
314         
315          <h3>Known issues</h3>
316         
317         
318         
319          <h4>Restrictions</h4><div class="preformat">
320 The function does not return to its caller until the user
321 press "Enter" key in the widget.
322</div>
323       
324         
325         
326         
327         
328         
329         
330         
331       
332          <h3>Statistics</h3>
333          <table class="statistics">
334            <tr><td>McCabe cyclic</td><td>          10</td></tr>
335            <tr><td>McCabe essential</td><td>           1</td></tr>
336            <tr><td>McCabe modular design</td><td>           1</td></tr>
337          </table>
338         
339       
340        </div>
341       
342      </div>
343
344     
345
346      <div id="tagline">Produced by IDLdoc 2.0.</div>
347
348    </div>
349
350  </body>
351</html>
Note: See TracBrowser for help on using the repository browser.