source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/WIDGET/COMPOUND_WIDGET/cw_droplist_pm.html @ 321

Last change on this file since 321 was 321, checked in by smasson, 17 years ago

update documentation
File size: 14.4 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_droplist_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_droplist_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_droplist_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_domain.html">&lt;&lt;prev file</a> | <a href="cw_pagelayout.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="cw_droplist_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_droplist_pm.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90
91
92 Compound widget
93
94
95 Compound widget
96
97
98 Like WIDGET_DROPLIST but here, there are 2 buttons + and - to move the widget from +/- 1
99</div>
100
101     
102
103     
104
105     
106
107     
108      <div id="routine_summary">               
109        <h2>Routine summary</h2>
110       
111        <dl>
112         
113          <dt><p><a href="#_cw_droplist_pm_set_value">cw_droplist_pm_set_value<span class="result">, id, value</span></a></p><dt>
114          <dd> </dd>   
115         
116          <dt><p><a href="#_cw_droplist_pm_get_value"><span class="result">result = </span>cw_droplist_pm_get_value(<span class="result">id</span>)</a></p><dt>
117          <dd> </dd>   
118         
119          <dt><p><a href="#_cw_droplist_pm_event"><span class="result">result = </span>cw_droplist_pm_event(<span class="result">event</span>)</a></p><dt>
120          <dd> </dd>   
121         
122          <dt><p><a href="#_cw_droplist_pm"><span class="result">result = </span>cw_droplist_pm(<span class="result">parent</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>
123          <dd> </dd>   
124               
125        </dl>
126      </div>
127     
128
129      <div id="routine_details">
130       
131
132        <div class="routine_details" id="_cw_droplist_pm_set_value">
133
134          <h2><a class="top" href="#container">top</a>cw_droplist_pm_set_value <span class="categories">
135 Compound widget
136</span></h2>
137       
138          <p class="header">
139            cw_droplist_pm_set_value<span class="result">, <a href="#_cw_droplist_pm_set_value_param_id">id</a>, <a href="#_cw_droplist_pm_set_value_param_value">value</a></span></p>
140       
141          <div class="comments">
142</div>
143
144          <h3>Return value</h3><div class="preformat">
145</div>
146
147         
148            <h3>Parameters</h3>
149       
150           
151            <h4 id="_cw_droplist_pm_set_value_param_id">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
152             
153             
154             
155             
156             
157             
158             
159             
160            </h4>
161       
162          <div class="comments">
163</div>
164           
165            <h4 id="_cw_droplist_pm_set_value_param_value">value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
166             
167             
168             
169             
170             
171             
172             
173             
174            </h4>
175       
176          <div class="comments">
177 It is the default tick mark value (a floating-point number).
178</div>
179           
180
181         
182
183         
184
185          <h3>Examples</h3><div class="preformat">
186</div>
187          <h3>Version history</h3>
188         
189          <h4>Version</h4><div class="preformat">
190 $Id: cw_droplist_pm.pro 295 2007-09-25 10:16:00Z pinsard $</div>
191          <h4>History</h4><div class="preformat">
192</div>
193         
194         
195          <h3>Known issues</h3>
196         
197         
198         
199          <h4>Restrictions</h4><div class="preformat">
200</div>
201       
202          <h3>Other attributes</h3>
203         
204         
205          <h4>Uses routines</h4><div class="preformat">
206</div>
207         
208         
209         
210       
211          <h3>Statistics</h3>
212          <table class="statistics">
213            <tr><td>McCabe cyclic</td><td>           7</td></tr>
214            <tr><td>McCabe essential</td><td>           1</td></tr>
215            <tr><td>McCabe modular design</td><td>           1</td></tr>
216          </table>
217         
218       
219        </div>
220       
221
222        <div class="routine_details" id="_cw_droplist_pm_get_value">
223
224          <h2><a class="top" href="#container">top</a>cw_droplist_pm_get_value <span class="categories">
225 Compound widget
226</span></h2>
227       
228          <p class="header">
229            <span class="result">result = </span>cw_droplist_pm_get_value(<span class="result"><a href="#_cw_droplist_pm_get_value_param_id">id</a></span>)</p>
230       
231          <div class="comments">
232</div>
233
234          <h3>Return value</h3><div class="preformat">
235</div>
236
237         
238            <h3>Parameters</h3>
239       
240           
241            <h4 id="_cw_droplist_pm_get_value_param_id">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
242             
243             
244             
245             
246             
247             
248             
249             
250            </h4>
251       
252          <div class="comments">
253</div>
254           
255
256         
257
258         
259
260          <h3>Examples</h3><div class="preformat">
261</div>
262          <h3>Version history</h3>
263         
264          <h4>Version</h4><div class="preformat">
265 $Id: cw_droplist_pm.pro 295 2007-09-25 10:16:00Z pinsard $</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_droplist_pm_event">
298
299          <h2><a class="top" href="#container">top</a>cw_droplist_pm_event <span class="categories">
300 Compound widget
301</span></h2>
302       
303          <p class="header">
304            <span class="result">result = </span>cw_droplist_pm_event(<span class="result"><a href="#_cw_droplist_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_droplist_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_droplist_pm.pro 295 2007-09-25 10:16:00Z pinsard $</div>
341          <h4>History</h4><div class="preformat">
342</div>
343         
344         
345          <h3>Known issues</h3>
346         
347         
348         
349          <h4>Restrictions</h4><div class="preformat">
350</div>
351       
352          <h3>Other attributes</h3>
353         
354         
355          <h4>Uses routines</h4><div class="preformat">
356</div>
357         
358         
359         
360       
361          <h3>Statistics</h3>
362          <table class="statistics">
363            <tr><td>McCabe cyclic</td><td>           6</td></tr>
364            <tr><td>McCabe essential</td><td>           1</td></tr>
365            <tr><td>McCabe modular design</td><td>           1</td></tr>
366          </table>
367         
368       
369        </div>
370       
371
372        <div class="routine_details" id="_cw_droplist_pm">
373
374          <h2><a class="top" href="#container">top</a>cw_droplist_pm <span class="categories">
375 Compound widget
376</span></h2>
377       
378          <p class="header">
379            <span class="result">result = </span>cw_droplist_pm(<span class="result"><a href="#_cw_droplist_pm_param_parent">parent</a></span>, <a href="#_cw_droplist_pm_keyword_UVALUE">UVALUE</a>=<span class="result">UVALUE</span>, <a href="#_cw_droplist_pm_keyword_UNAME">UNAME</a>=<span class="result">UNAME</span>, <a href="#_cw_droplist_pm_keyword_ROW">ROW</a>=<span class="result">ROW</span>, <a href="#_cw_droplist_pm_keyword_COLUMN">COLUMN</a>=<span class="result">COLUMN</span>, <a href="#_cw_droplist_pm_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
380       
381          <div class="comments">
382</div>
383
384          <h3>Return value</h3><div class="preformat">
385 The returned value of this function is the widget ID of the
386 newly-created animation widget.
387</div>
388
389         
390            <h3>Parameters</h3>
391       
392           
393            <h4 id="_cw_droplist_pm_param_parent">parent&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
394              <span class="attr">in</span>
395             
396             
397              <span class="attr">required</span>
398             
399             
400             
401             
402            </h4>
403       
404          <div class="comments">
405 The widget ID of the parent widget.
406</div>
407           
408
409         
410
411         
412
413            <h3>Keywords</h3>
414           
415            <h4 id="_cw_droplist_pm_keyword_UVALUE">UVALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
416             
417             
418             
419             
420             
421             
422             
423             
424            </h4>
425       
426            <div class="comments">
427 The user value to be associated with the widget.
428</div>
429           
430            <h4 id="_cw_droplist_pm_keyword_UNAME">UNAME&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 name to be associated with the widget.
443</div>
444           
445            <h4 id="_cw_droplist_pm_keyword_ROW">ROW&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
446             
447             
448             
449             
450             
451             
452             
453             
454            </h4>
455       
456            <div class="comments">
457 Buttons will be arranged in the number of rows
458 specified by this keyword.
459</div>
460           
461            <h4 id="_cw_droplist_pm_keyword_COLUMN">COLUMN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
462             
463             
464             
465             
466             
467             
468             
469             
470            </h4>
471       
472            <div class="comments">
473 Buttons will be arranged in the number of columns
474 specified by this keyword.
475</div>
476           
477            <h4 id="_cw_droplist_pm_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
478             
479             
480             
481             
482             
483             
484             
485             
486            </h4>
487       
488            <div class="comments">
489 Used to pass keywords
490</div>
491           
492         
493
494          <h3>Examples</h3><div class="preformat">
495 See the program provided above (testwid and the associated procedure, testwid_event).
496</div>
497          <h3>Version history</h3>
498         
499          <h4>Version</h4><div class="preformat">
500 $Id: cw_droplist_pm.pro 295 2007-09-25 10:16:00Z pinsard $
501</div>
502          <h4>History</h4><div class="preformat">
503 Sebastien Masson (smasson@lodyc.jussieu.fr)
504                      6/9/1999
505</div>
506         
507         
508          <h3>Known issues</h3>
509         
510         
511         
512          <h4>Restrictions</h4><div class="preformat">
513
514     Widget Events Returned by Droplist Widgets
515
516   Pressing the mouse button while the mouse cursor is over an
517   element of a droplist widget causes the widget to change the label
518   on the droplist button and to generate an event. The appearance of
519   any previously selected element is restored to normal at the same
520   time. The event structure returned by the WIDGET_EVENT function is
521   defined by the following statement:
522
523   { CW_DROPLIST_PM, ID:0L, TOP:0L, HANDLER:0L, INDEX:0L, OUT:0 }
524
525   The first three fields are the standard fields found in every
526   widget event.
527   INDEX returns the index of the selected item. This can be used to
528   index the array of names originally used to set the widget''s
529   value
530   OUT:It is an integer which can take 3 values:
531       1 : If we press + when the index is already at the max
532       Comment: In this case, the index stay at the max
533       -1: If we press - when the index is already at the min
534       Comment: In this case, the index stay at the min
535       0 : In other cases
536
537   Keywords to WIDGET_CONTROL
538
539   A number of keywords to the WIDGET_CONTROL procedure affect the
540   behavior of cw_slider_pm widget: GET_VALUE and SET_VALUE.
541       1) GET_VALUE
542   widget_control,wid_id,get_value=resultat
543   Send back, in the result variable, a structure of 3 elements whose
544   names are inspired by keywords we can pass at widget_control when
545   we use WIDGET_COMBOBOX:
546            DROPLIST_NUMBER: the number of elements currently
547            contained in the specified droplist widget.
548            DROPLIST_SELECT: the zero-based number of the
549            currently-selected element (i.e., the currently-displayed
550            element) in the specified droplist widget.
551            DYNAMIC_RESIZE: a True value (1) if the widget specified
552            by Widget_ID is a button, droplist, or label widget that
553            has had its DYNAMIC_RESIZE attribute set. Otherwise,
554            False (0) is returned.
555       2) SET_VALUE
556   widget_control,wid_id,set_value=impose
557   permet de modifier l''etat de la droplist comme on peut le faire
558   pour WIDGET_DROPLIST Impose peut etre:
559       a) The contents of the list widget (string or string array)
560       b) A structure which can have for elements (from 1 to 3):
561            DYNAMIC_RESIZE:Set this keyword to activate (if set to 1)
562            or deactivate (if set to 0) dynamic resizing of the
563            specified CW_DROPLIST_PM widget (see the documentation
564            for the DYNAMIC_RESIZE keyword to WIDGET_DROPLIST
565            procedure for more information about dynamic widget
566            resizing).
567            DROPLIST_SELECT:Set this keyword to return the zero-based
568            number of the currently-selected element (i.e., the
569            currently-displayed element) in the specified droplist
570            widget.
571            VALUE: The contents of the list widget (string or string
572            array)
573</div>
574       
575         
576         
577         
578         
579         
580         
581         
582       
583          <h3>Statistics</h3>
584          <table class="statistics">
585            <tr><td>McCabe cyclic</td><td>           6</td></tr>
586            <tr><td>McCabe essential</td><td>           1</td></tr>
587            <tr><td>McCabe modular design</td><td>           1</td></tr>
588          </table>
589         
590       
591        </div>
592       
593      </div>
594
595     
596
597      <div id="tagline">Produced by IDLdoc 2.0.</div>
598
599    </div>
600
601  </body>
602</html>
Note: See TracBrowser for help on using the repository browser.