source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/WIDGET/COMPOUND_WIDGET/cw_combobox_pm.html @ 338

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

update documentation
File size: 14.7 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>cw_combobox_pm.pro (SAXO Documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../../../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../../../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="cw_combobox_pm.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../../../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../../../ToBeReviewed/WIDGET/COMPOUND_WIDGET//cw_combobox_pm.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../../../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="cw_calendar.html">&lt;&lt;prev file</a> | <a href="cw_domain.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="cw_combobox_pm.html" target="_TOP">view single page</a> | <a href="./../../../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | <a href="#routine_summary">routine</a>&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/WIDGET/COMPOUND_WIDGET/</a></h1>
82      <h2 class="pro_file">cw_combobox_pm.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90
91
92
93
94
95
96 Like WIDGET_COMBOBOX but here, there are 2 buttons + and - to move the widget from +/- 1
97</div>
98
99     
100
101     
102
103     
104
105     
106      <div id="routine_summary">               
107        <h2>Routine summary</h2>
108       
109        <dl>
110         
111          <dt><p><a href="#_cw_combobox_pm_set_value">cw_combobox_pm_set_value<span class="result">, id, value</span></a></p><dt>
112          <dd> </dd>   
113         
114          <dt><p><a href="#_cw_combobox_pm_get_value"><span class="result">result = </span>cw_combobox_pm_get_value(<span class="result">id</span>)</a></p><dt>
115          <dd> </dd>   
116         
117          <dt><p><a href="#_cw_combobox_pm_event"><span class="result">result = </span>cw_combobox_pm_event(<span class="result">event</span>)</a></p><dt>
118          <dd> </dd>   
119         
120          <dt><p><a href="#_cw_combobox_pm"><span class="result">result = </span>cw_combobox_pm(<span class="result">parent</span>, VALUE=<span class="result">VALUE</span>, UVALUE=<span class="result">UVALUE</span>, UNAME=<span class="result">UNAME</span>, ROW=<span class="result">ROW</span>, COLUMN=<span class="result">COLUMN</span>, _EXTRA=<span class="result">_EXTRA</span>)</a></p><dt>
121          <dd> </dd>   
122               
123        </dl>
124      </div>
125     
126
127      <div id="routine_details">
128       
129
130        <div class="routine_details" id="_cw_combobox_pm_set_value">
131
132          <h2><a class="top" href="#container">top</a>cw_combobox_pm_set_value <span class="categories">
133 Compound widget
134</span></h2>
135       
136          <p class="header">
137            cw_combobox_pm_set_value<span class="result">, <a href="#_cw_combobox_pm_set_value_param_id">id</a>, <a href="#_cw_combobox_pm_set_value_param_value">value</a></span></p>
138       
139          <div class="comments">
140</div>
141
142          <h3>Return value</h3><div class="preformat">
143</div>
144
145         
146            <h3>Parameters</h3>
147       
148           
149            <h4 id="_cw_combobox_pm_set_value_param_id">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
150             
151             
152             
153             
154             
155             
156             
157             
158            </h4>
159       
160          <div class="comments">
161</div>
162           
163            <h4 id="_cw_combobox_pm_set_value_param_value">value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
164             
165             
166             
167             
168             
169             
170             
171             
172            </h4>
173       
174          <div class="comments">
175 It is the default tick mark value (a floating-point number).
176</div>
177           
178
179         
180
181         
182
183          <h3>Examples</h3><div class="preformat">
184</div>
185          <h3>Version history</h3>
186         
187          <h4>Version</h4><div class="preformat">
188 $Id: cw_combobox_pm.pro 327 2007-12-13 16:22:35Z pinsard $
189</div>
190          <h4>History</h4><div class="preformat">
191</div>
192         
193         
194          <h3>Known issues</h3>
195         
196         
197         
198          <h4>Restrictions</h4><div class="preformat">
199</div>
200       
201          <h3>Other attributes</h3>
202         
203         
204          <h4>Uses routines</h4><div class="preformat">
205</div>
206         
207         
208         
209       
210          <h3>Statistics</h3>
211          <table class="statistics">
212            <tr><td>McCabe cyclic</td><td>           8</td></tr>
213            <tr><td>McCabe essential</td><td>           1</td></tr>
214            <tr><td>McCabe modular design</td><td>           1</td></tr>
215          </table>
216         
217       
218        </div>
219       
220
221        <div class="routine_details" id="_cw_combobox_pm_get_value">
222
223          <h2><a class="top" href="#container">top</a>cw_combobox_pm_get_value <span class="categories">
224 Compound widget
225</span></h2>
226       
227          <p class="header">
228            <span class="result">result = </span>cw_combobox_pm_get_value(<span class="result"><a href="#_cw_combobox_pm_get_value_param_id">id</a></span>)</p>
229       
230          <div class="comments">
231</div>
232
233          <h3>Return value</h3><div class="preformat">
234</div>
235
236         
237            <h3>Parameters</h3>
238       
239           
240            <h4 id="_cw_combobox_pm_get_value_param_id">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
241             
242             
243             
244             
245             
246             
247             
248             
249            </h4>
250       
251          <div class="comments">
252</div>
253           
254
255         
256
257         
258
259          <h3>Examples</h3><div class="preformat">
260</div>
261          <h3>Version history</h3>
262         
263          <h4>Version</h4><div class="preformat">
264 $Id: cw_combobox_pm.pro 327 2007-12-13 16:22:35Z pinsard $
265</div>
266          <h4>History</h4><div class="preformat">
267</div>
268         
269         
270          <h3>Known issues</h3>
271         
272         
273         
274          <h4>Restrictions</h4><div class="preformat">
275</div>
276       
277          <h3>Other attributes</h3>
278         
279         
280          <h4>Uses routines</h4><div class="preformat">
281</div>
282         
283         
284         
285       
286          <h3>Statistics</h3>
287          <table class="statistics">
288            <tr><td>McCabe cyclic</td><td>           1</td></tr>
289            <tr><td>McCabe essential</td><td>           1</td></tr>
290            <tr><td>McCabe modular design</td><td>           1</td></tr>
291          </table>
292         
293       
294        </div>
295       
296
297        <div class="routine_details" id="_cw_combobox_pm_event">
298
299          <h2><a class="top" href="#container">top</a>cw_combobox_pm_event <span class="categories">
300 Compound widget
301</span></h2>
302       
303          <p class="header">
304            <span class="result">result = </span>cw_combobox_pm_event(<span class="result"><a href="#_cw_combobox_pm_event_param_event">event</a></span>)</p>
305       
306          <div class="comments">
307</div>
308
309          <h3>Return value</h3><div class="preformat">
310</div>
311
312         
313            <h3>Parameters</h3>
314       
315           
316            <h4 id="_cw_combobox_pm_event_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
317             
318             
319             
320             
321             
322             
323             
324             
325            </h4>
326       
327          <div class="comments">
328</div>
329           
330
331         
332
333         
334
335          <h3>Examples</h3><div class="preformat">
336</div>
337          <h3>Version history</h3>
338         
339          <h4>Version</h4><div class="preformat">
340 $Id: cw_combobox_pm.pro 327 2007-12-13 16:22:35Z pinsard $
341</div>
342          <h4>History</h4><div class="preformat">
343</div>
344         
345         
346          <h3>Known issues</h3>
347         
348         
349         
350          <h4>Restrictions</h4><div class="preformat">
351</div>
352       
353          <h3>Other attributes</h3>
354         
355         
356          <h4>Uses routines</h4><div class="preformat">
357</div>
358         
359         
360         
361       
362          <h3>Statistics</h3>
363          <table class="statistics">
364            <tr><td>McCabe cyclic</td><td>           6</td></tr>
365            <tr><td>McCabe essential</td><td>           1</td></tr>
366            <tr><td>McCabe modular design</td><td>           1</td></tr>
367          </table>
368         
369       
370        </div>
371       
372
373        <div class="routine_details" id="_cw_combobox_pm">
374
375          <h2><a class="top" href="#container">top</a>cw_combobox_pm <span class="categories">
376 Compound widget
377</span></h2>
378       
379          <p class="header">
380            <span class="result">result = </span>cw_combobox_pm(<span class="result"><a href="#_cw_combobox_pm_param_parent">parent</a></span>, <a href="#_cw_combobox_pm_keyword_VALUE">VALUE</a>=<span class="result">VALUE</span>, <a href="#_cw_combobox_pm_keyword_UVALUE">UVALUE</a>=<span class="result">UVALUE</span>, <a href="#_cw_combobox_pm_keyword_UNAME">UNAME</a>=<span class="result">UNAME</span>, <a href="#_cw_combobox_pm_keyword_ROW">ROW</a>=<span class="result">ROW</span>, <a href="#_cw_combobox_pm_keyword_COLUMN">COLUMN</a>=<span class="result">COLUMN</span>, <a href="#_cw_combobox_pm_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
381       
382          <div class="comments">
383</div>
384
385          <h3>Return value</h3><div class="preformat">
386 The returned value of this function is the widget ID of the
387 newly-created animation widget.
388</div>
389
390         
391            <h3>Parameters</h3>
392       
393           
394            <h4 id="_cw_combobox_pm_param_parent">parent&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
395              <span class="attr">in</span>
396             
397             
398              <span class="attr">required</span>
399             
400             
401             
402             
403            </h4>
404       
405          <div class="comments">
406 The widget ID of the parent widget.
407</div>
408           
409
410         
411
412         
413
414            <h3>Keywords</h3>
415           
416            <h4 id="_cw_combobox_pm_keyword_VALUE">VALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
417             
418             
419             
420             
421             
422             
423             
424             
425            </h4>
426       
427            <div class="comments">
428</div>
429           
430            <h4 id="_cw_combobox_pm_keyword_UVALUE">UVALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
431             
432             
433             
434             
435             
436             
437             
438             
439            </h4>
440       
441            <div class="comments">
442 The user value to be associated with the widget.
443</div>
444           
445            <h4 id="_cw_combobox_pm_keyword_UNAME">UNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
446             
447             
448             
449             
450             
451             
452             
453             
454            </h4>
455       
456            <div class="comments">
457 The user name to be associated with the widget.
458</div>
459           
460            <h4 id="_cw_combobox_pm_keyword_ROW">ROW&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
461             
462             
463             
464             
465             
466             
467             
468             
469            </h4>
470       
471            <div class="comments">
472 Buttons will be arranged in the number of rows
473 specified by this keyword.
474</div>
475           
476            <h4 id="_cw_combobox_pm_keyword_COLUMN">COLUMN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
477             
478             
479             
480             
481             
482             
483             
484             
485            </h4>
486       
487            <div class="comments">
488 Buttons will be arranged in the number of columns
489 specified by this keyword.
490</div>
491           
492            <h4 id="_cw_combobox_pm_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
493             
494             
495             
496             
497             
498             
499             
500             
501            </h4>
502       
503            <div class="comments">
504 Used to pass keywords
505</div>
506           
507         
508
509          <h3>Examples</h3><div class="preformat">
510 See the program provided above (testwid and the associated procedure, testwid_event).
511</div>
512          <h3>Version history</h3>
513         
514          <h4>Version</h4><div class="preformat">
515 $Id: cw_combobox_pm.pro 327 2007-12-13 16:22:35Z pinsard $
516</div>
517          <h4>History</h4><div class="preformat">
518 Sebastien Masson (smasson@lodyc.jussieu.fr)
519                      6/9/1999
520</div>
521         
522         
523          <h3>Known issues</h3>
524         
525         
526         
527          <h4>Restrictions</h4><div class="preformat">
528
529     Widget Events Returned by Combobox Widgets
530
531   Pressing the mouse button while the mouse cursor is over an
532   element of a combobox widget causes the widget to change the label
533   on the combobox button and to generate an event. The appearance of
534   any previously selected element is restored to normal at the same
535   time. The event structure returned by the WIDGET_EVENT function is
536   defined by the following statement:
537
538   { CW_COMBOBOX_PM, ID:0L, TOP:0L, HANDLER:0L, INDEX:0L, OUT:0 }
539
540   The first three fields are the standard fields found in every
541   widget event.
542   INDEX returns the index of the selected item. This can be used to
543   index the array of names originally used to set the widget''s
544   value
545   OUT:It is an integer which can take 3 values:
546       1 : If we press + when the index is already at the max
547       Comment: In this case, the index stay at the max
548       -1: If we press - when the index is already at the min
549       Comment: In this case, the index stay at the min
550       0 : In other cases
551
552   Keywords to WIDGET_CONTROL
553
554   A number of keywords to the WIDGET_CONTROL procedure affect the
555   behavior of cw_slider_pm widget: GET_VALUE and SET_VALUE.
556       1) GET_VALUE
557   widget_control,wid_id,get_value=resultat
558   Send back, in the result variable, a structure of 3 elements whose
559   names are inspired by keywords we can pass at widget_control when
560   we use WIDGET_COMBOBOX:
561            COMBOBOX_NUMBER: the number of elements currently
562            contained in the specified combobox widget.
563            COMBOBOX_SELECT: the zero-based number of the
564            currently-selected element (i.e., the currently-displayed
565            element) in the specified combobox widget.
566            DYNAMIC_RESIZE: a True value (1) if the widget specified
567            by Widget_ID is a button, combobox, or label widget that
568            has had its DYNAMIC_RESIZE attribute set. Otherwise,
569            False (0) is returned.
570       2) SET_VALUE
571   widget_control,wid_id,set_value=impose
572   Allows to modify the state of the combobox like we can do it for
573   WIDGET_COMBOBOX. May impose:
574       a) The contents of the list widget (string or string array)
575       b) A structure which can have for elements (from 1 to 3):
576            DYNAMIC_RESIZE:Set this keyword to activate (if set to 1)
577            or deactivate (if set to 0) dynamic resizing of the
578            specified CW_COMBOBOX_PM widget (see the documentation
579            for the DYNAMIC_RESIZE keyword to WIDGET_COMBOBOX
580            procedure for more information about dynamic widget
581            resizing).
582            COMBOBOX_SELECT:Set this keyword to return the zero-based
583            number of the currently-selected element (i.e., the
584            currently-displayed element) in the specified combobox
585            widget.
586            VALUE: The contents of the list widget (string or string
587            array)
588</div>
589       
590         
591         
592         
593         
594         
595         
596         
597       
598          <h3>Statistics</h3>
599          <table class="statistics">
600            <tr><td>McCabe cyclic</td><td>           5</td></tr>
601            <tr><td>McCabe essential</td><td>           1</td></tr>
602            <tr><td>McCabe modular design</td><td>           1</td></tr>
603          </table>
604         
605       
606        </div>
607       
608      </div>
609
610     
611
612      <div id="tagline">Produced by IDLdoc 2.0.</div>
613
614    </div>
615
616  </body>
617</html>
Note: See TracBrowser for help on using the repository browser.