source: trunk/SRC/Documentation/idldoc_assistant_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: 5.7 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>xquestion.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="xnotice.html"><img src="./../../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="xx.html"><img src="./../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/WIDGET/</font></h1>
58    <h2>xquestion.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64
65
66 A small widget who ask a question and give an answer.
67   WARNING: For a binary question with yes/no, answer use
68   <a href="/Applications/rsi/idl_6.3/help/online_help/DIALOG_MESSAGE.html">DIALOG_MESSAGE</a>.
69
70
71   
72    <h2>Routine summary</h2>
73
74    <dl>
75     
76      <dt><a href="#_xquestion_event">xquestion_event<i>, event</i></a><dt>
77      <dd><font size="-1"> </font></dd>
78     
79      <dt><a href="#_xquestion"><i>result = </i>xquestion(<i>question, proposedanswer</i>, CHKWIDGET=<i>CHKWIDGET</i>, _EXTRA=<i>_EXTRA</i>)</a><dt>
80      <dd><font size="-1"> </font></dd>
81     
82    </dl>
83
84    <p>&nbsp;</p>
85   
86
87     
88      <a name="#_xquestion_event"></a>
89
90      <h2>xquestion_event  <font size="-1" color="#006633">
91</font></h2>
92
93      <p><font face="Courier">xquestion_event<i>, <a href="#_xquestion_event_keyword_event">event</a></i></font></p>
94
95   
96
97
98    <h3>Return value</h3>
99
100
101   
102    <h3>Parameters</h3>
103   
104
105    <a name="#_xquestion_event_keyword_event"></a>
106    <h4>event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
107     
108     
109     
110     
111     
112     
113     
114     
115    </h4>
116
117   
118
119   
120   
121
122   
123
124    <h3>Examples</h3><pre>
125
126    </pre><h3>Version history</h3>
127   
128    <h4>Version</h4>
129 $Id: xquestion.pro 242 2007-04-06 08:35:17Z pinsard $
130    <h4>History</h4>
131
132   
133
134    <h3>Known issues</h3>
135   
136   
137   
138    <h4>Restrictions</h4>
139
140
141    <h3>Other attributes</h3>
142   
143   
144    <h4>Uses routines</h4>
145
146   
147   
148   
149
150    <font size="-3"><p>&nbsp;</p></font>
151    <hr size="1" color="#CCCCCC"/>
152     
153      <a name="#_xquestion"></a>
154
155      <h2>xquestion  <font size="-1" color="#006633">
156 Widget
157</font></h2>
158
159      <p><font face="Courier"><i>result = </i>xquestion(<i><a href="#_xquestion_keyword_question">question</a>, <a href="#_xquestion_keyword_proposedanswer">proposedanswer</a></i>, <a href="#_xquestion_keyword_CHKWIDGET">CHKWIDGET</a>=<i>CHKWIDGET</i>, <a href="#_xquestion_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
160
161   
162
163
164    <h3>Return value</h3>
165 answer: a string
166
167
168   
169    <h3>Parameters</h3>
170   
171
172    <a name="#_xquestion_keyword_question"></a>
173    <h4>question&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
174     
175     
176     
177     
178     
179      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>A scalar string or a array of string</i></font>
180     
181     
182    </h4>
183
184   
185 If this argument is set to :
186      - an array of strings: each array element is
187        displayed as a separate line of text.
188      - a scalar string: we are looking for the "separate line
189        character" '!C'
190
191   
192
193    <a name="#_xquestion_keyword_proposedanswer"></a>
194    <h4>proposedanswer&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
195     
196     
197     
198     
199     
200      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font>
201     
202     
203    </h4>
204
205   
206 proposing a answer
207
208   
209   
210
211   
212    <h3>Keywords</h3>
213
214   
215    <a name="#_xquestion_keyword_CHKWIDGET"></a>
216    <h4>CHKWIDGET&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
217     
218     
219     
220     
221     
222     
223     
224     
225    </h4>
226
227   
228 Active this keyword if you want that <a href="../..//ToBeReviewed/WIDGET/xquestion.html">xquestion</a>
229 check if managed widget are present. If not, <a href="../..//ToBeReviewed/WIDGET/xquestion.html">xquestion</a> do not
230 open a widget but print the question in the IDL window.
231
232   
233    <a name="#_xquestion_keyword__EXTRA"></a>
234    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
235     
236     
237     
238     
239     
240     
241     
242     
243    </h4>
244
245   
246 Used to pass keywords
247
248   
249   
250
251    <h3>Examples</h3><pre>
252 IDL> help, xquestion('Postscript name')
253 <Expression>    STRING    = 'toto.ps'
254
255    </pre><h3>Version history</h3>
256   
257    <h4>Version</h4>
258 $Id: xquestion.pro 242 2007-04-06 08:35:17Z pinsard $
259
260    <h4>History</h4>
261 Sebastien Masson (smasson@lodyc.jussieu.fr)
262                      13/10/1999
263
264   
265
266    <h3>Known issues</h3>
267   
268   
269   
270    <h4>Restrictions</h4>
271 The function does not return to its caller until the user
272 press "Enter" key in the widget.
273
274
275   
276   
277   
278   
279   
280   
281   
282
283    <font size="-3"><p>&nbsp;</p></font>
284    <hr size="1" color="#CCCCCC"/>
285     
286
287   
288
289    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
290
291  </body>
292</html>
Note: See TracBrowser for help on using the repository browser.