Context Navigation

source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/COULEURS/getcolor.html @ 109

Last change on this file since 109 was 109, checked in by pinsard, 18 years ago
modification of savesaxo.sh to fix ticket 17
File size: 23.1 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>getcolor.pro (SAXO Documentation)</title>
10
11
12	<style type="text/css" media="all">
13
14	/* CSS for all files which appear in the "main" viewing area: overview,
15	directory overviews, warnings, index, search, pro files, source
16	code, help, and etc files. */
17
18	/* Link styles --------------------------------------------------------------- */
19
20	a { text-decoration: none; }
21
22	a:link, a:visited {
23	color: #660000;
24	border-bottom: 1px dotted #C0C0F0;
25	}
26
27	a:hover, a:focus {
28	color: #993333;
29	background: #FFFFCC;
30	border-bottom: 1px dotted #303099;
31	}
32
33
34	/* Main styles --------------------------------------------------------------- */
35
36	body {
37	margin: 0;
38	padding: 0;
39	font-size: 10pt;
40	font-family: Verdana, Helvetica, Arial, sans-serif;
41	background-color: #FFFFFF;
42	}
43
44	p {
45	margin-top: 0.5em;
46	margin-bottom: 0;
47	}
48
49	#container { margin: 1em; }
50
51	code.section { white-space: pre; }
52
53	pre.snippet {
54	margin-left: 5%;
55	background: #F0F0F0;
56	border: 1px dashed #999999;
57	width: 43em;
58	padding: 0.5em 0.5em 0.5em 0.5em;
59	white-space: pre;
60	}
61
62	/* Navbar styles ------------------------------------------------------------- */
63
64	#navbar_title {
65	color: #000033;
66	background-color: #F0F0FF;
67	font-family: Arial, Helvetica, sans-serif;
68	padding: 20px 30px;
69	border-bottom: 1px solid #000033;
70	}
71
72	#navbar_title * {
73	margin: 0;
74	padding: 0;
75	}
76
77	#navbar_title h1 {
78	letter-spacing: 0.1em;
79	font-variant: small-caps;
80	font-size: 250%;
81	text-indent: -1em;
82	padding-left: 1em;
83	}
84
85	#navbar_title h2 {
86	font-size: 110%;
87	font-weight: normal;
88	color: #333399;
89	}
90
91	#main_navbar table {
92	width: 100%;
93	border-bottom: 1px solid #666699;
94	}
95
96	#main_navbar td {
97	background: #CCCCFF;
98	font-size: 80%;
99	font-weight: bold;
100	font-family: Arial, Helvetica, sans-serif;
101	border-top: 3px solid #CCCCFF;
102	border-bottom: 3px solid #CCCCFF;
103	padding-left: 6px;
104	padding-right: 6px;
105	margin: 0;
106	}
107
108	#main_navbar td#selected {
109	background: #CCCCFF;
110	font-size: 80%;
111	font-weight: bold;
112	font-family: Arial, Helvetica, sans-serif;
113	border-top: 3px solid #333399;
114	border-bottom: 3px solid #CCCCFF;
115	padding-left: 6px;
116	padding-right: 6px;
117	margin: 0;
118	}
119
120	#main_navbar td#flexible {
121	width: 100%;
122	text-align: right;
123	padding-right: 1em;
124	background: #CCCCFF;
125	font-size: 70%;
126	font-weight: normal;
127	font-family: Arial, Helvetica, sans-serif;
128	text-transform: uppercase;
129	border-top: 3px solid #CCCCFF;
130	border-bottom: 3px solid #CCCCFF;
131	}
132
133	#main_navbar a:link, #main_navbar a:visited { color: #660000; border: 0; }
134
135	#main_navbar a:hover, #main_navbar a:focus {
136	color: #FFFF66;
137	background: #CCCCFF;
138	border-bottom: 1px none #606099;
139	border: 0;
140	}
141
142	#secondary_navbar {
143	font-size: 80%;
144	font-weight: normal;
145	font-family: Arial, Helvetica, sans-serif;
146	margin-top: 4px;
147	margin-left: 20px;
148	white-space: nowrap;
149	}
150
151
152	/* Tagline and footer styles ------------------------------------------------- */
153
154	div#tagline {
155	margin-top: 6px;
156	border-top: 1px dotted lightsteelblue;
157	padding-top: 6px;
158	font-size: 66%;
159	font-style: italic;
160	}
161
162	div#footer {
163	margin-top: 6px;
164	border-top: 1px dotted lightsteelblue;
165	padding-top: 6px;
166	font-size: 66%;
167	font-style: italic;
168	}
169
170	/* Basic data presenation styles -------------------------------------------- */
171
172	.index_letter {
173	font-size: 300%;
174	font-weight: bold;
175	color: #000066;
176	margin: 0.5em 0 0 -0.1em;
177	}
178
179	h1, h2, h3, h4 {
180	font-weight: normal;
181	color: #3333CC;
182	}
183
184	h1 {
185	padding-top: 0.75em;
186	font-size: 160%;
187	}
188
189	h2 {
190	padding-top: 1em;
191	font-size: 120%;
192	}
193
194	h3 {
195	padding-top: 0.75em;
196	margin-bottom: 0.25em;
197	font-size: 100%;
198	}
199
200	h4 {
201	padding: 0;
202	margin: 0.5em 0 0 0;
203	font-size: 80%;
204	}
205
206	table.basic {
207	empty-cells: show;
208	margin: 1.5em 1em 0 1em;
209	border: 1px dotted #CFCFFF;
210	font-size: 80%;
211	}
212
213	table.basic th {
214	background-color: #F0F0FF;
215	font-weight: bold;
216	text-align: left;
217	padding: 4px 1em 4px 4px;
218	border-bottom: 1px dotted #666699;
219	}
220
221	table.basic td {
222	vertical-align: top;
223	padding: 4px 1em 4px 4px;
224	}
225
226	dd {
227	margin-bottom: 0.25em;
228	font-size: 80%;
229	}
230
231
232	/* Warnings styles ----------------------------------------------------------- */
233
234
235	#todo dl, #bugs dl {
236	margin: 0 0 0 1.5em;
237	font-size: 80%;
238	}
239
240	#todo dd, #bugs dd {
241	margin-left: 3em;
242	font-size: 100%;
243	}
244
245	#undoc table, #obsolete table, #statistics table {
246	width: 80%;
247	margin-left: 2em;
248	}
249
250	#undoc td, #obsolete td, #statistics td {
251	padding: 0 0 0 0;
252	font-size: 80%;
253	white-space: nowrap;
254	}
255
256	#undoc td.docroutine, #obsolete td.obsroutine, #statistics td.statroutine { width: 50%; }
257
258	#undoc td.docstat, #statistics td.stat {
259	width: 50%;
260	text-align: right;
261	}
262
263	#undoc td.partialdoc, #statistics td.caution { color: #CC6600; }
264
265	#undoc td.notdoc, #statistics td.warning { color: #993333; }
266
267	/* File + routine styles ----------------------------------------------------- */
268
269	h1.directory {
270	padding: 1em 0 0 0;
271	margin: 0;
272	font-size: 66%;
273	}
274
275	h1.directory a { border-bottom: 0; }
276
277	h2.pro_file {
278	padding: 0;
279	margin: 0;
280	font-size: 140%;
281	}
282
283	div#file_attr {
284	padding: 0 1em 0 1em;
285	margin: 1em;
286	background: #F6F6F6;
287	border: 1px dotted #999999;
288	}
289
290	div#file_attr dt {
291	font-size: 80%;
292	font-weight: bold;
293	}
294
295	div#file_attr dd {
296	font-size: 80%;
297	}
298
299	div#class_diagram {
300	padding: 1em 0 1em 0;
301	white-space: pre;
302	font-family: 'Courier New';
303	}
304
305	table#sav_attr {
306	font-size: 90%;
307	margin: 1em;
308	padding: 1em 1em 1em 1em;
309	background: #F6F6F6;
310	border: 1px dotted #999999;
311	}
312
313	table#sav_attr th { text-align: left; }
314
315	table#sav_attr td { vertical-align: top; padding-right: 2em; }
316
317	table#sav_attr td.value { width: 20em; padding-right: 0em; font-style: italic; }
318
319	p.sav_warning { margin-left: 4em; font-family: 80%; }
320
321	table.variables {
322	font-family: 'Courier New', monospace;
323	font-size: 80%;
324	text-indent: -2em;
325	padding-left: 2em;
326	}
327
328	table.variables td.image { width: 64px; }
329
330	div#file_comments {
331	margin: 2em;
332	font-size: 80%;
333	}
334
335
336	div.field_summary {
337	padding: 0 1em 0 1em;
338	margin: 1em;
339	background: #FFFFF0;
340	border: 1px dotted #C0C000;
341	}
342
343	div#routine_summary {
344	padding: 0 1em 0 1em;
345	margin: 1em;
346	background: #F0F0FF;
347	border: 1px dotted #9999FF;
348	}
349
350	div.field_summary h2, div#routine_summary h2 {
351	padding: 0.5em 0 0 0;
352	margin: 0;
353	}
354
355	div.field_summary table, div.field_summary p {
356	margin: 1em 1em;
357	}
358
359	div.field_summary td.name {
360	vertical-align: top;
361	padding-bottom: 0.25em;
362	color: #3333CC;
363	}
364
365	div.field_summary span.field_type {
366	font-weight: normal;
367	font-size: 80%;
368	color: black;
369	}
370
371	div.field_summary td.comments {
372	vertical-align: top;
373	padding-left: 2em;
374	font-size: 80%;
375	}
376
377	p.commaList {
378	margin: 1em 1em 1em 1em;
379	}
380
381	span.warning {
382	color: #CC6633;
383	font-weight: bold;
384	font-size: 66%;
385	text-transform: uppercase;
386	}
387
388	span.categories {
389	color: #006633;
390	font-weight: bold;
391	font-size: 66%;
392	text-transform: uppercase;
393	}
394
395	span.undoc {
396	color: #FF6633;
397	font-weight: bold;
398	font-size: 80%;
399	text-transform: uppercase;
400	}
401
402	span.attr {
403	color: #006633;
404	font-weight: bold;
405	font-size: 80%;
406	text-transform: uppercase;
407	}
408
409	span.value {
410	color: #006633;
411	font-weight: normal;
412	text-transform: none;
413	}
414
415	a.top {
416	font-weight: bold;
417	font-size: 66%;
418	text-transform: uppercase;
419	float: right;
420	}
421
422	span.result {
423	font-family: Verdana, Arial, Helvetica, sans-serif;
424	font-style: italic;
425	font-size: 80%;
426	}
427
428	div#routine_summary p, div.routine_details p.header {
429	padding-top: 0.5em;
430	margin-left: 1.5em;
431	text-indent: -1.5em;
432	font-family: 'Courier New', monospace;
433	}
434
435	div.routine_details {
436	padding: 0.5em 1em 0.5em 1em;
437	margin: 1em;
438	border: 1px dotted #CCCCCC;
439	}
440
441	div.routine_details h2 {
442	padding-top: 0;
443	margin-top: 0;
444	}
445
446	div.routine_details div.value {
447	margin: 0 1em 0 1em;
448	font-size: 80%;
449	}
450
451	div.routine_details div.comments {
452	font-size: 80%;
453	margin: 0.75em 1em 1em 1em;
454	}
455
456	div.routine_details div.preformat {
457	white-space: pre;
458	}
459
460	table.statistics {
461	font-size: 80%;
462	margin-left: 1em;
463	}
464
465	table.statistics td {
466	padding: 0 2em 0 0;
467	}
468
469	/* Overview styles ----------------------------------------------------------- */
470
471	div.overview {
472	width: 100%;
473	margin-top: 1em;
474	clear: both;
475	}
476
477	div.overview table {
478	empty-cells: show;
479	font-size: 90%;
480	margin: 1em 1em 1em 1em;
481	padding: 1em 0.5em 1em 0.5em;
482	background: #F6F6F6;
483	border: 1px dotted #999999;
484	}
485
486	div.overview td {
487	padding: 3px 1em 3px 1em;
488	}
489
490	div.overview td.dir {
491	width: 1%;
492	vertical-align: top;
493	text-align: right;
494	padding-right: 1em;
495	}
496
497
498	/* Navigation list styles for tree structures -------------------------------- */
499
500	#tree {
501	text-align: left;
502	font-size: 90%;
503	margin: 0.75em 0 0.75em 0;
504	padding: 0;
505	}
506
507	#tree ul {
508	text-align: left;
509	margin: 0;
510	padding: 0;
511	}
512
513	#tree li {
514	margin: 0 0 0 15px;
515	padding: 0;
516	list-style-type: none;
517	}
518
519	#tree .symbols {
520	float: left;
521	width: 12px;
522	height: 1em;
523	padding-left: 4px;
524	background-position: 0 100%;
525	background-repeat: no-repeat;
526	}
527
528	/* Search styles ------------------------------------------------------------- */
529
530	input.writein {
531	padding-left: 0.5em;
532	border: 1px solid #CCCCCC;
533	font-family: 'Courier New';
534	background: #FFFFF3;
535	}
536
537	#search form {
538	margin-left: 2em;
539	}
540
541	#search table {
542	margin: 1em 1em 0 2em;
543	padding: 1em 2em 1em 2em;
544	background: #F6F6F6;
545	border: 1px dotted #999999;
546	}
547
548	#search tr {
549	text-align: center;
550	}
551
552	#search td {
553	font-size: 80%;
554	text-align: left;
555	}
556
557	#search td * {
558	vertical-align: middle;
559	}
560
561	#search p {
562	font-size: 66%;
563	margin: 0 3em 2em 3em;
564	}
565
566	/* Help styles --------------------------------------------------------------- */
567
568	div.toc {
569	padding: 0 1em 0 1em;
570	margin: 1em;
571	background: #F0F0FF;
572	border: 1px dotted #9999FF;
573	width: 19em;
574	}
575
576	div.right {
577	float: right;
578	width: 22em;
579	}
580
581	ol.toc {
582	list-style-type: upper-roman;
583	}
584
585	ol.toc ol {
586	padding-left: 3em;
587	margin-left: 0;
588	list-style-type: lower-alpha;
589	}
590
591	dl.variables dt { font-size: 80%; }
592	dl.variables dd { margin-bottom: 0.5em; }
593
594	</style>
595	<style type="text/css" media="print">
596	#navbar_title {
597	background-color: #FFFFFF;
598	}
599
600	#main_navbar td {
601	background: #FFFFFF;
602	border-top: 0.25em solid #FFFFFF;
603	border-bottom: 0.25em solid #FFFFFF;
604	}
605
606	#main_navbar td#selected {
607	background: #FFFFFF;
608	border-top: 0.25em solid #333399;
609	border-bottom: 0.25em solid #FFFFFF;
610	}
611
612	#main_navbar td#flexible {
613	background: #FFFFFF;
614	border-top: 0.25em solid #FFFFFF;
615	border-bottom: 0.25em solid #FFFFFF;
616	}
617
618	#secondary_navbar {
619	display: none;
620	}
621
622	</style>
623
624
625	<script type="text/javascript">
626	function setTitle() {
627	parent.document.title="getcolor.pro (SAXO Documentation)";
628	}
629	</script>
630	</head>
631
632	<body onload="setTitle();">
633
634	<div id="navbar_title">
635	<h1>SAXO Documentation</h1>
636	</div>
637
638
639	<div id="main_navbar">
640
641	<table cellspacing="0">
642	<tr>
643
644	<td><a href="./../../overview.html?format=raw" title="Overview of library">Overview</a></td>
645
646
647
648	<td >Directory</td>
649
650
651
652	<td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
653
654
655
656	<td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
657
658
659
660	<td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td>
661
662
663	<td id="selected">File</td>
664
665
666	<td >Source</td>
667
668
669
670	<td><a href="./../../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td>
671
672
673	<td >Etc</td>
674
675	<td id="flexible">Developer documentation</td>
676	</tr>
677	</table>
678
679	</div>
680
681	<div id="secondary_navbar">
682
683	<a href="colorbar.html"><<prev file</a> \| <a href="lct.html">next file >></a>    <a href="getcolor.html" target="_TOP">view single page</a> \| <a href="./../../index.html?format=raw" target="_TOP">view frames</a>    summary: fields \| <a href="#routine_summary">routine</a>    details: <a href="#routine_details">routine</a>
684
685	</div>
686
687
688	<div id="container">
689
690	<h1 class="directory"><a href="directory-overview.html?format=raw">ToBeReviewed/COULEURS/</a></h1>
691	<h2 class="pro_file">getcolor.pro</h2>
692
693	<div id="file_attr">
694	<dl>
695	</dl>
696	</div>
697
698	<div id="file_comments"></div>
699
700
701
702
703
704
705
706
707	<div id="routine_summary">
708	<h2>Routine summary</h2>
709
710	<dl>
711
712	<dt><p><a href="#_COLOR24"><span class="result">result = </span>COLOR24(<span class="result">number</span>)</a></p><dt>
713	<dd> NAME: GETCOLOR PURPOSE: The original purpose of this function was to enable the user to specify one of the 16 colors supported by the McIDAS color map by name.</dd>
714
715	<dt><p><a href="#_GETCOLOR"><span class="result">result = </span>GETCOLOR(<span class="result">thisColor, index</span>, TRUE=<span class="result">TRUE</span>, NAMES=<span class="result">NAMES</span>, LOAD=<span class="result">LOAD</span>, START=<span class="result">START</span>)</a></p><dt>
716	<dd></dd>
717
718	</dl>
719	</div>
720
721
722	<div id="routine_details">
723
724
725	<div class="routine_details" id="_COLOR24">
726
727	<h2><a class="top" href="#container">top</a>COLOR24 </h2>
728
729	<p class="header">
730	<span class="result">result = </span>COLOR24(<span class="result"><a href="#_COLOR24_param_number">number</a></span>)</p>
731
732	<div class="comments">
733	NAME:
734	GETCOLOR
735
736	PURPOSE:
737	The original purpose of this function was to enable the
738	user to specify one of the 16 colors supported by the
739	McIDAS color map by name. Over time, however, the function
740	has become a general purpose function for handling and
741	supporting drawing colors in a device-independent way.
742	In particular, I have been looking for ways to write color
743	handling code that will work transparently on both 8-bit and
744	24-bit machines. On 24-bit machines, the code should work the
745	same where color decomposition is turned on or off.
746
747	(The 16 supported colors in GETCOLOR come from the McIDAS color
748	table offered on the IDL newsgroup by Liam Gumley.)
749
750	CATEGORY:
751	Graphics, Color Specification.
752
753	CALLING SEQUENCE:
754	result = GETCOLOR(color)
755
756	OPTIONAL INPUT PARAMETERS:
757	COLOR: A string with the "name" of the color. Valid names are:
758	black
759	magenta
760	cyan
761	yellow
762	green
763	red
764	blue
765	navy
766	gold
767	pink
768	aqua
769	orchid
770	gray
771	sky
772	beige
773	white
774
775	The color YELLOW is returned if the color name can't be resolved.
776	Case is unimportant.
777
778	If the function is called with just this single input parameter,
779	the return value is either a 1-by-3 array containing the RGB values of
780	that particular color, or a 24-bit integer that can be "decomposed" into
781	that particular color, depending upon the state of the TRUE keyword and
782	upon whether color decomposition is turned on or off. The state of color
783	decomposition can ONLY be determined if the program is being run in
784	IDL 5.2 or higher.
785
786	INDEX: The color table index where the specified color should be loaded.
787	If this parameter is passed, then the return value of the function is the
788	index number and not the color triple. (If color decomposition is turned
789	on AND the user specifies an index parameter, the color is loaded in the
790	color table at the proper index, but a 24-bit value is returned to the
791	user in IDL 5.2 and higher.)
792
793	If no positional parameter is present, then the return value is either a 16-by-3
794	byte array containing the RGB values of all 16 colors or it is a 16-element
795	long integer array containing color values that can be decomposed into colors.
796	The 16-by-3 array is appropriate for loading color tables with the TVLCT command:
797
798	Device, Decomposed=0
799	colors = GetColor()
800	TVLCT, colors, 100
801
802
803	INPUT KEYWORD PARAMETERS:
804
805	NAMES: If this keyword is set, the return value of the function is
806	a 16-element string array containing the names of the colors.
807	These names would be appropriate, for example, in building
808	a list widget with the names of the colors. If the NAMES
809	keyword is set, the COLOR and INDEX parameters are ignored.
810
811	listID = Widget_List(baseID, Value=GetColor(/Names), YSize=16)
812
813	LOAD: If this keyword is set, all 16 colors are automatically loaded
814	starting at the color index specified by the START keyword.
815	Note that setting this keyword means that the return value of the
816	function will be a structure, with each field of the structure
817	corresponding to a color name. The value of each field will be
818	an index number (set by the START keyword) corresponding to the
819	associated color, or a 24-bit long integer value that creates the
820	color on a true-color device. What you have as the field values is
821	determined by the TRUE keyword or whether color decomposition is on
822	or off in the absense of the TRUE keyword. It will either be a 1-by-3
823	byte array or a long integer value.
824
825	START: The starting color index number if the LOAD keyword is set. This keyword
826	value is ignored unless the LOAD keyword is also set. The keyword is also
827	ignored if the TRUE keyword is set or if color decomposition in on in
828	IDL 5.2 and higher. The default value for the START keyword is
829	!D.TABLE_SIZE - 17.
830
831	TRUE: If this keyword is set, the specified color triple is returned
832	as a 24-bit integer equivalent. The lowest 8 bits correspond to
833	the red value; the middle 8 bits to the green value; and the
834	highest 8 bits correspond to the blue value. In IDL 5.2 and higher,
835	if color decomposition is turned on, it is as though this keyword
836	were set.
837
838	COMMON BLOCKS:
839	None.
840
841	SIDE EFFECTS:
842	None.
843
844	RESTRICTIONS:
845	The TRUE keyword causes the START keyword to be ignored.
846	The NAMES keyword causes the COLOR, INDEX, START, and TRUE parameters to be ignored.
847	The COLOR parameter is ignored if the LOAD keyword is used.
848	On systems where it is possible to tell the state of color decomposition
849	(i.e., IDL 5.2 and higher), a 24-bit value (or values) is automatically
850	returned if color decomposition is ON.
851
852	EXAMPLE:
853	To load a yellow color in color index 100 and plot in yellow, type:
854
855	yellow = GETCOLOR('yellow', 100)
856	PLOT, data, COLOR=yellow
857
858	or,
859
860	PLOT, data, COLOR=GETCOLOR('yellow', 100)
861
862	To do the same thing on a 24-bit color system with decomposed color on, type:
863
864	PLOT, data, COLOR=GETCOLOR('yellow', /TRUE)
865
866	or in IDL 5.2 and higher,
867
868	DEVICE, Decomposed=1
869	PLOT, data, COLOR=GETCOLOR('yellow')
870
871	To load all 16 colors into the current color table, starting at
872	color index 200, type:
873
874	TVLCT, GETCOLOR(), 200
875
876	To add the color names to a list widget:
877
878	listID = Widget_List(baseID, Value=GetColor(/Names), YSize=16)
879
880	To load all 16 colors and have the color indices returned in a structure:
881
882	DEVICE, Decomposed=0
883	colors = GetColor(/Load, Start=1)
884	HELP, colors, /Structure
885	PLOT, data, COLOR=colors.yellow
886
887	To get the direct color values as 24-bit integers in color structure fields:
888
889	DEVICE, Decomposed=1
890	colors = GetColor(/Load)
891	PLOT, data, COLOR=colors.yellow
892
893	Note that the START keyword value is ignored if on a 24-bit device,
894	so it is possible to write completely device-independent code by
895	writing code like this:
896
897	colors = GetColor(/Load)
898	PLOT, data, Color=colors.yellow
899
900	MODIFICATION HISTORY:
901	Written by: David Fanning, 10 February 96.
902	Fixed a bug in which N_ELEMENTS was spelled wrong. 7 Dec 96. DWF
903	Added the McIDAS colors to the program. 24 Feb 99. DWF
904	Added the INDEX parameter to the program 8 Mar 99. DWF
905	Added the NAMES keyword at insistence of Martin Schultz. 10 Mar 99. DWF
906	Reorderd the colors so black is first and white is last. 7 June 99. DWF
907	Added automatic recognition of DECOMPOSED=1 state. 7 June 99. DWF
908	Added LOAD AND START keywords. 7 June 99. DWF.</div>
909
910
911
912
913	<h3>Parameters</h3>
914
915
916	<h4 id="_COLOR24_param_number">number
917
918
919
920
921
922
923
924
925	</h4>
926
927	<div class="comments"></div>
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957	</div>
958
959
960	<div class="routine_details" id="_GETCOLOR">
961
962	<h2><a class="top" href="#container">top</a>GETCOLOR </h2>
963
964	<p class="header">
965	<span class="result">result = </span>GETCOLOR(<span class="result"><a href="#_GETCOLOR_param_thisColor">thisColor</a>, <a href="#_GETCOLOR_param_index">index</a></span>, <a href="#_GETCOLOR_keyword_TRUE">TRUE</a>=<span class="result">TRUE</span>, <a href="#_GETCOLOR_keyword_NAMES">NAMES</a>=<span class="result">NAMES</span>, <a href="#_GETCOLOR_keyword_LOAD">LOAD</a>=<span class="result">LOAD</span>, <a href="#_GETCOLOR_keyword_START">START</a>=<span class="result">START</span>)</p>
966
967	<div class="comments"></div>
968
969
970
971
972	<h3>Parameters</h3>
973
974
975	<h4 id="_GETCOLOR_param_thisColor">thisColor
976
977
978
979
980
981
982
983
984	</h4>
985
986	<div class="comments"></div>
987
988	<h4 id="_GETCOLOR_param_index">index
989
990
991
992
993
994
995
996
997	</h4>
998
999	<div class="comments"></div>
1000
1001
1002
1003
1004
1005
1006	<h3>Keywords</h3>
1007
1008	<h4 id="_GETCOLOR_keyword_TRUE">TRUE
1009
1010
1011
1012
1013
1014
1015
1016
1017	</h4>
1018
1019	<div class="comments"></div>
1020
1021	<h4 id="_GETCOLOR_keyword_NAMES">NAMES
1022
1023
1024
1025
1026
1027
1028
1029
1030	</h4>
1031
1032	<div class="comments"></div>
1033
1034	<h4 id="_GETCOLOR_keyword_LOAD">LOAD
1035
1036
1037
1038
1039
1040
1041
1042
1043	</h4>
1044
1045	<div class="comments"></div>
1046
1047	<h4 id="_GETCOLOR_keyword_START">START
1048
1049
1050
1051
1052
1053
1054
1055
1056	</h4>
1057
1058	<div class="comments"></div>
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085	</div>
1086
1087	</div>
1088
1089
1090
1091	<div id="tagline">Produced by IDLdoc 2.0.</div>
1092
1093	</div>
1094
1095	</body>
1096	</html>

Note: See TracBrowser for help on using the repository browser.

Download in other formats: