NAME

INQUIRE PREDEFINED TEXT REPRESENTATION PLUS - inquire for predefined extended text representation for specified workstation type

SYNOPSIS

C Syntax

void

pinq_pred_text_rep_plus ( type, index, error_ind, bundle )

Pint                 type;          workstation type
Pint                 index;         predefined index
Pint                 * error_ind;   OUT error indicator
Ptext_bundle_plus    * bundle;      OUT predefined text rep

FORTRAN Syntax

SUBROUTINE pqpetr ( WKTYPE, INDEX, ERRIND, TFONT, TPREC, TCEXPF, TSPACE, COLMOD, ITCOLR, TCOLR )

INTEGER      WKTYPE       workstation type
INTEGER      INDEX        predefined text index
INTEGER      ERRIND       OUT error indicator
INTEGER      TFONT        OUT text font
INTEGER      TPREC        OUT text precision
REAL         TCEXPF       OUT text character expansion factor
REAL         TSPACE       OUT text character spacing
INTEGER      COLMOD       OUT colour model
INTEGER      ITCOLR       OUT indirect colour index
REAL         TCOLR(3)     OUT direct colour value

Required PHIGS Operating States

(PHOP, * ,* ,* )

DESCRIPTION

Purpose

INQUIRE PREDEFINED TEXT REPRESENTATION PLUS inquires for a predefined extended text representation for a specified workstation type.

This is a SunPHIGS Extension function based on PHIGS PLUS and is not part of the PHIGS standard.

C Input Parameters

type

The workstation type.

index

Index of the predefined entry to be returned.

C Output Parameters

error_ind

A pointer to the location to store the error number of any error detected by this function.

bundle

A pointer to a Ptext_bundle_plus structure that returns the specified extended text representation. Ptext_bundle_plus is defined as:

typedef struct {

Pint

font;

/* text font * /

Ptext_prec   prec;         /* text precision * /
Pfloat        char_expan;   /* character expansion factor * /
Pfloat        char_space;   /* character spacing * /
Pgcolr       colr;         /* text colour * /

} Ptext_bundle_plus;

See SET TEXT REPRESENTATION PLUS for a description of the contents of this structure.

FORTRAN Input Parameters

WKTYPE

The workstation type.

INDEX

Index of the predefined entry to be returned.

FORTRAN Output Parameters

ERRIND

The error number of any error detected by this function.

TFONT The text font.

TPREC The text precision.

TCEXPF

The text character expansion factor.

TSPACE

The text character spacing.

COLMOD

The colour model. The predefined values are:

0   PINDIR   Colour Index Specified
1   PRGB     Red, Green, and Blue
2   PCIE     CIE Colour Model
3   PHSV     Hue, Saturation, and Value
4   PHLS     Hue, Lightness, and Saturation

ITCOLR

An integer containing the index into the workstation colour table for the text colour. This value is not used if COLMOD is greater than zero.

TCOLR(3)

An array of reals containing the text colour. This array is unused if COLMOD is equal to zero (PINDIR).

TCOLR(1) = Red, Hue, and so on

TCOLR(2) = Green, Saturation, Lightness, and so on

TCOLR(3) = Blue, Value, Saturation, and so on

Execution

If the inquired information is available, then the error indicator is returned as zero, and values are returned in the output parameters.

If the inquired information is not available, then the values returned in the output parameters are undefined, and the error indicator is set to one of the error numbers below to indicate the reason for nonavailability.

Since this is an inquiry function, ERROR HANDLING is not invoked when an error is detected by this function.

ERRORS

002

Ignoring function, function requires state (PHOP, * ,* ,* )

051

Ignoring function, this information unavailable for this workstation type

052

Ignoring function, workstation type not recognized by the implementation

062

Ignoring function, this information is not available for this MO workstation type

100

Ignoring function, the bundle index value is less than one

102

Ignoring function, the specified representation has not been predefined on this workstation

SEE ALSO

SET TEXT REPRESENTATION PLUS (3PP)

INQUIRE TEXT REPRESENTATION PLUS (3PP)

INQUIRE PREDEFINED TEXT REPRESENTATION (3P)