Ignore:
Timestamp:
08/09/06 12:21:11 (18 years ago)
Author:
navarro
Message:

english and nicer header (3b)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/WIDGET/COMPOUND_WIDGET/cw_droplist_pm.html

    r138 r151  
    696696      </div> 
    697697 
    698       <div id="file_comments"></div> 
     698      <div id="file_comments"> 
     699 Like WIDGET_DROPLIST but here, their are 2 buttons + and - to move the widget from +/- 1 
     700</div> 
    699701 
    700702       
     
    711713           
    712714          <dt><p><a href="#_cw_droplist_pm_set_value">cw_droplist_pm_set_value<span class="result">, id, value</span></a></p><dt> 
    713           <dd>  NAME: cw_droplist_pm   PURPOSE: widget equivalent a WIDGET_DROPLIST sauf qu'en plus on  dispose de 2 bouttons + et - pour deplacer le widget de +/- 1.</dd>      
     715          <dd></dd>      
    714716           
    715717          <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> 
     
    720722           
    721723          <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> 
    722           <dd></dd>      
     724          <dd> </dd>     
    723725                 
    724726        </dl> 
     
    736738            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> 
    737739         
     740          <div class="comments"></div> 
     741 
     742           
     743 
     744           
     745            <h3>Parameters</h3> 
     746         
     747             
     748            <h4 id="_cw_droplist_pm_set_value_param_id">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     749               
     750               
     751               
     752               
     753               
     754               
     755               
     756               
     757            </h4> 
     758         
     759          <div class="comments"></div> 
     760             
     761            <h4 id="_cw_droplist_pm_set_value_param_value">value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     762               
     763               
     764               
     765               
     766               
     767               
     768               
     769               
     770            </h4> 
     771         
     772          <div class="comments"></div> 
     773             
     774 
     775           
     776 
     777           
     778 
     779           
     780           
     781           
     782           
     783           
     784           
     785           
     786           
     787           
     788           
     789           
     790           
     791         
     792           
     793           
     794           
     795           
     796           
     797           
     798           
     799         
     800           
     801         
     802        </div> 
     803         
     804 
     805        <div class="routine_details" id="_cw_droplist_pm_get_value"> 
     806 
     807          <h2><a class="top" href="#container">top</a>cw_droplist_pm_get_value </h2> 
     808         
     809          <p class="header"> 
     810            <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> 
     811         
     812          <div class="comments"></div> 
     813 
     814           
     815 
     816           
     817            <h3>Parameters</h3> 
     818         
     819             
     820            <h4 id="_cw_droplist_pm_get_value_param_id">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     821               
     822               
     823               
     824               
     825               
     826               
     827               
     828               
     829            </h4> 
     830         
     831          <div class="comments"></div> 
     832             
     833 
     834           
     835 
     836           
     837 
     838           
     839           
     840           
     841           
     842           
     843           
     844           
     845           
     846           
     847           
     848           
     849           
     850         
     851           
     852           
     853           
     854           
     855           
     856           
     857           
     858         
     859           
     860         
     861        </div> 
     862         
     863 
     864        <div class="routine_details" id="_cw_droplist_pm_event"> 
     865 
     866          <h2><a class="top" href="#container">top</a>cw_droplist_pm_event </h2> 
     867         
     868          <p class="header"> 
     869            <span class="result">result = </span>cw_droplist_pm_event(<span class="result"><a href="#_cw_droplist_pm_event_param_event">event</a></span>)</p> 
     870         
     871          <div class="comments"></div> 
     872 
     873           
     874 
     875           
     876            <h3>Parameters</h3> 
     877         
     878             
     879            <h4 id="_cw_droplist_pm_event_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     880               
     881               
     882               
     883               
     884               
     885               
     886               
     887               
     888            </h4> 
     889         
     890          <div class="comments"></div> 
     891             
     892 
     893           
     894 
     895           
     896 
     897           
     898           
     899           
     900           
     901           
     902           
     903           
     904           
     905           
     906           
     907           
     908           
     909         
     910           
     911           
     912           
     913           
     914           
     915           
     916           
     917         
     918           
     919         
     920        </div> 
     921         
     922 
     923        <div class="routine_details" id="_cw_droplist_pm"> 
     924 
     925          <h2><a class="top" href="#container">top</a>cw_droplist_pm <span class="categories"> 
     926 compound widget 
     927 </span></h2> 
     928         
     929          <p class="header"> 
     930            <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> 
     931         
    738932          <div class="comments"> 
    739  NAME: cw_droplist_pm 
    740  
    741  PURPOSE: widget equivalent a WIDGET_DROPLIST sauf qu'en plus on 
    742  dispose de 2 bouttons + et - pour deplacer le widget de +/- 1. 
    743  
    744  CATEGORY: compound widget (aide a l''ecriture des widgets) 
    745  
    746  CALLING SEQUENCE: id=cw_droplist_pm(parent) 
    747   
    748  INPUTS: 
    749          Parent: The widget ID of the parent widget. 
    750  
    751  KEYWORD PARAMETERS:tous ceux de WIDGET_DROPLIST 
    752  
    753  OUTPUTS: 
    754          The returned value of this function is the widget ID of the 
    755          newly-created animation widget. 
    756  
    757  COMMON BLOCKS: none 
    758  
    759  SIDE EFFECTS: 
     933</div> 
     934 
     935          <h3>Return value</h3><div class="preformat"> 
     936 The returned value of this function is the widget ID of the 
     937 newly-created animation widget. 
     938</div> 
     939 
     940           
     941            <h3>Parameters</h3> 
     942         
     943             
     944            <h4 id="_cw_droplist_pm_param_parent">parent&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     945              <span class="attr">in</span> 
     946               
     947               
     948              <span class="attr">required</span> 
     949               
     950               
     951               
     952               
     953            </h4> 
     954         
     955          <div class="comments"> 
     956 The widget ID of the parent widget. 
     957</div> 
     958             
     959 
     960           
     961 
     962           
     963 
     964            <h3>Keywords</h3> 
     965             
     966            <h4 id="_cw_droplist_pm_keyword_UVALUE">UVALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     967               
     968               
     969               
     970               
     971               
     972               
     973               
     974               
     975            </h4> 
     976         
     977            <div class="comments"> 
     978 The user value to be associated with the widget. 
     979 </div> 
     980             
     981            <h4 id="_cw_droplist_pm_keyword_UNAME">UNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     982               
     983               
     984               
     985               
     986               
     987               
     988               
     989               
     990            </h4> 
     991         
     992            <div class="comments"> 
     993 The user name to be associated with the widget. 
     994 </div> 
     995             
     996            <h4 id="_cw_droplist_pm_keyword_ROW">ROW&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     997               
     998               
     999               
     1000               
     1001               
     1002               
     1003               
     1004               
     1005            </h4> 
     1006         
     1007            <div class="comments"> 
     1008 Buttons will be arranged in the number of rows 
     1009 specified by this keyword. 
     1010 </div> 
     1011             
     1012            <h4 id="_cw_droplist_pm_keyword_COLUMN">COLUMN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     1013               
     1014               
     1015               
     1016               
     1017               
     1018               
     1019               
     1020               
     1021            </h4> 
     1022         
     1023            <div class="comments"> 
     1024 Buttons will be arranged in the number of columns 
     1025 specified by this keyword. 
     1026 </div> 
     1027             
     1028            <h4 id="_cw_droplist_pm_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     1029               
     1030               
     1031               
     1032               
     1033               
     1034               
     1035               
     1036               
     1037            </h4> 
     1038         
     1039            <div class="comments"> 
     1040 Used to pass your keywords 
     1041</div> 
     1042             
     1043           
     1044 
     1045          <h3>Examples</h3><div class="preformat"> 
     1046 See the program provided above (testwid and the associated procedure, testwid_event). 
     1047</div> 
     1048          <h3>Version history</h3> 
     1049           
     1050          <h4>Version</h4><div class="preformat"> 
     1051 $Id: cw_droplist_pm.pro 150 2006-08-09 10:12:54Z navarro $ 
     1052</div> 
     1053          <h4>History</h4><div class="preformat"></div> 
     1054           
     1055           
     1056          <h3>Known issues</h3> 
     1057           
     1058           
     1059           
     1060          <h4>Restrictions</h4><div class="preformat"> 
    7601061 
    7611062     Widget Events Returned by Droplist Widgets 
     
    7751076   index the array of names originally used to set the widget''s 
    7761077   value 
    777    OUT:c''est un entier qui peut prendre 3 valeurs: 
    778        1 : si on appuie sur + alors que l''index est deja aux max. rq: 
    779        ds ce cas l''index reste au max 
    780        -1: si on appuie sur - alors que l''index est deja aux min. rq: 
    781        ds ce cas l''index reste au min 
    782        0 : ds les autres cas! 
     1078   OUT:It is an integer which can take 3 values:  
     1079       1 : If we press + when the index is already at the max 
     1080       Comment: In this case, the index stay at the max 
     1081       -1: If we press - when the index is already at the min 
     1082       Comment: In this case, the index stay at the min 
     1083       0 : In other cases 
    7831084 
    7841085   Keywords to WIDGET_CONTROL 
     
    7881089       1) GET_VALUE 
    7891090   widget_control,wid_id,get_value=resultat 
    790    retourne ds la variable resultat une structure de 3 elements dont 
    791    les noms sont inspires des mots cles que l''on peut passer a 
    792    widget_control qd on utilise WIDGET_DROPLIST: 
     1091   Send back, in the result variable, a structure of 3 elements whose  
     1092   names are inspired by keywords we can pass at widget_control when 
     1093   we use WIDGET_COMBOBOX: 
    7931094            DROPLIST_NUMBER: the number of elements currently 
    7941095            contained in the specified droplist widget. 
     
    8051106   pour WIDGET_DROPLIST Impose peut etre: 
    8061107       a) The contents of the list widget (string or string array) 
    807        b) une structure qui peut avoir comme elements (de 1 a 3): 
     1108       b) A structure which can have for elements (from 1 to 3):  
    8081109            DYNAMIC_RESIZE:Set this keyword to activate (if set to 1) 
    8091110            or deactivate (if set to 0) dynamic resizing of the 
     
    8181119            VALUE: The contents of the list widget (string or string 
    8191120            array) 
    820  
    821  RESTRICTIONS: 
    822  
    823  EXAMPLE: cf utiliser le programme founit i-dessous: testwid et la 
    824  procedure associee, testwid_event. 
    8251121</div> 
    826  
    827            
    828  
    829            
    830             <h3>Parameters</h3> 
    831          
    832              
    833             <h4 id="_cw_droplist_pm_set_value_param_id">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    834                
    835                
    836                
    837                
    838                
    839                
    840                
    841                
    842             </h4> 
    843          
    844           <div class="comments"></div> 
    845              
    846             <h4 id="_cw_droplist_pm_set_value_param_value">value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    847                
    848                
    849                
    850                
    851                
    852                
    853                
    854                
    855             </h4> 
    856          
    857           <div class="comments"></div> 
    858              
    859  
    860            
    861  
    862            
    863  
    864            
    865            
    866            
    867            
    868            
    869            
    870            
    871            
    872            
    873            
    874            
    875            
    876          
    877            
    878            
    879            
    880            
    881            
    882            
    883            
    884          
    885            
    886          
    887         </div> 
    888          
    889  
    890         <div class="routine_details" id="_cw_droplist_pm_get_value"> 
    891  
    892           <h2><a class="top" href="#container">top</a>cw_droplist_pm_get_value </h2> 
    893          
    894           <p class="header"> 
    895             <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> 
    896          
    897           <div class="comments"></div> 
    898  
    899            
    900  
    901            
    902             <h3>Parameters</h3> 
    903          
    904              
    905             <h4 id="_cw_droplist_pm_get_value_param_id">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    906                
    907                
    908                
    909                
    910                
    911                
    912                
    913                
    914             </h4> 
    915          
    916           <div class="comments"></div> 
    917              
    918  
    919            
    920  
    921            
    922  
    923            
    924            
    925            
    926            
    927            
    928            
    929            
    930            
    931            
    932            
    933            
    934            
    935          
    936            
    937            
    938            
    939            
    940            
    941            
    942            
    943          
    944            
    945          
    946         </div> 
    947          
    948  
    949         <div class="routine_details" id="_cw_droplist_pm_event"> 
    950  
    951           <h2><a class="top" href="#container">top</a>cw_droplist_pm_event </h2> 
    952          
    953           <p class="header"> 
    954             <span class="result">result = </span>cw_droplist_pm_event(<span class="result"><a href="#_cw_droplist_pm_event_param_event">event</a></span>)</p> 
    955          
    956           <div class="comments"></div> 
    957  
    958            
    959  
    960            
    961             <h3>Parameters</h3> 
    962          
    963              
    964             <h4 id="_cw_droplist_pm_event_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    965                
    966                
    967                
    968                
    969                
    970                
    971                
    972                
    973             </h4> 
    974          
    975           <div class="comments"></div> 
    976              
    977  
    978            
    979  
    980            
    981  
    982            
    983            
    984            
    985            
    986            
    987            
    988            
    989            
    990            
    991            
    992            
    993            
    994          
    995            
    996            
    997            
    998            
    999            
    1000            
    1001            
    1002          
    1003            
    1004          
    1005         </div> 
    1006          
    1007  
    1008         <div class="routine_details" id="_cw_droplist_pm"> 
    1009  
    1010           <h2><a class="top" href="#container">top</a>cw_droplist_pm </h2> 
    1011          
    1012           <p class="header"> 
    1013             <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> 
    1014          
    1015           <div class="comments"></div> 
    1016  
    1017            
    1018  
    1019            
    1020             <h3>Parameters</h3> 
    1021          
    1022              
    1023             <h4 id="_cw_droplist_pm_param_parent">parent&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    1024                
    1025                
    1026                
    1027                
    1028                
    1029                
    1030                
    1031                
    1032             </h4> 
    1033          
    1034           <div class="comments"></div> 
    1035              
    1036  
    1037            
    1038  
    1039            
    1040  
    1041             <h3>Keywords</h3> 
    1042              
    1043             <h4 id="_cw_droplist_pm_keyword_UVALUE">UVALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    1044                
    1045                
    1046                
    1047                
    1048                
    1049                
    1050                
    1051                
    1052             </h4> 
    1053          
    1054             <div class="comments"></div> 
    1055              
    1056             <h4 id="_cw_droplist_pm_keyword_UNAME">UNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    1057                
    1058                
    1059                
    1060                
    1061                
    1062                
    1063                
    1064                
    1065             </h4> 
    1066          
    1067             <div class="comments"></div> 
    1068              
    1069             <h4 id="_cw_droplist_pm_keyword_ROW">ROW&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    1070                
    1071                
    1072                
    1073                
    1074                
    1075                
    1076                
    1077                
    1078             </h4> 
    1079          
    1080             <div class="comments"></div> 
    1081              
    1082             <h4 id="_cw_droplist_pm_keyword_COLUMN">COLUMN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    1083                
    1084                
    1085                
    1086                
    1087                
    1088                
    1089                
    1090                
    1091             </h4> 
    1092          
    1093             <div class="comments"></div> 
    1094              
    1095             <h4 id="_cw_droplist_pm_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    1096                
    1097                
    1098                
    1099                
    1100                
    1101                
    1102                
    1103                
    1104             </h4> 
    1105          
    1106             <div class="comments"></div> 
    1107              
    1108            
    1109  
    1110            
    1111            
    1112            
    1113            
    1114            
    1115            
    1116            
    1117            
    1118            
    1119            
    1120            
    1121            
    11221122         
    11231123           
Note: See TracChangeset for help on using the changeset viewer.