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

Last change on this file was 338, checked in by smasson, 16 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 327 2007-12-13 16:22:35Z pinsard $
191</div>
192          <h4>History</h4><div class="preformat">
193</div>
194         
195         
196          <h3>Known issues</h3>
197         
198         
199         
200          <h4>Restrictions</h4><div class="preformat">
201</div>
202       
203          <h3>Other attributes</h3>
204         
205         
206          <h4>Uses routines</h4><div class="preformat">
207</div>
208         
209         
210         
211       
212          <h3>Statistics</h3>
213          <table class="statistics">
214            <tr><td>McCabe cyclic</td><td>           7</td></tr>
215            <tr><td>McCabe essential</td><td>           1</td></tr>
216            <tr><td>McCabe modular design</td><td>           1</td></tr>
217          </table>
218         
219       
220        </div>
221       
222
223        <div class="routine_details" id="_cw_droplist_pm_get_value">
224
225          <h2><a class="top" href="#container">top</a>cw_droplist_pm_get_value <span class="categories">
226 Compound widget
227</span></h2>
228       
229          <p class="header">
230            <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>
231       
232          <div class="comments">
233</div>
234
235          <h3>Return value</h3><div class="preformat">
236</div>
237
238         
239            <h3>Parameters</h3>
240       
241           
242            <h4 id="_cw_droplist_pm_get_value_param_id">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
243             
244             
245             
246             
247             
248             
249             
250             
251            </h4>
252       
253          <div class="comments">
254</div>
255           
256
257         
258
259         
260
261          <h3>Examples</h3><div class="preformat">
262</div>
263          <h3>Version history</h3>
264         
265          <h4>Version</h4><div class="preformat">
266 $Id: cw_droplist_pm.pro 327 2007-12-13 16:22:35Z pinsard $
267</div>
268          <h4>History</h4><div class="preformat">
269</div>
270         
271         
272          <h3>Known issues</h3>
273         
274         
275         
276          <h4>Restrictions</h4><div class="preformat">
277</div>
278       
279          <h3>Other attributes</h3>
280         
281         
282          <h4>Uses routines</h4><div class="preformat">
283</div>
284         
285         
286         
287       
288          <h3>Statistics</h3>
289          <table class="statistics">
290            <tr><td>McCabe cyclic</td><td>           1</td></tr>
291            <tr><td>McCabe essential</td><td>           1</td></tr>
292            <tr><td>McCabe modular design</td><td>           1</td></tr>
293          </table>
294         
295       
296        </div>
297       
298
299        <div class="routine_details" id="_cw_droplist_pm_event">
300
301          <h2><a class="top" href="#container">top</a>cw_droplist_pm_event <span class="categories">
302 Compound widget
303</span></h2>
304       
305          <p class="header">
306            <span class="result">result = </span>cw_droplist_pm_event(<span class="result"><a href="#_cw_droplist_pm_event_param_event">event</a></span>)</p>
307       
308          <div class="comments">
309</div>
310
311          <h3>Return value</h3><div class="preformat">
312</div>
313
314         
315            <h3>Parameters</h3>
316       
317           
318            <h4 id="_cw_droplist_pm_event_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
319             
320             
321             
322             
323             
324             
325             
326             
327            </h4>
328       
329          <div class="comments">
330</div>
331           
332
333         
334
335         
336
337          <h3>Examples</h3><div class="preformat">
338</div>
339          <h3>Version history</h3>
340         
341          <h4>Version</h4><div class="preformat">
342 $Id: cw_droplist_pm.pro 327 2007-12-13 16:22:35Z pinsard $
343</div>
344          <h4>History</h4><div class="preformat">
345</div>
346         
347         
348          <h3>Known issues</h3>
349         
350         
351         
352          <h4>Restrictions</h4><div class="preformat">
353</div>
354       
355          <h3>Other attributes</h3>
356         
357         
358          <h4>Uses routines</h4><div class="preformat">
359</div>
360         
361         
362         
363       
364          <h3>Statistics</h3>
365          <table class="statistics">
366            <tr><td>McCabe cyclic</td><td>           6</td></tr>
367            <tr><td>McCabe essential</td><td>           1</td></tr>
368            <tr><td>McCabe modular design</td><td>           1</td></tr>
369          </table>
370         
371       
372        </div>
373       
374
375        <div class="routine_details" id="_cw_droplist_pm">
376
377          <h2><a class="top" href="#container">top</a>cw_droplist_pm <span class="categories">
378 Compound widget
379</span></h2>
380       
381          <p class="header">
382            <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>
383       
384          <div class="comments">
385</div>
386
387          <h3>Return value</h3><div class="preformat">
388 The returned value of this function is the widget ID of the
389 newly-created animation widget.
390</div>
391
392         
393            <h3>Parameters</h3>
394       
395           
396            <h4 id="_cw_droplist_pm_param_parent">parent&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
397              <span class="attr">in</span>
398             
399             
400              <span class="attr">required</span>
401             
402             
403             
404             
405            </h4>
406       
407          <div class="comments">
408 The widget ID of the parent widget.
409</div>
410           
411
412         
413
414         
415
416            <h3>Keywords</h3>
417           
418            <h4 id="_cw_droplist_pm_keyword_UVALUE">UVALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
419             
420             
421             
422             
423             
424             
425             
426             
427            </h4>
428       
429            <div class="comments">
430 The user value to be associated with the widget.
431</div>
432           
433            <h4 id="_cw_droplist_pm_keyword_UNAME">UNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
434             
435             
436             
437             
438             
439             
440             
441             
442            </h4>
443       
444            <div class="comments">
445 The user name to be associated with the widget.
446</div>
447           
448            <h4 id="_cw_droplist_pm_keyword_ROW">ROW&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
449             
450             
451             
452             
453             
454             
455             
456             
457            </h4>
458       
459            <div class="comments">
460 Buttons will be arranged in the number of rows
461 specified by this keyword.
462</div>
463           
464            <h4 id="_cw_droplist_pm_keyword_COLUMN">COLUMN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
465             
466             
467             
468             
469             
470             
471             
472             
473            </h4>
474       
475            <div class="comments">
476 Buttons will be arranged in the number of columns
477 specified by this keyword.
478</div>
479           
480            <h4 id="_cw_droplist_pm_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
481             
482             
483             
484             
485             
486             
487             
488             
489            </h4>
490       
491            <div class="comments">
492 Used to pass keywords
493</div>
494           
495         
496
497          <h3>Examples</h3><div class="preformat">
498 See the program provided above (testwid and the associated procedure, testwid_event).
499</div>
500          <h3>Version history</h3>
501         
502          <h4>Version</h4><div class="preformat">
503 $Id: cw_droplist_pm.pro 327 2007-12-13 16:22:35Z pinsard $
504</div>
505          <h4>History</h4><div class="preformat">
506 Sebastien Masson (smasson@lodyc.jussieu.fr)
507                      6/9/1999
508</div>
509         
510         
511          <h3>Known issues</h3>
512         
513         
514         
515          <h4>Restrictions</h4><div class="preformat">
516
517     Widget Events Returned by Droplist Widgets
518
519   Pressing the mouse button while the mouse cursor is over an
520   element of a droplist widget causes the widget to change the label
521   on the droplist button and to generate an event. The appearance of
522   any previously selected element is restored to normal at the same
523   time. The event structure returned by the WIDGET_EVENT function is
524   defined by the following statement:
525
526   { CW_DROPLIST_PM, ID:0L, TOP:0L, HANDLER:0L, INDEX:0L, OUT:0 }
527
528   The first three fields are the standard fields found in every
529   widget event.
530   INDEX returns the index of the selected item. This can be used to
531   index the array of names originally used to set the widget''s
532   value
533   OUT:It is an integer which can take 3 values:
534       1 : If we press + when the index is already at the max
535       Comment: In this case, the index stay at the max
536       -1: If we press - when the index is already at the min
537       Comment: In this case, the index stay at the min
538       0 : In other cases
539
540   Keywords to WIDGET_CONTROL
541
542   A number of keywords to the WIDGET_CONTROL procedure affect the
543   behavior of cw_slider_pm widget: GET_VALUE and SET_VALUE.
544       1) GET_VALUE
545   widget_control,wid_id,get_value=resultat
546   Send back, in the result variable, a structure of 3 elements whose
547   names are inspired by keywords we can pass at widget_control when
548   we use WIDGET_COMBOBOX:
549            DROPLIST_NUMBER: the number of elements currently
550            contained in the specified droplist widget.
551            DROPLIST_SELECT: the zero-based number of the
552            currently-selected element (i.e., the currently-displayed
553            element) in the specified droplist widget.
554            DYNAMIC_RESIZE: a True value (1) if the widget specified
555            by Widget_ID is a button, droplist, or label widget that
556            has had its DYNAMIC_RESIZE attribute set. Otherwise,
557            False (0) is returned.
558       2) SET_VALUE
559   widget_control,wid_id,set_value=impose
560   permet de modifier l''etat de la droplist comme on peut le faire
561   pour WIDGET_DROPLIST Impose peut etre:
562       a) The contents of the list widget (string or string array)
563       b) A structure which can have for elements (from 1 to 3):
564            DYNAMIC_RESIZE:Set this keyword to activate (if set to 1)
565            or deactivate (if set to 0) dynamic resizing of the
566            specified CW_DROPLIST_PM widget (see the documentation
567            for the DYNAMIC_RESIZE keyword to WIDGET_DROPLIST
568            procedure for more information about dynamic widget
569            resizing).
570            DROPLIST_SELECT:Set this keyword to return the zero-based
571            number of the currently-selected element (i.e., the
572            currently-displayed element) in the specified droplist
573            widget.
574            VALUE: The contents of the list widget (string or string
575            array)
576</div>
577       
578         
579         
580         
581         
582         
583         
584         
585       
586          <h3>Statistics</h3>
587          <table class="statistics">
588            <tr><td>McCabe cyclic</td><td>           6</td></tr>
589            <tr><td>McCabe essential</td><td>           1</td></tr>
590            <tr><td>McCabe modular design</td><td>           1</td></tr>
591          </table>
592         
593       
594        </div>
595       
596      </div>
597
598     
599
600      <div id="tagline">Produced by IDLdoc 2.0.</div>
601
602    </div>
603
604  </body>
605</html>
Note: See TracBrowser for help on using the repository browser.