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

Last change on this file since 163 was 163, checked in by navarro, 18 years ago

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