.\" @(#)PEXQueryEncodedTextExtents.3 1.4 95/03/24 SMI;
.so man3/pex.macs
.TH PEXQueryEncodedTextExtents 3 "May 1995" "Solaris PEXlib Reference Manual" ""
.SH NAME
PEXQueryEncodedTextExtents - Query Encoded Text Extents
.SH SYNTAX
.HP
PEXTextExtent *PEXQueryEncodedTextExtents\^(\^Display *\fIdisplay\fP\^, XID \fIresource_id\fP\^, unsigned int \fIfont_table_index\fP\^, int \fIpath\fP\^, double \fIexpansion\fP\^, double \fIspacing\fP\^, double \fIheight\fP\^, int \fIhalign\fP\^, int \fIvalign\fP\^, unsigned long \fIcount\fP\^, PEXListOfEncodedText *\fIencoded_text\fP\^)
.SH PARAMETERS
.IP \fIdisplay\fP 1i
A pointer to a display structure returned by a successful
.B XOpenDisplay
call.
.IP \fIresource_id\fP 1i
The resource identifier of either a renderer, a workstation or a text font
table.
.IP \fIfont_table_index\fP 1i
The text font table index.
.IP \fIpath\fP 1i
The text path (
.B PEXPathRight,
.B PEXPathLeft,
.B PEXPathUp,
.B PEXPathDown
).
.IP \fIexpansion\fP 1i
The text character expansion factor.
.IP \fIspacing\fP 1i
The text character spacing factor.
.IP \fIheight\fP 1i
The text character height.
.IP \fIhalign\fP 1i
The text horizontal text alignment (
.B PEXHAlignNormal,
.B PEXHAlignLeft,
.B PEXHAlignCenter,
.B PEXHAlignRight
).
.IP \fIvalign\fP 1i
The text vertical text alignment (
.B PEXVAlignNormal,
.B PEXVAlignTop,
.B PEXVAlignCap,
.B PEXVAlignHalf,
.B PEXVAlignBase,
.B PEXVAlignBottom).
.IP \fIcount\fP 1i
The number of encoded text strings.
.IP \fIencoded_text\fP 1i
An array of encoded text strings.
.SH RETURNS
.LP
An array of text extents; a null pointer if unsuccessful.
.SH DESCRIPTION
.\" indexing
.IX PEXQueryEncodedTextExtents
.LP
This function is like
.BR PEXQueryTextExtents (3) ,
except
that multiple encoded text strings are specified.  Each text
string in the encoded text list has a character set, a character
set width, an encoding state, and a list of characters.  (See
.B PEXEncodedTextData.)
.LP
The character
set is an index into the current font group.  Font groups have
individual fonts which are numbered starting at one; a value of
three would select the third font in the font group currently being
used.  If a character set is not available in the current font
group then the default
font group is used.  If a character set value is not available in the
default font group then the result is
implementation-dependent.  The character set width indicates
the width or size of characters in the strings.
Valid values for character set width are
.B PEXCSByte,
.B PEXCSShort
and
.B PEXCSLong.
The encoding state is provided for use by the application and is not
interpreted by the PEX server.
.LP
All other aspects of this function are the same as
.BR PEXQueryTextExtents (3) .
.SH DATA STRUCTURES
.LP
.nf
typedef struct {
	unsigned short		count;	/* number of encodings */
	PEXEncodedTextData	*encoded_text;
.br
} PEXListOfEncodedText;
.sp
typedef struct {
	unsigned short		character_set;
	unsigned char		character_set_width;
	unsigned char		encoding_state;
	unsigned short		reserved;
	unsigned short		length;
	char			*ch;
.br
} PEXEncodedTextData;
.sp
typedef struct {
	PEXCoord2D	lower_left;
	PEXCoord2D	upper_right;
	PEXCoord2D	concat_point;
.br
} PEXTextExtent;
.sp
typedef struct {
	float	x;
	float	y;
.br
} PEXCoord2D;
.fi
.SH ERRORS
.TP
.SB BadMatch
The specified resource identifier identifies a table of type other than a
text font table.
.TP
.SB BadValue
A specified value for one or more text attributes is invalid, or the specified
resource identifier does not identify a valid renderer, workstation or
lookup table resource.
.SH SEE ALSO
.LP
.nf
.BR PEXQueryTextExtents (3)
.fi