source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/COULEURS/xpal.html @ 89

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

add idldoc html output. see Documentation/idldoc_html_output/index.html
File size: 17.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>xpal.pro (IDLdoc API 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="xpal.pro (IDLdoc API documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>IDLdoc API 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="xlct.html">&lt;&lt;prev file</a> | next file &gt;&gt;&nbsp;&nbsp;&nbsp;&nbsp;<a href="xpal.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">xpal.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="#_XP_NEW_COLORS"><span class="result">result = </span>XP_NEW_COLORS()</a></p><dt>
104          <dd>  NAME:        XPAL   PURPOSE:        comme xpalette mais plus court a ecrire et possede en plus        une touche save qui (grace a la routine newpalette) permet de        sauver la routine que l''on vient de faire.</dd>     
105         
106          <dt><p><a href="#_XP_ALERT_CALLER">XP_ALERT_CALLER</a></p><dt>
107          <dd></dd>     
108         
109          <dt><p><a href="#_XP_XLCTCALLBACK">XP_XLCTCALLBACK</a></p><dt>
110          <dd></dd>     
111         
112          <dt><p><a href="#_XP_REDRAW">XP_REDRAW</a></p><dt>
113          <dd></dd>     
114         
115          <dt><p><a href="#_XP_REPLOT">XP_REPLOT<span class="result">, color_index, type</span></a></p><dt>
116          <dd></dd>     
117         
118          <dt><p><a href="#_XP_CHANGE_COLOR">XP_CHANGE_COLOR<span class="result">, type, value</span></a></p><dt>
119          <dd></dd>     
120         
121          <dt><p><a href="#_XP_BUTTON_EVENT">XP_BUTTON_EVENT<span class="result">, event</span></a></p><dt>
122          <dd></dd>     
123         
124          <dt><p><a href="#_xp_button_event_event">xp_button_event_event<span class="result">, ev</span></a></p><dt>
125          <dd></dd>     
126         
127          <dt><p><a href="#_XP_EVENT">XP_EVENT<span class="result">, event</span></a></p><dt>
128          <dd></dd>     
129         
130          <dt><p><a href="#_XPAL">XPAL, group=<span class="result">group</span>, BLOCK=<span class="result">BLOCK</span>, UPDATECALLBACK=<span class="result">UPDATECALLBACK</span>, UPDATECBDATA=<span class="result">UPDATECBDATA</span></a></p><dt>
131          <dd></dd>     
132               
133        </dl>
134      </div>
135     
136
137      <div id="routine_details">
138       
139
140        <div class="routine_details" id="_XP_NEW_COLORS">
141
142          <h2><a class="top" href="#container">top</a>XP_NEW_COLORS </h2>
143       
144          <p class="header">
145            <span class="result">result = </span>XP_NEW_COLORS()</p>
146       
147          <div class="comments">
148 NAME:
149       XPAL
150
151 PURPOSE:
152       comme xpalette mais plus court a ecrire et possede en plus
153       une touche save qui (grace a la routine newpalette) permet de
154       sauver la routine que l''on vient de faire. Rq qd on appuie
155       sur la touche predefined appelle xlct plutot que xloadct
156
157 CATEGORY:
158       Color tables, widgets.
159
160 CALLING SEQUENCE:
161       XPAL
162
163 INPUTS:
164       No explicit inputs.  The current color table is used as a starting
165       point.
166
167 KEYWORD PARAMETERS:
168        BLOCK:  Set this keyword to have XMANAGER block when this
169                application is registered.  By default the Xmanager
170               keyword NO_BLOCK is set to 1 to provide access to the
171               command line if active command   line processing is available.
172               Note that setting BLOCK for this application will cause
173                all widget applications to block, not only this
174                application.  For more information see the NO_BLOCK keyword
175                to XMANAGER.
176       UPDATECALLBACK: Set this keyword to a string containing the name of
177               a user-supplied procedure that will be called when the color
178               table is updated by XLOADCT.  The procedure may optionally
179               accept a keyword called DATA, which will be automatically
180               set to the value specified by the optional UPDATECBDATA
181               keyword.
182       UPDATECBDATA: Set this keyword to a value of any type. It will be
183               passed via the DATA keyword to the user-supplied procedure
184               specified via the UPDATECALLBACK keyword, if any. If the
185               UPDATECBDATA keyword is not set the value accepted by the
186               DATA keyword to the procedure specified by UPDATECALLBACK
187               will be undefined.
188
189 OUTPUTS:
190       None.
191
192 COMMON BLOCKS:
193       COLORS: Contains the current RGB color tables.
194       XP_COM: Private to this module.
195
196 SIDE EFFECTS:
197       XPAL uses two colors from the current color table as
198       drawing foreground and background colors. These are used
199       for the RGB plots on the left, and the current index marker on
200       the right. This means that if the user set these two colors
201       to the same value, the XPAL display could become unreadable
202       (like writing on black paper with black ink). XPAL minimizes
203       this possibility by noting changes to the color map and always
204       using the brightest available color for the foreground color
205       and the darkest for the background. Thus, the only way
206       to make XPAL's display unreadable is to set the entire color
207       map to a single color, which is highly unlikely. The only side
208       effect of this policy is that you may notice XPAL redrawing
209       the entire display after you've modified the current color.
210       This simply means that the change has made XPAL pick new
211       drawing colors.
212
213       The new color tables are saved in the COLORS common and loaded
214       to the display.
215
216 PROCEDURE:
217       The XPAL widget has the following controls:
218
219       Left:   Three plots showing the current Red, Green, and Blue vectors.
220
221       Center: A status region containing:
222               1) The total number of colors.
223               2) The current color. XPAL allows changing
224                  one color at a time. This color is known as
225                  the "current color" and is indicated in the
226                  color spectrum display with a special marker.
227               3) The current mark index. The mark is used to
228                  remember a color index. It is established by
229                  pressing the "Set Mark Button" while the current
230                  color index is the desired mark index.
231               4) The current color. The special marker used in
232                  color spectrum display prevents the user from seeing
233                  the color of the current index, but it is visible
234                  here.
235
236               A panel of control buttons, which do the following when
237               pressed:
238
239               Done:   Exits XPAL.
240
241         Predefined:   Starts XLOADCT to allow selection of one of the
242                       predefined color tables.
243
244               Help:   Supplies help information similar to this header.
245
246               Redraw: Completely redraws the display using the current
247                       state of the color map.
248
249             Set Mark: Set the value of the mark index to the
250                       current index.
251
252          Switch Mark: Exchange the mark and the current index.
253
254         Copy Current: Every color lying between the current
255                       index and the mark index (inclusive) is given
256                       the current color.
257
258          Interpolate: The colors lying between the current
259                       index and the mark index are interpolated linearly
260                       to lie between the colors of two endpoints.
261                 save: permet de sauver la palette qui est
262                       actuellement a l''ecran. Qd on appuie sur ce
263                       bouton, un widget apparait qui demande:
264                        1) le nom a donner a la palette que l''on veut sauver
265                        2) le numero de la palette que l''on veut
266                        eventuellement ecrase par la nouvelle
267                        palette.Si aucun numero n''est specifie la
268                        nouvelle palette estajoutee aux anciennes.
269                        3) le nom du fichier qui contient les
270                        palettes. Rq: suivre eventuellement les
271                        indications fournis au prompteur.
272               
273
274       Three sliders (R, G, and B) that allow the user to modify the
275       current color.
276
277       Right:  A display which shows the current color map as a series of
278               squares. Color index 0 is at the upper left. The color index
279               increases monotonically by rows going left to right and top
280               to bottom.  The current color index is indicated by a special
281               marker symbol. There are 4 ways to change the current color:
282                       1) Press any mouse button while the mouse
283                          pointer is over the color map display.
284                       2) Use the "By Index" slider to move to
285                          the desired color index.
286                       3) Use the "Row" Slider to move the marker
287                          vertically.
288                       4) Use the "Column" Slider to move the marker
289                          horizontally.
290
291 MODIFICATION HISTORY:
292          addaptation de xpalette pour ajouter un bouton save par</div>
293
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">xp_com</div>
320       
321         
322       
323        </div>
324       
325
326        <div class="routine_details" id="_XP_ALERT_CALLER">
327
328          <h2><a class="top" href="#container">top</a>XP_ALERT_CALLER </h2>
329       
330          <p class="header">
331            XP_ALERT_CALLER</p>
332       
333          <div class="comments"></div>
334
335         
336
337         
338
339         
340
341         
342         
343         
344         
345         
346         
347         
348         
349         
350         
351         
352         
353       
354          <h3>Other attributes</h3>
355         
356         
357         
358         
359         
360          <h4>Common blocks used</h4><div class="value">xp_com</div>
361       
362         
363       
364        </div>
365       
366
367        <div class="routine_details" id="_XP_XLCTCALLBACK">
368
369          <h2><a class="top" href="#container">top</a>XP_XLCTCALLBACK </h2>
370       
371          <p class="header">
372            XP_XLCTCALLBACK</p>
373       
374          <div class="comments"></div>
375
376         
377
378         
379
380         
381
382         
383         
384         
385         
386         
387         
388         
389         
390         
391         
392         
393         
394       
395         
396         
397         
398         
399         
400         
401         
402       
403         
404       
405        </div>
406       
407
408        <div class="routine_details" id="_XP_REDRAW">
409
410          <h2><a class="top" href="#container">top</a>XP_REDRAW </h2>
411       
412          <p class="header">
413            XP_REDRAW</p>
414       
415          <div class="comments"></div>
416
417         
418
419         
420
421         
422
423         
424         
425         
426         
427         
428         
429         
430         
431         
432         
433         
434         
435       
436          <h3>Other attributes</h3>
437         
438         
439         
440         
441         
442          <h4>Common blocks used</h4><div class="value">xp_com</div>
443       
444         
445       
446        </div>
447       
448
449        <div class="routine_details" id="_XP_REPLOT">
450
451          <h2><a class="top" href="#container">top</a>XP_REPLOT </h2>
452       
453          <p class="header">
454            XP_REPLOT<span class="result">, <a href="#_XP_REPLOT_param_color_index">color_index</a>, <a href="#_XP_REPLOT_param_type">type</a></span></p>
455       
456          <div class="comments"></div>
457
458         
459
460         
461            <h3>Parameters</h3>
462       
463           
464            <h4 id="_XP_REPLOT_param_color_index">color_index&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
465             
466             
467             
468             
469             
470             
471             
472             
473            </h4>
474       
475          <div class="comments"></div>
476           
477            <h4 id="_XP_REPLOT_param_type">type&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
478             
479             
480             
481             
482             
483             
484             
485             
486            </h4>
487       
488          <div class="comments"></div>
489           
490
491         
492
493         
494
495         
496         
497         
498         
499         
500         
501         
502         
503         
504         
505         
506         
507       
508          <h3>Other attributes</h3>
509         
510         
511         
512         
513         
514          <h4>Common blocks used</h4><div class="value">xp_com
515colors
516pscale</div>
517       
518         
519       
520        </div>
521       
522
523        <div class="routine_details" id="_XP_CHANGE_COLOR">
524
525          <h2><a class="top" href="#container">top</a>XP_CHANGE_COLOR </h2>
526       
527          <p class="header">
528            XP_CHANGE_COLOR<span class="result">, <a href="#_XP_CHANGE_COLOR_param_type">type</a>, <a href="#_XP_CHANGE_COLOR_param_value">value</a></span></p>
529       
530          <div class="comments"></div>
531
532         
533
534         
535            <h3>Parameters</h3>
536       
537           
538            <h4 id="_XP_CHANGE_COLOR_param_type">type&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
539             
540             
541             
542             
543             
544             
545             
546             
547            </h4>
548       
549          <div class="comments"></div>
550           
551            <h4 id="_XP_CHANGE_COLOR_param_value">value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
552             
553             
554             
555             
556             
557             
558             
559             
560            </h4>
561       
562          <div class="comments"></div>
563           
564
565         
566
567         
568
569         
570         
571         
572         
573         
574         
575         
576         
577         
578         
579         
580         
581       
582          <h3>Other attributes</h3>
583         
584         
585         
586         
587         
588          <h4>Common blocks used</h4><div class="value">xp_com
589colors</div>
590       
591         
592       
593        </div>
594       
595
596        <div class="routine_details" id="_XP_BUTTON_EVENT">
597
598          <h2><a class="top" href="#container">top</a>XP_BUTTON_EVENT </h2>
599       
600          <p class="header">
601            XP_BUTTON_EVENT<span class="result">, <a href="#_XP_BUTTON_EVENT_param_event">event</a></span></p>
602       
603          <div class="comments"></div>
604
605         
606
607         
608            <h3>Parameters</h3>
609       
610           
611            <h4 id="_XP_BUTTON_EVENT_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
612             
613             
614             
615             
616             
617             
618             
619             
620            </h4>
621       
622          <div class="comments"></div>
623           
624
625         
626
627         
628
629         
630         
631         
632         
633         
634         
635         
636         
637         
638         
639         
640         
641       
642          <h3>Other attributes</h3>
643         
644         
645         
646         
647         
648          <h4>Common blocks used</h4><div class="value">xp_com
649colors
650basecommon</div>
651       
652         
653       
654        </div>
655       
656
657        <div class="routine_details" id="_xp_button_event_event">
658
659          <h2><a class="top" href="#container">top</a>xp_button_event_event </h2>
660       
661          <p class="header">
662            xp_button_event_event<span class="result">, <a href="#_xp_button_event_event_param_ev">ev</a></span></p>
663       
664          <div class="comments"></div>
665
666         
667
668         
669            <h3>Parameters</h3>
670       
671           
672            <h4 id="_xp_button_event_event_param_ev">ev&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
673             
674             
675             
676             
677             
678             
679             
680             
681            </h4>
682       
683          <div class="comments"></div>
684           
685
686         
687
688         
689
690         
691         
692         
693         
694         
695         
696         
697         
698         
699         
700         
701         
702       
703          <h3>Other attributes</h3>
704         
705         
706         
707         
708         
709          <h4>Common blocks used</h4><div class="value">basecommon</div>
710       
711         
712       
713        </div>
714       
715
716        <div class="routine_details" id="_XP_EVENT">
717
718          <h2><a class="top" href="#container">top</a>XP_EVENT </h2>
719       
720          <p class="header">
721            XP_EVENT<span class="result">, <a href="#_XP_EVENT_param_event">event</a></span></p>
722       
723          <div class="comments"></div>
724
725         
726
727         
728            <h3>Parameters</h3>
729       
730           
731            <h4 id="_XP_EVENT_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
732             
733             
734             
735             
736             
737             
738             
739             
740            </h4>
741       
742          <div class="comments"></div>
743           
744
745         
746
747         
748
749         
750         
751         
752         
753         
754         
755         
756         
757         
758         
759         
760         
761       
762          <h3>Other attributes</h3>
763         
764         
765         
766         
767         
768          <h4>Common blocks used</h4><div class="value">xp_com
769colors</div>
770       
771         
772       
773        </div>
774       
775
776        <div class="routine_details" id="_XPAL">
777
778          <h2><a class="top" href="#container">top</a>XPAL </h2>
779       
780          <p class="header">
781            XPAL, <a href="#_XPAL_keyword_group">group</a>=<span class="result">group</span>, <a href="#_XPAL_keyword_BLOCK">BLOCK</a>=<span class="result">BLOCK</span>, <a href="#_XPAL_keyword_UPDATECALLBACK">UPDATECALLBACK</a>=<span class="result">UPDATECALLBACK</span>, <a href="#_XPAL_keyword_UPDATECBDATA">UPDATECBDATA</a>=<span class="result">UPDATECBDATA</span></p>
782       
783          <div class="comments"></div>
784
785         
786
787         
788
789         
790
791            <h3>Keywords</h3>
792           
793            <h4 id="_XPAL_keyword_group">group&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
794             
795             
796             
797             
798             
799             
800             
801             
802            </h4>
803       
804            <div class="comments"></div>
805           
806            <h4 id="_XPAL_keyword_BLOCK">BLOCK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
807             
808             
809             
810             
811             
812             
813             
814             
815            </h4>
816       
817            <div class="comments"></div>
818           
819            <h4 id="_XPAL_keyword_UPDATECALLBACK">UPDATECALLBACK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
820             
821             
822             
823             
824             
825             
826             
827             
828            </h4>
829       
830            <div class="comments"></div>
831           
832            <h4 id="_XPAL_keyword_UPDATECBDATA">UPDATECBDATA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
833             
834             
835             
836             
837             
838             
839             
840             
841            </h4>
842       
843            <div class="comments"></div>
844           
845         
846
847         
848         
849         
850         
851         
852         
853         
854         
855         
856         
857         
858         
859       
860          <h3>Other attributes</h3>
861         
862         
863         
864         
865         
866          <h4>Common blocks used</h4><div class="value">xp_com
867colors</div>
868       
869         
870       
871        </div>
872       
873      </div>
874
875     
876
877      <div id="tagline">Produced by IDLdoc 2.0.</div>
878
879    </div>
880
881  </body>
882</html>
Note: See TracBrowser for help on using the repository browser.