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

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

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