PEXOCCSetTextColorIndex - Set Text Color Index (5.0)

Synopsis 

 
   void PEXOCCSetTextColorIndex(
        PEXOCC context,
        unsigned int index
   )
 


 
   void PEXSetTextColorIndex(
        Display *display,
        XID resource_id,
        PEXOCRequestType req_type,
        unsigned int index
   )

Arguments

context
An OC context returned by a successful PEXCreateOCC call.

display (OCC)
A pointer to a display structure returned by a successful XOpenDisplay call.

resource_id (OCC)
The resource identifier of the renderer or structure.

req_type (OCC)
The request type for the output command (PEXOCRender, PEXOCStore, PEXOCRenderSingle or PEXOCStoreSingle).

index
The color table index for text.

Returns

None.

Description

Invoke PEXOCCSetTextColorIndex to set the text color attribute to an indexed color in the renderer's pipeline state according to the value specified by index. The index selects an entry of the renderer's color table. You can alternately use PEXOCCSetTextColor which allows you to specify a color of any type.

By setting the text color attribute's ASF to PEXIndividual (see PEXOCCSetIndividualASF), you use the pipeline state's text color entry to determine the color of text attributes. When you set the text color attribute's ASF to PEXBundled, the implementation uses the text color from the text bundle table.

If you specify an undefined color index, then the index defaults to color index one. If color index one is not defined, then the color defaults to white. If you specify a color index which is greater than 65534, then the implementation issues a BadPEXOutputCommand error.

The text color index function is a member of the annotation and text attribute set.

Errors

BadPEXOutputCommand
The color index value exceeds 65534.

BadPEXRenderer
The specified renderer resource identifier is invalid.

BadPEXStructure
The specified structure resource identifier is invalid.

See Also

For an overview and for a list of all output attribute functions, see Output Attribute Functions.