.\"##
.\" $XConsortium: p377,v 5.2 94/04/17 20:58:50 rws Exp $
.\"##
.\"## 
$XMCOPY
.\"## Copyright (c) 1990, 1991 by Sun Microsystems, Inc. 
.\"## 
.\"##                         All Rights Reserved
.\"## 
.\"## Permission to use, copy, modify, and distribute this software and its 
.\"## documentation for any purpose and without fee is hereby granted, 
.\"## provided that the above copyright notice appear in all copies and that
.\"## both that copyright notice and this permission notice appear in 
.\"## supporting documentation, and that the name of Sun Microsystems,
.\"## not be used in advertising or publicity 
.\"## pertaining to distribution of the software without specific, written 
.\"## prior permission.  
.\"## 
.\"## SUN MICROSYSTEMS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, 
.\"## INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
.\"## EVENT SHALL SUN MICROSYSTEMS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
.\"## CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
.\"## USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
.\"## OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\"## PERFORMANCE OF THIS SOFTWARE.
.TH "SET TEXT COLOUR INDEX" 3P "29 February 1991"
.SH NAME
SET TEXT COLOUR INDEX \- create a structure element to set the current text colour index attribute
.IX "Aspect Source Flags" "SET TEXT COLOUR INDEX"
.IX "Colour" "SET TEXT COLOUR INDEX"
.IX "Text Attributes" "SET TEXT COLOUR INDEX"
.IX "Attributes, Text Attributes" "SET TEXT COLOUR INDEX"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pset_text_colr_ind ( colour )
Pint	colour;	\fItext colour index\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, STOP, *)
.SH DESCRIPTION
.SS Purpose
\s-2SET TEXT COLOUR INDEX\s+2 creates a structure element
containing a value for the current text colour index attribute.
.LP
When the current text colour index Aspect Source Flag (\s-2ASF\s+2)
is set to \s-2INDIVIDUAL\s+2,
this attribute indexes the current colour representation
that applies to the output primitives:
.RS
.ta 0.2i +0.2i +0.2i +0.2i +0.2i +0.2i +0.2i +0.2i
.LP
\(bu
.SM "TEXT"
.LP
\(bu 
.SM "TEXT 3"
.LP
\(bu
.SM "ANNOTATION TEXT RELATIVE"
.LP
\(bu
.SM "ANNOTATION TEXT RELATIVE 3"
.ta
.RE
.SS C Input Parameter
.IP \fIcolour\fP
An integer colour index, which selects a colour value from
the workstation's colour table.
.SS Execution
If the current edit mode is \s-2INSERT\s+2,
a \s-2SET TEXT COLOUR INDEX\s+2 element is inserted into the currently open
structure after the element pointed to by the current element pointer. If
the edit mode is \s-2REPLACE\s+2,
the new \s-2SET TEXT COLOUR INDEX\s+2 element
replaces the element pointed to by the element pointer.
In either case, the element pointer is updated to point to the new element.
.LP
When the \s-2SET TEXT COLOUR INDEX\s+2 element is traversed,
the current text colour index
entry in the traversal state list is set to the colour index.
.LP
When the current text colour index \s-2ASF\s+2 is set to
\s-2INDIVIDUAL\s+2, the text output primitives that follow in
the structure network are drawn with the colour representation
selected by the current text colour index from the workstation's
colour table.
.LP
If the colour index specified is not available on the workstation,
colour index 1 is used.
.LP
When the current text colour index \s-2ASF\s+2 is set to \s-2BUNDLED\s+2,
the text colour index is taken from the
workstation's representation indicated by the current text index.
In this case, the colour index set with \s-2SET TEXT COLOUR INDEX\s+2
has no effect.
.SH ERRORS
.IP 005
Ignoring function, function requires state (\s-2PHOP, *, STOP, *\s+2)
.IP 113
Ignoring function, the colour index value is less than zero
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "COLOUR (7P)"
.SM "SET COLOUR REPRESENTATION (3P)"
.SM "SET INDIVIDUAL ASF (3P)"
.SM "SET TEXT REPRESENTATION (3P)"
.SM "SET TEXT COLOUR (3P+)"
.SM "SET TEXT REPRESENTATION PLUS (3P+)"
.fi