source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/WIDGET/xquestion.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.4 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 (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="xquestion.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&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?format=raw" 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?format=raw">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"></div>
90
91     
92
93     
94
95     
96
97     
98      <div id="routine_summary">               
99        <h2>Routine summary</h2>
100       
101        <dl>
102         
103          <dt><p><a href="#_xquestion_event">xquestion_event<span class="result">, event</span></a></p><dt>
104          <dd>  NAME:xquestion   PURPOSE: a small widget who ask a question and give an answer.</dd>   
105         
106          <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>
107          <dd></dd>     
108               
109        </dl>
110      </div>
111     
112
113      <div id="routine_details">
114       
115
116        <div class="routine_details" id="_xquestion_event">
117
118          <h2><a class="top" href="#container">top</a>xquestion_event </h2>
119       
120          <p class="header">
121            xquestion_event<span class="result">, <a href="#_xquestion_event_param_event">event</a></span></p>
122       
123          <div class="comments">
124 NAME:xquestion
125
126 PURPOSE: a small widget who ask a question and give an answer.
127          WARNING: For a binary question with yes/no answer use
128                   DIALOG_MESSAGE.
129
130 CATEGORY: widget
131
132 CALLING SEQUENCE: answer = xquestion(question[,proposedanswer])
133 
134 INPUTS:
135        question: a scalar string or a array of string. If this
136        argument is set to :
137          + an array of strings: each array element is
138            displayed as a separate line of text.
139          + a scalar string: we are looking for the "separate line
140          character" '!C'
141
142        proposedanswer: a string proposing a answer
143
144 KEYWORD PARAMETERS: those from WIDGET_BASE and WIDGET_TEXT
145
146        /CHKWIDGET: active this keyword if you whant that xquestion
147        check if managed widget are present. If not, xquestion do not
148        open a widget but print the question in the IDL window.
149
150 OUTPUTS:
151        answer: a string
152
153 COMMON BLOCKS:
154        none (we use a "false widget")
155
156 SIDE EFFECTS:
157        The function does not return to its caller until the user
158        press "Enter" key in the widget.
159
160 RESTRICTIONS:
161
162 EXAMPLE:
163
164        IDL> help, xquestion('Postscript name')
165        <Expression>    STRING    = 'toto.ps'
166</div>
167
168         
169
170         
171            <h3>Parameters</h3>
172       
173           
174            <h4 id="_xquestion_event_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
175             
176             
177             
178             
179             
180             
181             
182             
183            </h4>
184       
185          <div class="comments"></div>
186           
187
188         
189
190         
191
192         
193         
194         
195         
196         
197         
198         
199         
200         
201         
202         
203         
204       
205         
206         
207         
208         
209         
210         
211         
212       
213         
214       
215        </div>
216       
217
218        <div class="routine_details" id="_xquestion">
219
220          <h2><a class="top" href="#container">top</a>xquestion </h2>
221       
222          <p class="header">
223            <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>
224       
225          <div class="comments"></div>
226
227         
228
229         
230            <h3>Parameters</h3>
231       
232           
233            <h4 id="_xquestion_param_question">question&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
234             
235             
236             
237             
238             
239             
240             
241             
242            </h4>
243       
244          <div class="comments"></div>
245           
246            <h4 id="_xquestion_param_proposedanswer">proposedanswer&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
247             
248             
249             
250             
251             
252             
253             
254             
255            </h4>
256       
257          <div class="comments"></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"></div>
278           
279            <h4 id="_xquestion_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
280             
281             
282             
283             
284             
285             
286             
287             
288            </h4>
289       
290            <div class="comments"></div>
291           
292         
293
294         
295         
296         
297         
298         
299         
300         
301         
302         
303         
304         
305         
306       
307         
308         
309         
310         
311         
312         
313         
314       
315         
316       
317        </div>
318       
319      </div>
320
321     
322
323      <div id="tagline">Produced by IDLdoc 2.0.</div>
324
325    </div>
326
327  </body>
328</html>
Note: See TracBrowser for help on using the repository browser.