source: trunk/SRC/Documentation/idldoc_assistant_output/Colors/xlct.html @ 234

Last change on this file since 234 was 234, checked in by pinsard, 17 years ago

new idldoc html and assistant outputs
File size: 7.0 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>xlct.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="newpalette.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="xpal.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Colors/</font></h1>
58    <h2>xlct.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Like xloadct but fastest to write and call by default the palette
65 palette.tbl which can be in any directory
66
67
68   
69
70     
71      <a name="#_xlct"></a>
72
73      <h2>xlct  <font size="-1" color="#006633">
74 Widget, Color
75</font></h2>
76
77      <p><font face="Courier">xlct, <a href="#_xlct_keyword_SILENT">SILENT</a>=<i>SILENT</i>, <a href="#_xlct_keyword_GROUP">GROUP</a>=<i>GROUP</i>, <a href="#_xlct_keyword_FILE">FILE</a>=<i>FILE</i>, <a href="#_xlct_keyword_USE_CURRENT">USE_CURRENT</a>=<i>USE_CURRENT</i>, <a href="#_xlct_keyword_NCOLORS">NCOLORS</a>=<i>NCOLORS</i>, <a href="#_xlct_keyword_BOTTOM">BOTTOM</a>=<i>BOTTOM</i>, <a href="#_xlct_keyword_MODAL">MODAL</a>=<i>MODAL</i>, <a href="#_xlct_keyword_BLOCK">BLOCK</a>=<i>BLOCK</i>, <a href="#_xlct_keyword_UPDATECALLBACK">UPDATECALLBACK</a>=<i>UPDATECALLBACK</i>, <a href="#_xlct_keyword_UPDATECBDATA">UPDATECBDATA</a>=<i>UPDATECBDATA</i></font></p>
78
79   
80
81   
82
83   
84
85   
86    <h3>Keywords</h3>
87
88   
89    <a name="#_xlct_keyword_SILENT"></a>
90    <h4>SILENT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
91     
92     
93     
94     
95     
96     
97     
98     
99    </h4>
100
101   
102 Normally, no informational message is printed when a color map
103 is loaded. If this keyword is present and zero, this message is printed.
104
105   
106    <a name="#_xlct_keyword_GROUP"></a>
107    <h4>GROUP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
108     
109     
110     
111     
112     
113     
114     
115     
116    </h4>
117
118   
119 The widget ID of the widget that calls Xlct. When  this ID is
120 specified, a death of the caller results in a death of Xlct
121
122   
123    <a name="#_xlct_keyword_FILE"></a>
124    <h4>FILE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
125     
126     
127     
128     
129     
130     
131      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'palette.tbl'</i></font>
132     
133    </h4>
134
135   
136 If this keyword is set, the file by the given name is used
137 instead of the file colors1.tbl in the IDL directory.  This
138 allows multiple IDL users to have their own color table file.
139
140   
141    <a name="#_xlct_keyword_USE_CURRENT"></a>
142    <h4>USE_CURRENT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
143     
144     
145     
146     
147     
148     
149     
150     
151    </h4>
152
153   
154 If set, use the current color tables, regardless of
155 the contents of the COMMON block COLORS.
156
157   
158    <a name="#_xlct_keyword_NCOLORS"></a>
159    <h4>NCOLORS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
160     
161     
162     
163     
164     
165     
166      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>!D.TABLE_SIZE </i></font>
167     
168    </h4>
169
170   
171 number of colors to use. Use color indexes from BOTTOM to the
172 smaller of !D.TABLE_SIZE-1 and NCOLORS-1.
173
174   
175    <a name="#_xlct_keyword_BOTTOM"></a>
176    <h4>BOTTOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
177     
178     
179     
180     
181     
182     
183      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0.</i></font>
184     
185    </h4>
186
187   
188 first color index to use. Use color indexes from BOTTOM to
189 BOTTOM+NCOLORS-1.
190
191   
192    <a name="#_xlct_keyword_MODAL"></a>
193    <h4>MODAL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
194     
195     
196     
197     
198     
199     
200      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>not run in modal mode</i></font>
201     
202    </h4>
203
204   
205 If set, then XLCT runs in "modal" mode, meaning that
206 all other widgets are blocked until the user quits XLCT.
207 A group leader must be specified (via the GROUP keyword)
208 for the MODAL keyword to have any effect.
209
210   
211    <a name="#_xlct_keyword_BLOCK"></a>
212    <h4>BLOCK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
213     
214     
215     
216     
217     
218     
219     
220     
221    </h4>
222
223   
224 Set this keyword to have XMANAGER block when this
225 application is registered.  By default the Xmanager
226 keyword NO_BLOCK is set to 1 to provide access to the
227 command line if active command line processing is available.
228 Note that setting BLOCK for this application will cause
229 all widget applications to block, not only this
230 application.  For more information see the NO_BLOCK keyword
231 to XMANAGER.
232
233   
234    <a name="#_xlct_keyword_UPDATECALLBACK"></a>
235    <h4>UPDATECALLBACK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
236     
237     
238     
239     
240     
241     
242     
243     
244    </h4>
245
246   
247 Set this keyword to a string containing the name of
248 a user-supplied procedure that will be called when the color
249 table is updated by XLCT.  The procedure may optionally
250 accept a keyword called DATA, which will be automatically
251 set to the value specified by the optional UPDATECBDATA keyword.
252
253   
254    <a name="#_xlct_keyword_UPDATECBDATA"></a>
255    <h4>UPDATECBDATA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
256     
257     
258     
259     
260     
261     
262     
263     
264    </h4>
265
266   
267 Set this keyword to a value of any type. It will be
268 passed via the DATA keyword to the user-supplied procedure
269 specified via the UPDATECALLBACK keyword, if any. If the
270 UPDATECBDATA keyword is not set the value accepted by the
271 DATA keyword to the procedure specified by UPDATECALLBACK
272 will be undefined.
273
274   
275   
276
277   
278    </pre><h3>Version history</h3>
279   
280    <h4>Version</h4>
281 $Id: xlct.pro 231 2007-03-19 17:15:51Z pinsard $
282
283    <h4>History</h4>
284 5/5/1999 copy of xloadct par Sebastien Masson (smasson@lodyc.jussieu.fr)
285
286   
287
288   
289   
290   
291   
292   
293
294    <h3>Other attributes</h3>
295   
296   
297   
298   
299   
300    <h4>Common blocks used</h4>colors
301xlct_com
302
303    <font size="-3"><p>&nbsp;</p></font>
304    <hr size="1" color="#CCCCCC"/>
305     
306
307   
308
309    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
310
311  </body>
312</html>
Note: See TracBrowser for help on using the repository browser.