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

Last change on this file was 338, checked in by smasson, 16 years ago

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