NAME

SET TEXT PATH − create a structure element to set the current text path attribute

SYNOPSIS

C Syntax

void
pset_text_path ( path )
Ptext_pathpath;text path

Required PHIGS Operating States

(PHOP, ∗, STOP, ∗)

DESCRIPTION

Purpose

SET TEXT PATH creates a structure element containing a value for the text path attribute, which controls the direction in which the string is written relative to the character up and character base vectors.  This attribute applies to the following output primitives:

• TEXT

• TEXT 3

If the current edit mode is INSERT, a SET TEXT PATH 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 PATH element replaces the element pointed to by the element pointer.  In either case, the element pointer is updated to point to the new element. 

C Input Parameter

pathThe text path is one of the following enumerated values:

PPATH_RIGHT    Right
PPATH_LEFT   Left
PPATH_UP   Up
PPATH_DOWN   Down

Execution

When the SET TEXT PATH element is traversed, the current text path entry in the traversal state list is set to text path.  The text path determines the direction of displacement between one character and the next in a string, defined in relation to the character up and character base vectors. 

If text path is set to Right, then the text string is written along a base line in the direction of the CHARACTER BASE VECTOR.  If text path is set to Left, then the text string is written along a base line in the direction opposite to the CHARACTER BASE VECTOR.  If text path is set to Up, then the text string is written in the direction of the CHARACTER UP VECTOR.  If text path is set to Down, the text string is written in the direction opposite to the CHARACTER UP VECTOR. 

Note:  Text path controls only the direction in which the string is written.  The position of the string in relation to the text position point is controlled by the text alignment. 

ERRORS

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

SEE ALSO

SET TEXT ALIGNMENT (3P)
SET CHARACTER UP VECTOR (3P)

September 02, 1992