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

Last change on this file since 163 was 163, checked in by navarro, 18 years ago

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