.\"##
.\" $XConsortium: p292,v 5.2 94/04/17 20:57:50 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 CHARACTER EXPANSION FACTOR" 3P "29 February 1991"
.SH NAME
SET CHARACTER EXPANSION FACTOR \- create structure element to set the current \fIcharacter expansion factor\fP attribute
.IX "Aspect Source Flags" "SET CHARACTER EXPANSION FACTOR"
.IX "Text Attributes" "SET CHARACTER EXPANSION FACTOR"
.IX "Attributes, Text Attributes" "SET CHARACTER EXPANSION FACTOR"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pset_char_expan ( exp_factor )
Pfloat	exp_factor;	\fIcharacter expansion factor\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, STOP, *)
.SH DESCRIPTION
.SS Purpose
\s-2SET CHARACTER EXPANSION FACTOR\s+2 creates a structure element
containing a value for the current character
expansion attribute, which changes the characters' width-to-height
ratio from the ratio with which the font was designed.
.LP
When the character expansion factor Aspect Source Flag (\s-2ASF\s+2)
is set to \s-2INDIVIDUAL\s+2,
this attribute applies to the following output primitives:
.RS
.ta 0.2i +0.2i +0.2i +0.2i +0.2i +0.2i +0.2i +0.2i
.LP
\(bu
.SM TEXT
.LP
\(bu
.SM "TEXT 3"
.LP
\(bu
.SM "ANNOTATION TEXT RELATIVE"
.LP
\(bu
.SM "ANNOTATION TEXT RELATIVE 3"
.ta
.RE
.SS C Input Parameter
.IP \fIexp_factor\fP
A real value specifying the character expansion factor.
.SS Execution
If the current edit mode is \s-2INSERT\s+2, a \s-2SET CHARACTER EXPANSION
FACTOR\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 CHARACTER EXPANSION FACTOR\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.  
When the \s-2SET CHARACTER EXPANSION FACTOR\s+2 element is traversed,
the current character expansion factor
entry in the traversal state list is set to exp_factor.  
.LP
When the current character expansion factor \s-2ASF\s+2 is set to
\s-2INDIVIDUAL\s+2, characters in text output primitives that follow in
the structure network are modified by the absolute value of
the expansion factor specified.  
.LP
The default character expansion factor is 1.0, 
which results in no change in the width-to-height ratio of characters
from their definition by the font designer.  
A character expansion factor
of less than 1.0 produces narrower characters,
and a character expansion factor
greater than 1.0 produces wider characters.  
.LP
When the character expansion factor \s-2ASF\s+2 is set to \s-2BUNDLED\s+2, the
character expansion factor is taken from the
workstation's representation indicated by the current text index.  
In this case, the expansion factor set with \s-2SET
CHARACTER EXPANSION FACTOR\s+2 has no effect.  
.SH ERRORS
.IP 005
Ignoring function, function requires state (\s-2PHOP, *, STOP, *\s+2)
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "SET INDIVIDUAL ASF (3P)"
.SM "SET TEXT REPRESENTATION (3P)"
.SM "SET CHARACTER HEIGHT (3P)"
.SM "SET CHARACTER SPACING (3P)"
.fi
