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

Last change on this file since 234 was 234, checked in by pinsard, 17 years ago

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