PEXOCCSetTextPath - Set Text Path (5.0)


Synopsis

 
   void PEXOCCSetTextPath(
        PEXOCC context,
        int path
   )
 

 
   void PEXSetTextPath(
        Display *display,
        XID resource_id,
        PEXOCRequestType req_type,
        int path
   )
 

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).

path
The text (drawing) path (PEXPathRight, PEXPathLeft, PEXPathUp or PEXPathDown).

Returns

None.

Description

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

Use the text path to define the direction in which you want text characters placed.

PEXlib defines the following text paths (path):

PEXPathRight -
places each character after the previous character in a character string along a baseline in the direction of the character base vector. (5.0)

PEXPathLeft -
places each character after the previous character in a character string along a baseline in the opposite direction of the character base vector. (5.0)

PEXPathUp -
places each character after the previous character in a character string in the direction of the character up vector. (5.0)

PEXPathDown -
places each character after the previous character in a character string in the opposite direction of the character up vector. (5.0)

If you specify an undefined path, then the implementation issues a BadPEXOutputCommand error.

The text path function is a member of the 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.