source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/WIDGET/COMPOUND_WIDGET/cw_combobox_pm.html @ 234

Last change on this file since 234 was 234, checked in by pinsard, 17 years ago

new idldoc html and assistant outputs
File size: 11.5 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>cw_combobox_pm.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="cw_calendar.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="cw_domain.html"><img src="./../../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/WIDGET/COMPOUND_WIDGET/</font></h1>
58    <h2>cw_combobox_pm.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64
65
66
67
68
69
70
71 Like WIDGET_COMBOBOX but here, their are 2 buttons + and - to move the widget from +/- 1
72
73
74   
75    <h2>Routine summary</h2>
76
77    <dl>
78     
79      <dt><a href="#_cw_combobox_pm_set_value">cw_combobox_pm_set_value<i>, id, value</i></a><dt>
80      <dd><font size="-1"> </font></dd>
81     
82      <dt><a href="#_cw_combobox_pm_get_value"><i>result = </i>cw_combobox_pm_get_value(<i>id</i>)</a><dt>
83      <dd><font size="-1"> </font></dd>
84     
85      <dt><a href="#_cw_combobox_pm_event"><i>result = </i>cw_combobox_pm_event(<i>event</i>)</a><dt>
86      <dd><font size="-1"> </font></dd>
87     
88      <dt><a href="#_cw_combobox_pm"><i>result = </i>cw_combobox_pm(<i>parent</i>, VALUE=<i>VALUE</i>, UVALUE=<i>UVALUE</i>, UNAME=<i>UNAME</i>, ROW=<i>ROW</i>, COLUMN=<i>COLUMN</i>, _EXTRA=<i>_EXTRA</i>)</a><dt>
89      <dd><font size="-1"> </font></dd>
90     
91    </dl>
92
93    <p>&nbsp;</p>
94   
95
96     
97      <a name="#_cw_combobox_pm_set_value"></a>
98
99      <h2>cw_combobox_pm_set_value  <font size="-1" color="#006633">
100 Compound widget
101</font></h2>
102
103      <p><font face="Courier">cw_combobox_pm_set_value<i>, <a href="#_cw_combobox_pm_set_value_keyword_id">id</a>, <a href="#_cw_combobox_pm_set_value_keyword_value">value</a></i></font></p>
104
105   
106
107
108    <h3>Return value</h3>
109
110
111   
112    <h3>Parameters</h3>
113   
114
115    <a name="#_cw_combobox_pm_set_value_keyword_id"></a>
116    <h4>id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
117     
118     
119     
120     
121     
122     
123     
124     
125    </h4>
126
127   
128
129   
130
131    <a name="#_cw_combobox_pm_set_value_keyword_value"></a>
132    <h4>value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
133     
134     
135     
136     
137     
138     
139     
140     
141    </h4>
142
143   
144 It is the default tick mark value (a floating-point number).
145
146   
147   
148
149   
150
151    <h3>Examples</h3><pre>
152
153    </pre><h3>Version history</h3>
154   
155    <h4>Version</h4>
156 $Id: cw_combobox_pm.pro 232 2007-03-20 16:59:36Z pinsard $
157    <h4>History</h4>
158
159   
160
161    <h3>Known issues</h3>
162   
163   
164   
165    <h4>Restrictions</h4>
166
167
168    <h3>Other attributes</h3>
169   
170   
171    <h4>Uses routines</h4>
172
173   
174   
175   
176
177    <font size="-3"><p>&nbsp;</p></font>
178    <hr size="1" color="#CCCCCC"/>
179     
180      <a name="#_cw_combobox_pm_get_value"></a>
181
182      <h2>cw_combobox_pm_get_value  <font size="-1" color="#006633">
183 Compound widget
184</font></h2>
185
186      <p><font face="Courier"><i>result = </i>cw_combobox_pm_get_value(<i><a href="#_cw_combobox_pm_get_value_keyword_id">id</a></i>)</font></p>
187
188   
189
190
191    <h3>Return value</h3>
192
193
194   
195    <h3>Parameters</h3>
196   
197
198    <a name="#_cw_combobox_pm_get_value_keyword_id"></a>
199    <h4>id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
200     
201     
202     
203     
204     
205     
206     
207     
208    </h4>
209
210   
211
212   
213   
214
215   
216
217    <h3>Examples</h3><pre>
218
219    </pre><h3>Version history</h3>
220   
221    <h4>Version</h4>
222 $Id: cw_combobox_pm.pro 232 2007-03-20 16:59:36Z pinsard $
223    <h4>History</h4>
224
225   
226
227    <h3>Known issues</h3>
228   
229   
230   
231    <h4>Restrictions</h4>
232
233
234    <h3>Other attributes</h3>
235   
236   
237    <h4>Uses routines</h4>
238
239   
240   
241   
242
243    <font size="-3"><p>&nbsp;</p></font>
244    <hr size="1" color="#CCCCCC"/>
245     
246      <a name="#_cw_combobox_pm_event"></a>
247
248      <h2>cw_combobox_pm_event  <font size="-1" color="#006633">
249 Compound widget
250</font></h2>
251
252      <p><font face="Courier"><i>result = </i>cw_combobox_pm_event(<i><a href="#_cw_combobox_pm_event_keyword_event">event</a></i>)</font></p>
253
254   
255
256
257    <h3>Return value</h3>
258
259
260   
261    <h3>Parameters</h3>
262   
263
264    <a name="#_cw_combobox_pm_event_keyword_event"></a>
265    <h4>event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
266     
267     
268     
269     
270     
271     
272     
273     
274    </h4>
275
276   
277
278   
279   
280
281   
282
283    <h3>Examples</h3><pre>
284
285    </pre><h3>Version history</h3>
286   
287    <h4>Version</h4>
288 $Id: cw_combobox_pm.pro 232 2007-03-20 16:59:36Z pinsard $
289    <h4>History</h4>
290
291   
292
293    <h3>Known issues</h3>
294   
295   
296   
297    <h4>Restrictions</h4>
298
299
300    <h3>Other attributes</h3>
301   
302   
303    <h4>Uses routines</h4>
304
305   
306   
307   
308
309    <font size="-3"><p>&nbsp;</p></font>
310    <hr size="1" color="#CCCCCC"/>
311     
312      <a name="#_cw_combobox_pm"></a>
313
314      <h2>cw_combobox_pm  <font size="-1" color="#006633">
315 Compound widget
316</font></h2>
317
318      <p><font face="Courier"><i>result = </i>cw_combobox_pm(<i><a href="#_cw_combobox_pm_keyword_parent">parent</a></i>, <a href="#_cw_combobox_pm_keyword_VALUE">VALUE</a>=<i>VALUE</i>, <a href="#_cw_combobox_pm_keyword_UVALUE">UVALUE</a>=<i>UVALUE</i>, <a href="#_cw_combobox_pm_keyword_UNAME">UNAME</a>=<i>UNAME</i>, <a href="#_cw_combobox_pm_keyword_ROW">ROW</a>=<i>ROW</i>, <a href="#_cw_combobox_pm_keyword_COLUMN">COLUMN</a>=<i>COLUMN</i>, <a href="#_cw_combobox_pm_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
319
320   
321
322
323    <h3>Return value</h3>
324 The returned value of this function is the widget ID of the
325 newly-created animation widget.
326
327
328   
329    <h3>Parameters</h3>
330   
331
332    <a name="#_cw_combobox_pm_keyword_parent"></a>
333    <h4>parent&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
334      <font size="-1" color="#006633">in</font>
335     
336     
337      <font size="-1" color="#006633">required</font>
338     
339     
340     
341     
342    </h4>
343
344   
345 The widget ID of the parent widget.
346
347   
348   
349
350   
351    <h3>Keywords</h3>
352
353   
354    <a name="#_cw_combobox_pm_keyword_VALUE"></a>
355    <h4>VALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
356     
357     
358     
359     
360     
361     
362     
363     
364    </h4>
365
366   
367
368   
369    <a name="#_cw_combobox_pm_keyword_UVALUE"></a>
370    <h4>UVALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
371     
372     
373     
374     
375     
376     
377     
378     
379    </h4>
380
381   
382 The user value to be associated with the widget.
383
384   
385    <a name="#_cw_combobox_pm_keyword_UNAME"></a>
386    <h4>UNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
387     
388     
389     
390     
391     
392     
393     
394     
395    </h4>
396
397   
398 The user name to be associated with the widget.
399
400   
401    <a name="#_cw_combobox_pm_keyword_ROW"></a>
402    <h4>ROW&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
403     
404     
405     
406     
407     
408     
409     
410     
411    </h4>
412
413   
414 Buttons will be arranged in the number of rows
415 specified by this keyword.
416
417   
418    <a name="#_cw_combobox_pm_keyword_COLUMN"></a>
419    <h4>COLUMN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
420     
421     
422     
423     
424     
425     
426     
427     
428    </h4>
429
430   
431 Buttons will be arranged in the number of columns
432 specified by this keyword.
433
434   
435    <a name="#_cw_combobox_pm_keyword__EXTRA"></a>
436    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
437     
438     
439     
440     
441     
442     
443     
444     
445    </h4>
446
447   
448 Used to pass keywords
449
450   
451   
452
453    <h3>Examples</h3><pre>
454 See the program provided above (testwid and the associated procedure, testwid_event).
455
456    </pre><h3>Version history</h3>
457   
458    <h4>Version</h4>
459 $Id: cw_combobox_pm.pro 232 2007-03-20 16:59:36Z pinsard $
460
461    <h4>History</h4>
462 Sebastien Masson (smasson@lodyc.jussieu.fr)
463                      6/9/1999
464
465   
466
467    <h3>Known issues</h3>
468   
469   
470   
471    <h4>Restrictions</h4>
472
473     Widget Events Returned by Combobox Widgets
474
475   Pressing the mouse button while the mouse cursor is over an
476   element of a combobox widget causes the widget to change the label
477   on the combobox button and to generate an event. The appearance of
478   any previously selected element is restored to normal at the same
479   time. The event structure returned by the WIDGET_EVENT function is
480   defined by the following statement:
481
482   { CW_COMBOBOX_PM, ID:0L, TOP:0L, HANDLER:0L, INDEX:0L, OUT:0 }
483
484   The first three fields are the standard fields found in every
485   widget event.
486   INDEX returns the index of the selected item. This can be used to
487   index the array of names originally used to set the widget''s
488   value
489   OUT:It is an integer which can take 3 values:
490       1 : If we press + when the index is already at the max
491       Comment: In this case, the index stay at the max
492       -1: If we press - when the index is already at the min
493       Comment: In this case, the index stay at the min
494       0 : In other cases
495
496   Keywords to WIDGET_CONTROL
497
498   A number of keywords to the WIDGET_CONTROL procedure affect the
499   behavior of cw_slider_pm widget: GET_VALUE and SET_VALUE.
500       1) GET_VALUE
501   widget_control,wid_id,get_value=resultat
502   Send back, in the result variable, a structure of 3 elements whose
503   names are inspired by keywords we can pass at widget_control when
504   we use WIDGET_COMBOBOX:
505            COMBOBOX_NUMBER: the number of elements currently
506            contained in the specified combobox widget.
507            COMBOBOX_SELECT: the zero-based number of the
508            currently-selected element (i.e., the currently-displayed
509            element) in the specified combobox widget.
510            DYNAMIC_RESIZE: a True value (1) if the widget specified
511            by Widget_ID is a button, combobox, or label widget that
512            has had its DYNAMIC_RESIZE attribute set. Otherwise,
513            False (0) is returned.
514       2) SET_VALUE
515   widget_control,wid_id,set_value=impose
516   Allows to modify the state of the combobox like we can do it for
517   WIDGET_COMBOBOX. May impose:
518       a) The contents of the list widget (string or string array)
519       b) A structure which can have for elements (from 1 to 3):
520            DYNAMIC_RESIZE:Set this keyword to activate (if set to 1)
521            or deactivate (if set to 0) dynamic resizing of the
522            specified CW_COMBOBOX_PM widget (see the documentation
523            for the DYNAMIC_RESIZE keyword to WIDGET_COMBOBOX
524            procedure for more information about dynamic widget
525            resizing).
526            COMBOBOX_SELECT:Set this keyword to return the zero-based
527            number of the currently-selected element (i.e., the
528            currently-displayed element) in the specified combobox
529            widget.
530            VALUE: The contents of the list widget (string or string
531            array)
532
533
534   
535   
536   
537   
538   
539   
540   
541
542    <font size="-3"><p>&nbsp;</p></font>
543    <hr size="1" color="#CCCCCC"/>
544     
545
546   
547
548    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
549
550  </body>
551</html>
Note: See TracBrowser for help on using the repository browser.