PEXOCCSetTextBundleIndex - Set Text Bundle Index (5.0)

Synopsis 

 
   void PEXOCCSetTextBundleIndex(
        PEXOCC context,
        unsigned int index
   )
 


 
   void PEXSetTextBundleIndex(
        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 text bundle table index.

Returns

None.

Description

Invoke PEXOCCSetTextBundleIndex to create an attribute output command which sets the text bundle index attribute in the renderer's pipeline state according to the value specified by index.

You use the text bundle index to select an entry of the renderer's text bundle table whenever a bundlable text attribute's ASF is set to PEXBundled (see PEXOCCSetIndividualASF). PEXlib supports the bundling of the following text attributes: text font index, text precision, character expansion, character spacing, and text color.

If you specify an undefined text bundle index, then the index defaults to index one. If index one is not defined, then the implementation sets the bundled text font index to one, text precision to PEXStringPrecision; character expansion to 1.0, character spacing to 0.0 and text color to indexed color one. If you specify a text bundle index of zero, then the implementation issues a BadPEXOutputCommand error.

This function is a member of the annotation and text attribute set.

Errors

BadPEXOutputCommand
The output command contains an invalid value.

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.