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

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation
File size: 7.5 KB
RevLine 
[89]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>
[104]9    <title>xquestion.pro (SAXO Documentation)</title>
[89]10
11   
[191]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" />
[89]14   
15
16    <script type="text/javascript">
17      function setTitle() {
[104]18        parent.document.title="xquestion.pro (SAXO Documentation)";
[89]19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
[104]26  <h1>SAXO Documentation</h1>
[89]27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
[189]35      <td><a href="./../../overview.html" title="Overview of library">Overview</a></td>
[89]36     
37
38     
39      <td >Directory</td>
40     
41
42     
[189]43      <td><a href="./../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
[89]44     
45
46     
[189]47      <td><a href="./../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
[89]48     
49
50     
[189]51      <td><a href="./../../search-page.html" title="Search library">Search</a></td>
[89]52     
53
54      <td id="selected">File</td>
55
56     
[189]57      <td><a href="../../../../ToBeReviewed/WIDGET//xquestion.pro" title="Source code of a file">Source</a></td>
[89]58     
59
60     
[189]61      <td><a href="./../../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
[89]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
[189]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>
[89]75
76</div>
77
78
79    <div id="container">
80
[189]81      <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/WIDGET/</a></h1>
[89]82      <h2 class="pro_file">xquestion.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
[151]89      <div id="file_comments">
[157]90
91
[151]92 A small widget who ask a question and give an answer.
[242]93   WARNING: For a binary question with yes/no, answer use
[338]94   <a href="/Applications/itt/idl64/help/online_help/DIALOG_MESSAGE.html">DIALOG_MESSAGE</a>.
[151]95</div>
[89]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>
[234]110          <dd> </dd>   
[89]111         
[234]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>
[151]113          <dd> </dd>   
[89]114               
115        </dl>
116      </div>
117     
118
119      <div id="routine_details">
120       
121
122        <div class="routine_details" id="_xquestion_event">
123
[157]124          <h2><a class="top" href="#container">top</a>xquestion_event <span class="categories">
[234]125</span></h2>
[89]126       
127          <p class="header">
128            xquestion_event<span class="result">, <a href="#_xquestion_event_param_event">event</a></span></p>
129       
[234]130          <div class="comments">
131</div>
[89]132
[157]133          <h3>Return value</h3><div class="preformat">
[234]134</div>
[89]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       
[157]151          <div class="comments">
152</div>
[89]153           
154
155         
156
157         
158
[157]159          <h3>Examples</h3><div class="preformat">
[234]160</div>
[157]161          <h3>Version history</h3>
[89]162         
[234]163          <h4>Version</h4><div class="preformat">
[402]164 $Id: xquestion.pro 371 2008-08-07 09:32:02Z pinsard $
[338]165</div>
[157]166          <h4>History</h4><div class="preformat">
[234]167</div>
[89]168         
169         
[157]170          <h3>Known issues</h3>
[89]171         
172         
173         
[157]174          <h4>Restrictions</h4><div class="preformat">
[234]175</div>
[89]176       
[157]177          <h3>Other attributes</h3>
[89]178         
179         
[157]180          <h4>Uses routines</h4><div class="preformat">
[234]181</div>
[89]182         
183         
184         
185       
[163]186          <h3>Statistics</h3>
187          <table class="statistics">
188            <tr><td>McCabe cyclic</td><td>           1</td></tr>
189            <tr><td>McCabe essential</td><td>           1</td></tr>
190            <tr><td>McCabe modular design</td><td>           1</td></tr>
191          </table>
[89]192         
193       
194        </div>
195       
196
197        <div class="routine_details" id="_xquestion">
198
[151]199          <h2><a class="top" href="#container">top</a>xquestion <span class="categories">
[157]200 Widget
[151]201</span></h2>
[89]202       
203          <p class="header">
[234]204            <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>
[89]205       
[151]206          <div class="comments">
207</div>
[89]208
[151]209          <h3>Return value</h3><div class="preformat">
210 answer: a string
211</div>
[89]212
213         
214            <h3>Parameters</h3>
215       
216           
217            <h4 id="_xquestion_param_question">question&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
218             
219             
220             
221             
222             
[242]223              <span class="attr">type:</span> <span class="value">A scalar string or a array of string</span>
[89]224             
225             
226            </h4>
227       
[151]228          <div class="comments">
[242]229 If this argument is set to :
230      - an array of strings: each array element is
[151]231        displayed as a separate line of text.
[242]232      - a scalar string: we are looking for the "separate line
[151]233        character" '!C'
234</div>
[89]235           
236            <h4 id="_xquestion_param_proposedanswer">proposedanswer&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
237             
238             
239             
240             
241             
[163]242              <span class="attr">type:</span> <span class="value">string</span>
[89]243             
244             
245            </h4>
246       
[151]247          <div class="comments">
[242]248 proposing a answer
[151]249</div>
[89]250           
251
252         
253
254         
255
256            <h3>Keywords</h3>
257           
258            <h4 id="_xquestion_keyword_CHKWIDGET">CHKWIDGET&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
259             
260             
261             
262             
263             
264             
265             
266             
267            </h4>
268       
[151]269            <div class="comments">
[290]270 Active this keyword if you want that <a href="../..//ToBeReviewed/WIDGET/xquestion.html">xquestion</a>
271 check if managed widget are present. If not, <a href="../..//ToBeReviewed/WIDGET/xquestion.html">xquestion</a> do not
[234]272 open a widget but print the question in the IDL window.
[151]273</div>
[89]274           
[234]275            <h4 id="_xquestion_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]276             
277             
278             
279             
280             
281             
282             
283             
284            </h4>
285       
[151]286            <div class="comments">
[234]287 Used to pass keywords
288</div>
[89]289           
290         
291
[151]292          <h3>Examples</h3><div class="preformat">
[402]293
294   IDL> help, xquestion('Postscript name')
[151]295 <Expression>    STRING    = 'toto.ps'
296</div>
297          <h3>Version history</h3>
[89]298         
[151]299          <h4>Version</h4><div class="preformat">
[402]300 $Id: xquestion.pro 371 2008-08-07 09:32:02Z pinsard $
[151]301</div>
[157]302          <h4>History</h4><div class="preformat">
303 Sebastien Masson (smasson@lodyc.jussieu.fr)
304                      13/10/1999
305</div>
[89]306         
307         
[151]308          <h3>Known issues</h3>
[89]309         
310         
311         
[151]312          <h4>Restrictions</h4><div class="preformat">
313 The function does not return to its caller until the user
314 press "Enter" key in the widget.
315</div>
[89]316       
317         
318         
319         
320         
321         
322         
323         
324       
[163]325          <h3>Statistics</h3>
326          <table class="statistics">
327            <tr><td>McCabe cyclic</td><td>          10</td></tr>
328            <tr><td>McCabe essential</td><td>           1</td></tr>
329            <tr><td>McCabe modular design</td><td>           1</td></tr>
330          </table>
[89]331         
332       
333        </div>
334       
335      </div>
336
337     
338
339      <div id="tagline">Produced by IDLdoc 2.0.</div>
340
341    </div>
342
343  </body>
[249]344</html>
Note: See TracBrowser for help on using the repository browser.