source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/WIDGET/COMPOUND_WIDGET/cw_droplist_pm.html @ 338

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

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