source: trunk/SRC/Documentation/idldoc_assistant_output/Colors/xpal.html @ 338

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

update documentation
File size: 9.6 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>xpal.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="xlct.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=""><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>xpal.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Choose the best foreground and background colors for
65 the current color maps and set !P appropriately.
66
67
68 Re-draw the RGB plots.
69
70
71 Change current color.
72
73
74 Like <a href="/Applications/itt/idl64/help/online_help/XPALETTE.html">XPALETTE</a> but shorter to write and, moreover,
75 possess a hotkey save which (thanks to the <a href="..//Colors/newpalette.html">newpalette</a> routine)
76 allows to save the routine that we have just done. Comment: when we
77 press the predefined hotkey, it calls <a href="..//Colors/xlct.html">xlct</a> instead of
78 <a href="/Applications/itt/idl64/help/online_help/XLOADCT.html">XLOADCT</a>
79 No explicit inputs.  The current color table is used as a starting point.
80
81
82   
83
84     
85      <a name="#_xpal"></a>
86
87      <h2>xpal  <font size="-1" color="#006633">
88 Color, Widget
89</font></h2>
90
91      <p><font face="Courier">xpal, <a href="#_xpal_keyword_GROUP">GROUP</a>=<i>GROUP</i>, <a href="#_xpal_keyword_BLOCK">BLOCK</a>=<i>BLOCK</i>, <a href="#_xpal_keyword_UPDATECALLBACK">UPDATECALLBACK</a>=<i>UPDATECALLBACK</i>, <a href="#_xpal_keyword_UPDATECBDATA">UPDATECBDATA</a>=<i>UPDATECBDATA</i></font></p>
92
93   
94
95
96   
97
98   
99
100   
101    <h3>Keywords</h3>
102
103   
104    <a name="#_xpal_keyword_GROUP"></a>
105    <h4>GROUP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
106     
107     
108     
109     
110     
111     
112     
113     
114    </h4>
115
116   
117 The widget ID of the widget that calls xpal. When  this ID is
118 specified, a death of the caller results in a death of xpal
119
120   
121    <a name="#_xpal_keyword_BLOCK"></a>
122    <h4>BLOCK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
123     
124     
125     
126     
127     
128     
129      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>1</i></font>
130     
131    </h4>
132
133   
134 Set this keyword to have XMANAGER block when this
135 application is registered.  By default the Xmanager
136 keyword NO_BLOCK is set to 1 to provide access to the
137 command line if active command line processing is available.
138 Note that setting BLOCK for this application will cause
139 all widget applications to block, not only this
140 application.  For more information see the NO_BLOCK keyword
141 to XMANAGER.
142
143   
144    <a name="#_xpal_keyword_UPDATECALLBACK"></a>
145    <h4>UPDATECALLBACK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
146     
147     
148     
149     
150     
151     
152     
153     
154    </h4>
155
156   
157 Set this keyword to a string containing the name of
158 a user-supplied procedure that will be called when the color
159 table is updated by XLOADCT.  The procedure may optionally
160 accept a keyword called DATA, which will be automatically
161 set to the value specified by the optional UPDATECBDATA
162 keyword.
163
164   
165    <a name="#_xpal_keyword_UPDATECBDATA"></a>
166    <h4>UPDATECBDATA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
167     
168     
169     
170     
171     
172     
173     
174     
175    </h4>
176
177   
178 Set this keyword to a value of any type. It will be
179 passed via the DATA keyword to the user-supplied procedure
180 specified via the UPDATECALLBACK keyword, if any. If the
181 UPDATECBDATA keyword is not set the value accepted by the
182 DATA keyword to the procedure specified by UPDATECALLBACK
183 will be undefined.
184
185   
186   
187
188    <h3>Examples</h3><pre>
189 The XPAL widget has the following controls:
190
191       Left:   Three plots showing the current Red, Green, and Blue vectors.
192
193       Center: A status region containing:
194               1) The total number of colors.
195               2) The current color. XPAL allows changing
196                  one color at a time. This color is known as
197                  the "current color" and is indicated in the
198                  color spectrum display with a special marker.
199               3) The current mark index. The mark is used to
200                  remember a color index. It is established by
201                  pressing the "Set Mark Button" while the current
202                  color index is the desired mark index.
203               4) The current color. The special marker used in
204                  color spectrum display prevents the user from seeing
205                  the color of the current index, but it is visible
206                  here.
207
208               A panel of control buttons, which do the following when
209               pressed:
210
211                 Done: Exits XPAL.
212
213           Predefined: Starts XLOADCT to allow selection of one of the
214                       predefined color tables.
215
216                 Help: Supplies help information similar to this header.
217
218               Redraw: Completely redraws the display using the current
219                       state of the color map.
220
221             Set Mark: Set the value of the mark index to the
222                       current index.
223
224          Switch Mark: Exchange the mark and the current index.
225
226         Copy Current: Every color lying between the current
227                       index and the mark index (inclusive) is given
228                       the current color.
229
230          Interpolate: The colors lying between the current
231                       index and the mark index are interpolated linearly
232                       to lie between the colors of two endpoints.
233                 save: Allows to save  the palette which is currently
234                       on the screen. When we press this hotkey, there is a
235                       widget who appear and ask:
236                        1) the name of the palette we want to save.
237                        2) The number of the palette we may want to erase
238                        by the new palette. If there is not any number
239                        specified, the new palette is add to elders.
240                        3) The name of the file containing palettes.
241                        Comment: May follow instructions gave by the prompter.
242
243
244       Three sliders (R, G, and B) that allow the user to modify the
245       current color.
246
247       Right:  A display which shows the current color map as a series of
248               squares. Color index 0 is at the upper left. The color index
249               increases monotonically by rows going left to right and top
250               to bottom.  The current color index is indicated by a special
251               marker symbol. There are 4 ways to change the current color:
252                       1) Press any mouse button while the mouse
253                          pointer is over the color map display.
254                       2) Use the "By Index" slider to move to
255                          the desired color index.
256                       3) Use the "Row" Slider to move the marker
257                          vertically.
258                       4) Use the "Column" Slider to move the marker
259                          horizontally.
260
261    </pre><h3>Version history</h3>
262   
263    <h4>Version</h4>
264 $Id: xpal.pro 325 2007-12-06 10:04:53Z pinsard $
265
266    <h4>History</h4>
267 Adaptation of xpalette to add a save button by
268          Grima Nicolas (nglod@ipsl.jussieu.fr) and by Masson
269          Sebastien (smlod@ipsl.jussieu.fr)
270
271   
272
273    <h3>Known issues</h3>
274   
275   
276   
277    <h4>Restrictions</h4>
278 XPAL uses two colors from the current color table as
279 drawing foreground and background colors. These are used
280 for the RGB plots on the left, and the current index marker on
281 the right. This means that if the user set these two colors
282 to the same value, the XPAL display could become unreadable
283 (like writing on black paper with black ink). XPAL minimizes
284 this possibility by noting changes to the color map and always
285 using the brightest available color for the foreground color
286 and the darkest for the background. Thus, the only way
287 to make XPAL's display unreadable is to set the entire color
288 map to a single color, which is highly unlikely. The only side
289 effect of this policy is that you may notice XPAL redrawing
290 the entire display after you've modified the current color.
291 This simply means that the change has made XPAL pick new
292 drawing colors.
293
294 The new color tables are saved in the COLORS common and loaded
295 to the display.
296
297
298    <h3>Other attributes</h3>
299   
300   
301    <h4>Uses routines</h4>
302 XP_COM Private to this module.
303
304   
305   
306    <h4>Common blocks used</h4>xp_com
307colors
308
309    <font size="-3"><p>&nbsp;</p></font>
310    <hr size="1" color="#CCCCCC"/>
311     
312
313   
314
315    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
316
317  </body>
318</html>
Note: See TracBrowser for help on using the repository browser.