NAME

SET TEXT COLOUR INDEX − create a structure element to set the current text colour index attribute

SYNOPSIS

C Syntax

void
pset_text_colr_ind ( colour )
Pintcolour;text colour index

Required PHIGS Operating States

(PHOP, ∗, STOP, ∗)

DESCRIPTION

Purpose

SET TEXT COLOUR INDEX creates a structure element containing a value for the current text colour index attribute. 

When the current text colour index Aspect Source Flag (ASF) is set to INDIVIDUAL, this attribute indexes the current colour representation that applies to the output primitives:

• TEXT

• TEXT 3

• ANNOTATION TEXT RELATIVE

• ANNOTATION TEXT RELATIVE 3

C Input Parameter

colourAn integer colour index, which selects a colour value from the workstation’s colour table. 

Execution

If the current edit mode is INSERT, a SET TEXT COLOUR INDEX element is inserted into the currently open structure after the element pointed to by the current element pointer. If the edit mode is REPLACE, the new SET TEXT COLOUR INDEX element replaces the element pointed to by the element pointer.  In either case, the element pointer is updated to point to the new element. 

When the SET TEXT COLOUR INDEX element is traversed, the current text colour index entry in the traversal state list is set to the colour index. 

When the current text colour index ASF is set to INDIVIDUAL, 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. 

If the colour index specified is not available on the workstation, colour index 1 is used. 

When the current text colour index ASF is set to BUNDLED, 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 SET TEXT COLOUR INDEX has no effect. 

ERRORS

005Ignoring function, function requires state (PHOP, ∗, STOP, ∗)

113Ignoring function, the colour index value is less than zero

SEE ALSO

COLOUR (7P)
SET COLOUR REPRESENTATION (3P)
SET INDIVIDUAL ASF (3P)
SET TEXT REPRESENTATION (3P)
SET TEXT COLOUR (3P+)
SET TEXT REPRESENTATION PLUS (3P+)

September 02, 1992