source: trunk/SRC/Documentation/idldoc_html_output/Colors/xlct.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation

File size: 8.5 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>xlct.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="xlct.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="../../../Colors//xlct.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="newpalette.html">&lt;&lt;prev file</a> | <a href="xpal.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="xlct.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&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">Colors/</a></h1>
82      <h2 class="pro_file">xlct.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Like <a href="/Applications/itt/idl64/help/online_help/XLOADCT.html">XLOADCT</a> but fastest to write and call by default
91 the palette palette.tbl which can be in any directory
92</div>
93
94     
95
96     
97
98     
99
100     
101
102      <div id="routine_details">
103       
104
105        <div class="routine_details" id="_xlct">
106
107          <h2><a class="top" href="#container">top</a>xlct <span class="categories">
108 Widget, Color
109</span></h2>
110       
111          <p class="header">
112            xlct, <a href="#_xlct_keyword_SILENT">SILENT</a>=<span class="result">SILENT</span>, <a href="#_xlct_keyword_GROUP">GROUP</a>=<span class="result">GROUP</span>, <a href="#_xlct_keyword_FILE">FILE</a>=<span class="result">FILE</span>, <a href="#_xlct_keyword_USE_CURRENT">USE_CURRENT</a>=<span class="result">USE_CURRENT</span>, <a href="#_xlct_keyword_NCOLORS">NCOLORS</a>=<span class="result">NCOLORS</span>, <a href="#_xlct_keyword_BOTTOM">BOTTOM</a>=<span class="result">BOTTOM</span>, <a href="#_xlct_keyword_MODAL">MODAL</a>=<span class="result">MODAL</span>, <a href="#_xlct_keyword_BLOCK">BLOCK</a>=<span class="result">BLOCK</span>, <a href="#_xlct_keyword_UPDATECALLBACK">UPDATECALLBACK</a>=<span class="result">UPDATECALLBACK</span>, <a href="#_xlct_keyword_UPDATECBDATA">UPDATECBDATA</a>=<span class="result">UPDATECBDATA</span></p>
113       
114          <div class="comments">
115</div>
116
117         
118
119         
120
121         
122
123            <h3>Keywords</h3>
124           
125            <h4 id="_xlct_keyword_SILENT">SILENT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126             
127             
128             
129             
130             
131             
132             
133             
134            </h4>
135       
136            <div class="comments">
137 Normally, no informational message is printed when a color map
138 is loaded. If this keyword is present and zero, this message is printed.
139</div>
140           
141            <h4 id="_xlct_keyword_GROUP">GROUP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
142             
143             
144             
145             
146             
147             
148             
149             
150            </h4>
151       
152            <div class="comments">
153 The widget ID of the widget that calls Xlct. When  this ID is
154 specified, a death of the caller results in a death of Xlct
155</div>
156           
157            <h4 id="_xlct_keyword_FILE">FILE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
158             
159             
160             
161             
162             
163             
164              <span class="attr">default:</span> <span class="value">'palette.tbl'</span>
165             
166            </h4>
167       
168            <div class="comments">
169 If this keyword is set, the file by the given name is used
170 instead of the file colors1.tbl in the IDL directory.  This
171 allows multiple IDL users to have their own color table file.
172</div>
173           
174            <h4 id="_xlct_keyword_USE_CURRENT">USE_CURRENT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
175             
176             
177             
178             
179             
180             
181             
182             
183            </h4>
184       
185            <div class="comments">
186 If set, use the current color tables, regardless of
187 the contents of the COMMON block COLORS.
188</div>
189           
190            <h4 id="_xlct_keyword_NCOLORS">NCOLORS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
191             
192             
193             
194             
195             
196             
197              <span class="attr">default:</span> <span class="value">!D.TABLE_SIZE </span>
198             
199            </h4>
200       
201            <div class="comments">
202 number of colors to use. Use color indexes from BOTTOM to the
203 smaller of !D.TABLE_SIZE-1 and NCOLORS-1.
204</div>
205           
206            <h4 id="_xlct_keyword_BOTTOM">BOTTOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
207             
208             
209             
210             
211             
212             
213              <span class="attr">default:</span> <span class="value">0.</span>
214             
215            </h4>
216       
217            <div class="comments">
218 first color index to use. Use color indexes from BOTTOM to
219 BOTTOM+NCOLORS-1.
220</div>
221           
222            <h4 id="_xlct_keyword_MODAL">MODAL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
223             
224             
225             
226             
227             
228             
229              <span class="attr">default:</span> <span class="value">not run in modal mode</span>
230             
231            </h4>
232       
233            <div class="comments">
234 If set, then XLCT runs in "modal" mode, meaning that
235 all other widgets are blocked until the user quits XLCT.
236 A group leader must be specified (via the GROUP keyword)
237 for the MODAL keyword to have any effect.
238</div>
239           
240            <h4 id="_xlct_keyword_BLOCK">BLOCK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
241             
242             
243             
244             
245             
246             
247             
248             
249            </h4>
250       
251            <div class="comments">
252 Set this keyword to have XMANAGER block when this
253 application is registered.  By default the Xmanager
254 keyword NO_BLOCK is set to 1 to provide access to the
255 command line if active command line processing is available.
256 Note that setting BLOCK for this application will cause
257 all widget applications to block, not only this
258 application.  For more information see the NO_BLOCK keyword
259 to XMANAGER.
260</div>
261           
262            <h4 id="_xlct_keyword_UPDATECALLBACK">UPDATECALLBACK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
263             
264             
265             
266             
267             
268             
269             
270             
271            </h4>
272       
273            <div class="comments">
274 Set this keyword to a string containing the name of
275 a user-supplied procedure that will be called when the color
276 table is updated by XLCT.  The procedure may optionally
277 accept a keyword called DATA, which will be automatically
278 set to the value specified by the optional UPDATECBDATA keyword.
279</div>
280           
281            <h4 id="_xlct_keyword_UPDATECBDATA">UPDATECBDATA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
282             
283             
284             
285             
286             
287             
288             
289             
290            </h4>
291       
292            <div class="comments">
293 Set this keyword to a value of any type. It will be
294 passed via the DATA keyword to the user-supplied procedure
295 specified via the UPDATECALLBACK keyword, if any. If the
296 UPDATECBDATA keyword is not set the value accepted by the
297 DATA keyword to the procedure specified by UPDATECALLBACK
298 will be undefined.
299</div>
300           
301         
302
303         
304          <h3>Version history</h3>
305         
306          <h4>Version</h4><div class="preformat">
307 $Id: xlct.pro 327 2007-12-13 16:22:35Z pinsard $
308</div>
309          <h4>History</h4><div class="preformat">
310 5/5/1999 copy of xloadct par Sebastien Masson (smasson@lodyc.jussieu.fr)
311</div>
312         
313         
314         
315         
316         
317         
318         
319       
320          <h3>Other attributes</h3>
321         
322         
323         
324         
325         
326          <h4>Common blocks used</h4><div class="preformat">colors
327xlct_com</div>
328       
329          <h3>Statistics</h3>
330          <table class="statistics">
331            <tr><td>McCabe cyclic</td><td>          16</td></tr>
332            <tr><td>McCabe essential</td><td>           1</td></tr>
333            <tr><td>McCabe modular design</td><td>           1</td></tr>
334          </table>
335         
336       
337        </div>
338       
339      </div>
340
341     
342
343      <div id="tagline">Produced by IDLdoc 2.0.</div>
344
345    </div>
346
347  </body>
348</html>
Note: See TracBrowser for help on using the repository browser.