source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/COULEURS/xlct.html @ 104

Last change on this file since 104 was 104, checked in by pinsard, 18 years ago

start to modify headers of Postscript *.pro files for better idldoc output + change the title of idldoc output in html to SAXO Documentation

File size: 13.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>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?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html?format=raw" 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="palit.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?format=raw" 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?format=raw">ToBeReviewed/COULEURS/</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"></div>
90
91     
92
93     
94
95     
96
97     
98      <div id="routine_summary">               
99        <h2>Routine summary</h2>
100       
101        <dl>
102         
103          <dt><p><a href="#_XLCT_PSAVE">XLCT_PSAVE</a></p><dt>
104          <dd></dd>     
105         
106          <dt><p><a href="#_xlct_alert_caller">xlct_alert_caller</a></p><dt>
107          <dd></dd>     
108         
109          <dt><p><a href="#_xlct_show">xlct_show</a></p><dt>
110          <dd></dd>     
111         
112          <dt><p><a href="#_xlct_draw_cps">xlct_draw_cps<span class="result">, i, c</span></a></p><dt>
113          <dd></dd>     
114         
115          <dt><p><a href="#_xlct_transfer">xlct_transfer, UPDATE=<span class="result">UPDATE</span></a></p><dt>
116          <dd></dd>     
117         
118          <dt><p><a href="#_xlct_event">xlct_event<span class="result">, event</span></a></p><dt>
119          <dd></dd>     
120         
121          <dt><p><a href="#_XLct">XLct, SILENT=<span class="result">SILENT</span>, GROUP=<span class="result">GROUP</span>, FILE=<span class="result">FILE</span>, USE_CURRENT=<span class="result">USE_CURRENT</span>, NCOLORS=<span class="result">NCOLORS</span>, BOTTOM=<span class="result">BOTTOM</span>, MODAL=<span class="result">MODAL</span>, BLOCK=<span class="result">BLOCK</span>, UPDATECALLBACK=<span class="result">UPDATECALLBACK</span>, UPDATECBDATA=<span class="result">UPDATECBDATA</span></a></p><dt>
122          <dd>  NAME:        XLCT  PURPOSE:        comme xloadct mais plus cour a ecrire et appelle par defaut la        palette palette.</dd> 
123               
124        </dl>
125      </div>
126     
127
128      <div id="routine_details">
129       
130
131        <div class="routine_details" id="_XLCT_PSAVE">
132
133          <h2><a class="top" href="#container">top</a>XLCT_PSAVE </h2>
134       
135          <p class="header">
136            XLCT_PSAVE</p>
137       
138          <div class="comments"></div>
139
140         
141
142         
143
144         
145
146         
147         
148         
149         
150         
151         
152         
153         
154         
155         
156         
157         
158       
159          <h3>Other attributes</h3>
160         
161         
162         
163         
164         
165          <h4>Common blocks used</h4><div class="value">xlct_com</div>
166       
167         
168       
169        </div>
170       
171
172        <div class="routine_details" id="_xlct_alert_caller">
173
174          <h2><a class="top" href="#container">top</a>xlct_alert_caller </h2>
175       
176          <p class="header">
177            xlct_alert_caller</p>
178       
179          <div class="comments"></div>
180
181         
182
183         
184
185         
186
187         
188         
189         
190         
191         
192         
193         
194         
195         
196         
197         
198         
199       
200          <h3>Other attributes</h3>
201         
202         
203         
204         
205         
206          <h4>Common blocks used</h4><div class="value">xlct_com</div>
207       
208         
209       
210        </div>
211       
212
213        <div class="routine_details" id="_xlct_show">
214
215          <h2><a class="top" href="#container">top</a>xlct_show </h2>
216       
217          <p class="header">
218            xlct_show</p>
219       
220          <div class="comments"></div>
221
222         
223
224         
225
226         
227
228         
229         
230         
231         
232         
233         
234         
235         
236         
237         
238         
239         
240       
241          <h3>Other attributes</h3>
242         
243         
244         
245         
246         
247          <h4>Common blocks used</h4><div class="value">xlct_com</div>
248       
249         
250       
251        </div>
252       
253
254        <div class="routine_details" id="_xlct_draw_cps">
255
256          <h2><a class="top" href="#container">top</a>xlct_draw_cps </h2>
257       
258          <p class="header">
259            xlct_draw_cps<span class="result">, <a href="#_xlct_draw_cps_param_i">i</a>, <a href="#_xlct_draw_cps_param_c">c</a></span></p>
260       
261          <div class="comments"></div>
262
263         
264
265         
266            <h3>Parameters</h3>
267       
268           
269            <h4 id="_xlct_draw_cps_param_i">i&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
270             
271             
272             
273             
274             
275             
276             
277             
278            </h4>
279       
280          <div class="comments"></div>
281           
282            <h4 id="_xlct_draw_cps_param_c">c&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
283             
284             
285             
286             
287             
288             
289             
290             
291            </h4>
292       
293          <div class="comments"></div>
294           
295
296         
297
298         
299
300         
301         
302         
303         
304         
305         
306         
307         
308         
309         
310         
311         
312       
313          <h3>Other attributes</h3>
314         
315         
316         
317         
318         
319          <h4>Common blocks used</h4><div class="value">colors
320xlct_com</div>
321       
322         
323       
324        </div>
325       
326
327        <div class="routine_details" id="_xlct_transfer">
328
329          <h2><a class="top" href="#container">top</a>xlct_transfer </h2>
330       
331          <p class="header">
332            xlct_transfer, <a href="#_xlct_transfer_keyword_UPDATE">UPDATE</a>=<span class="result">UPDATE</span></p>
333       
334          <div class="comments"></div>
335
336         
337
338         
339
340         
341
342            <h3>Keywords</h3>
343           
344            <h4 id="_xlct_transfer_keyword_UPDATE">UPDATE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
345             
346             
347             
348             
349             
350             
351             
352             
353            </h4>
354       
355            <div class="comments"></div>
356           
357         
358
359         
360         
361         
362         
363         
364         
365         
366         
367         
368         
369         
370         
371       
372          <h3>Other attributes</h3>
373         
374         
375         
376         
377         
378          <h4>Common blocks used</h4><div class="value">colors
379xlct_com</div>
380       
381         
382       
383        </div>
384       
385
386        <div class="routine_details" id="_xlct_event">
387
388          <h2><a class="top" href="#container">top</a>xlct_event </h2>
389       
390          <p class="header">
391            xlct_event<span class="result">, <a href="#_xlct_event_param_event">event</a></span></p>
392       
393          <div class="comments"></div>
394
395         
396
397         
398            <h3>Parameters</h3>
399       
400           
401            <h4 id="_xlct_event_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
402             
403             
404             
405             
406             
407             
408             
409             
410            </h4>
411       
412          <div class="comments"></div>
413           
414
415         
416
417         
418
419         
420         
421         
422         
423         
424         
425         
426         
427         
428         
429         
430         
431       
432          <h3>Other attributes</h3>
433         
434         
435         
436         
437         
438          <h4>Common blocks used</h4><div class="value">colors
439xlct_com</div>
440       
441         
442       
443        </div>
444       
445
446        <div class="routine_details" id="_XLct">
447
448          <h2><a class="top" href="#container">top</a>XLct </h2>
449       
450          <p class="header">
451            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>
452       
453          <div class="comments">
454 NAME:
455       XLCT
456 PURPOSE:
457       comme xloadct mais plus cour a ecrire et appelle par defaut la
458       palette palette.tbl qui peut etre situee dans n''importe quel
459       repertoire de !path.
460
461 CATEGORY:
462       Widgets
463 CALLING SEQUENCE:
464       XLCT
465 INPUTS:
466       None.
467 KEYWORDS:
468        FILE:   If this keyword is set, the file by the given name is used
469                instead of the file colors1.tbl in the IDL directory.  This
470                allows multiple IDL users to have their own color table file.
471       GROUP = The widget ID of the widget that calls Xlct.  When
472               this ID is specified, a death of the caller results in a
473               death of Xlct
474        NCOLORS = number of colors to use.  Use color indices from BOTTOM
475                to the smaller of !D.TABLE_SIZE-1 and NCOLORS-1.
476                Default = !D.TABLE_SIZE = all available colors.
477        BOTTOM = first color index to use. Use color indices from BOTTOM to
478                BOTTOM+NCOLORS-1.  Default = 0.
479       SILENT - Normally, no informational message is printed when
480               a color map is loaded. If this keyword is present and
481               zero, this message is printed.
482        USE_CURRENT: If set, use the current color tables, regardless of
483                the contents of the COMMON block COLORS.
484       MODAL:  If set, then XLCT runs in "modal" mode, meaning that
485               all other widgets are blocked until the user quits XLCT.
486               A group leader must be specified (via the GROUP keyword)
487               for the MODAL keyword to have any effect.   The default
488               is to not run in modal mode.
489        BLOCK:  Set this keyword to have XMANAGER block when this
490                application is registered.  By default the Xmanager
491               keyword NO_BLOCK is set to 1 to provide access to the
492               command line if active command   line processing is available.
493               Note that setting BLOCK for this application will cause
494                all widget applications to block, not only this
495                application.  For more information see the NO_BLOCK keyword
496                to XMANAGER.
497       UPDATECALLBACK: Set this keyword to a string containing the name of
498               a user-supplied procedure that will be called when the color
499               table is updated by XLCT.  The procedure may optionally
500               accept a keyword called DATA, which will be automatically
501               set to the value specified by the optional UPDATECBDATA
502               keyword.
503       UPDATECBDATA: Set this keyword to a value of any type. It will be
504               passed via the DATA keyword to the user-supplied procedure
505               specified via the UPDATECALLBACK keyword, if any. If the
506               UPDATECBDATA keyword is not set the value accepted by the
507               DATA keyword to the procedure specified by UPDATECALLBACK
508               will be undefined.
509
510 OUTPUTS:
511       None.
512 COMMON BLOCKS:
513       None.
514 SIDE EFFECTS:
515       One of the predefined color maps may be loaded.
516 RESTRICTIONS:
517       This routine uses the LOADCT user library procedure to
518       do the actual work.
519 MODIFICATION HISTORY:</div>
520
521         
522
523         
524
525         
526
527            <h3>Keywords</h3>
528           
529            <h4 id="_XLct_keyword_SILENT">SILENT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
530             
531             
532             
533             
534             
535             
536             
537             
538            </h4>
539       
540            <div class="comments"></div>
541           
542            <h4 id="_XLct_keyword_GROUP">GROUP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
543             
544             
545             
546             
547             
548             
549             
550             
551            </h4>
552       
553            <div class="comments"></div>
554           
555            <h4 id="_XLct_keyword_FILE">FILE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
556             
557             
558             
559             
560             
561             
562             
563             
564            </h4>
565       
566            <div class="comments"></div>
567           
568            <h4 id="_XLct_keyword_USE_CURRENT">USE_CURRENT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
569             
570             
571             
572             
573             
574             
575             
576             
577            </h4>
578       
579            <div class="comments"></div>
580           
581            <h4 id="_XLct_keyword_NCOLORS">NCOLORS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
582             
583             
584             
585             
586             
587             
588             
589             
590            </h4>
591       
592            <div class="comments"></div>
593           
594            <h4 id="_XLct_keyword_BOTTOM">BOTTOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
595             
596             
597             
598             
599             
600             
601             
602             
603            </h4>
604       
605            <div class="comments"></div>
606           
607            <h4 id="_XLct_keyword_MODAL">MODAL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
608             
609             
610             
611             
612             
613             
614             
615             
616            </h4>
617       
618            <div class="comments"></div>
619           
620            <h4 id="_XLct_keyword_BLOCK">BLOCK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
621             
622             
623             
624             
625             
626             
627             
628             
629            </h4>
630       
631            <div class="comments"></div>
632           
633            <h4 id="_XLct_keyword_UPDATECALLBACK">UPDATECALLBACK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
634             
635             
636             
637             
638             
639             
640             
641             
642            </h4>
643       
644            <div class="comments"></div>
645           
646            <h4 id="_XLct_keyword_UPDATECBDATA">UPDATECBDATA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
647             
648             
649             
650             
651             
652             
653             
654             
655            </h4>
656       
657            <div class="comments"></div>
658           
659         
660
661         
662         
663         
664         
665         
666         
667         
668         
669         
670         
671         
672         
673       
674          <h3>Other attributes</h3>
675         
676         
677         
678         
679         
680          <h4>Common blocks used</h4><div class="value">colors
681xlct_com</div>
682       
683         
684       
685        </div>
686       
687      </div>
688
689     
690
691      <div id="tagline">Produced by IDLdoc 2.0.</div>
692
693    </div>
694
695  </body>
696</html>
Note: See TracBrowser for help on using the repository browser.