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