.\"##
.\" $XConsortium: p380,v 5.2 94/04/17 20:58:53 rws Exp $
.\"##
.\"## 
$XMCOPY
.\"## Copyright (c) 1990, 1991 by Sun Microsystems, Inc. 
.\"## 
.\"##                         All Rights Reserved
.\"## 
.\"## Permission to use, copy, modify, and distribute this software and its 
.\"## documentation for any purpose and without fee is hereby granted, 
.\"## provided that the above copyright notice appear in all copies and that
.\"## both that copyright notice and this permission notice appear in 
.\"## supporting documentation, and that the name of Sun Microsystems,
.\"## not be used in advertising or publicity 
.\"## pertaining to distribution of the software without specific, written 
.\"## prior permission.  
.\"## 
.\"## SUN MICROSYSTEMS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, 
.\"## INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
.\"## EVENT SHALL SUN MICROSYSTEMS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
.\"## CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
.\"## USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
.\"## OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\"## PERFORMANCE OF THIS SOFTWARE.
.TH "SET TEXT PATH" 3P "29 February 1991"
.SH NAME
SET TEXT PATH \- create a structure element to set the \fIcurrent text path\fP
attribute
.IX "Text Attributes" "SET TEXT PATH"
.IX "Attributes, Text Attributes" "SET TEXT PATH"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pset_text_path ( path )
Ptext_path	path;	\fItext path\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, STOP, *)
.SH DESCRIPTION
.SS Purpose
\s-2SET TEXT PATH\s+2 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 \fIcharacter up\fR and \fIcharacter base\fR vectors.  
This attribute applies to the following output primitives:  
.RS
.LP
\(bu 
.SM TEXT
.LP
\(bu
.SM "TEXT 3"
.RE
.LP
If the current edit mode is \s-2INSERT\s+2, 
a \s-2SET TEXT PATH\s+2 element is inserted into the currently open
structure after the element pointed to by the current element pointer.  
If the edit mode is \s-2REPLACE\s+2, the new \s-2SET TEXT PATH\s+2 
element replaces the element pointed to by the element pointer.  
In either case, the
element pointer is updated to point to the new element.  
.SS C Input Parameter
.IP \fIpath\fP
The text path is one of the following enumerated values:
.sp .2
.ta .5i +\w'PPATH_DOWN 'u
.nf
	PPATH_RIGHT	   \fIRight\fP
	PPATH_LEFT	   \fILeft\fP
	PPATH_UP	   \fIUp\fP
	PPATH_DOWN	   \fIDown\fP
.sp .2
.fi
.SS Execution
When the \s-2SET TEXT PATH\s+2 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
\fIcharacter up\fR and \fIcharacter base\fR vectors.  
.LP
If text path is set to \fIRight\fP, then the text string is written
along a base line in the direction of the \s-2CHARACTER BASE VECTOR\s+2.  
If text path is set to \fILeft\fP, then the text string is written
along a base line in the direction opposite to the \s-2CHARACTER BASE
VECTOR\s+2.  
If text path is set to \fIUp\fP, then the text string is written in
the direction of the \s-2CHARACTER UP VECTOR\s+2.  
If text path is set to \fIDown\fP, the text string is written in
the direction opposite to the \s-2CHARACTER UP VECTOR\s+2.  
.LP
\fBNote:\fP  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.  
.SH ERRORS
.IP 005
Ignoring function, function requires state 
(\s-2PHOP\s+2, \s-2*\s+2, \s-2STOP\s+2, \s-2*\s+2)
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "SET TEXT ALIGNMENT (3P)"
.SM "SET CHARACTER UP VECTOR (3P)"
.fi
