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

Last change on this file since 290 was 290, checked in by smasson, 17 years ago

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