SET ANNOTATION TEXT PATH(3P) — Kubota Pacfic Computer Inc. (29 February 1991)

NAME

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

SYNOPSIS

C Syntax

void
pset_anno_path ( path )
Ptext_pathpath;text path

Required PHIGS Operating States

(PHOP, ∗, STOP, ∗)

DESCRIPTION

Purpose

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

• ANNOTATION TEXT RELATIVE

• ANNOTATION TEXT RELATIVE 3

If the current edit mode is INSERT, then a SET ANNOTATION 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, then the new SET ANNOTATION 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 annotation 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 ANNOTATION TEXT PATH element is traversed, the current annotation text path entry in the traversal state list is set to annotation text path. The annotation text path determines the direction of displacement between one character and the next in a string, defined in relation to the annotation text character base and up vectors.

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

The ANNOTATION TEXT CHARACTER BASE VECTOR attribute is an implicit attribute derived from the ANNOTATION TEXT CHARACTER UP VECTOR.

Note: Annotation 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 annotation text alignment.

ERRORS

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

Museum