NAME

INQUIRE TEXT REPRESENTATION PLUS - inquire for extended text representation on workstation

SYNOPSIS

C Syntax

void

pinq_text_rep_plus ( ws, index, type, error_ind, rep )

Pint                 ws;            workstation identifier
Pint                 index;         text index
Pinq_type            type;          type of returned value
Pint                 * error_ind;   OUT error indicator
Ptext_bundle_plus    * rep;         OUT extended text representation

FORTRAN Syntax

SUBROUTINE pqetr ( WKID, INDEX, ITYPE, ERRIND, TFONT, TPREC, TCEXPF, TSPACE, COLTYPE, ITCOLR, TCOLR )

INTEGER      WKID         workstation identifier
INTEGER      INDEX        text bundle index
INTEGER      ITYPE        type of returned values (PSET, PREALI )
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      COLTYPE      OUT colour type
INTEGER      ITCOLR       OUT indirect colour index
REAL         TCOLR(3)     OUT direct colour value

Required PHIGS Operating States

(PHOP, WSOP, * ,* )

DESCRIPTION

Purpose

INQUIRE TEXT REPRESENTATION PLUS inquires for an extended text representation on a workstation.

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

C Input Parameters

ws

The workstation identifier.

index

The text index.

type

An enumerated value specifying whether the values to be returned are those originally specified by the application (PINQ_SET), or those resulting after PHIGS mapped them to ones available on the workstation (PINQ_REALIZED). A Pinq_type structure is defined in phigs.h as:

typedef enum {

PINQ_SET,

PINQ_REALIZED

} Pinq_type;

C Output Parameters

error_ind

A pointer to the location to store the error number of any error that this function detects.

rep

A pointer to a Ptext_bundle_plus structure, which 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;

Ptext_prec is defined as:

typedef enum {

PPREC_STRING,

PPREC_CHAR,

PPREC_STROKE

} Ptext_prec;

Pgcolr is defined as:

typedef struct {

Pint

type;

/* indirect, RGB, CIE, HSV, HLS * /

union {

Pint

ind;

/* index in workstation colour bundle

table * /

struct {

             Pfloat     x;      /* red, hue, and so on * /
             Pfloat     y;      /* green, saturation, lightness, and
                                   so on * /
             Pfloat     z;      /* blue, value, saturation, and so on * /
          } general;
        } val;
} Pgcolr;

Constants defined for colour type are:

0   PINDIRECT         Indirect
1   PMODEL_RGB        Red, Green, Blue
2   PMODEL_CIELUV     CIE
3   PMODEL_HSV        Hue, Saturation, Value

4

PMODEL_HLS

Hue, Lightness, Saturation

The index member of the val union is used for type PINDIRECT. The general member is used for the other types.

FORTRAN Input Parameters

All of the following data types are predefined in phigs77.h.

WKID

The identifier of the workstation for which the text representation is being defined.

INDEX The index into the specified workstation text bundle table.

ITYPE

An enumerated value specifying whether the values to be returned are those originally specified by the application (Set), or those resulting after PHIGS mapped them to ones available on the workstation (Realized). Valid values are:

0   PSET      Set
1   PREALI    Realized

FORTRAN Output Parameters

ERRIND

The error number of any error that this function detects.

TFONT The text font.

TPREC The text precision.

TCEXPF

The text character expansion factor.

TSPACE

The text character spacing.

COLTYPE

The colour type. 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 value containing the index into the workstation colour table for determining the text colour. This value is not used when COLTYPE is greater than zero.

TCOLR(3)

An array of reals containing the text colour. This array is not used when COLTYPE 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 specified text index is not present in the text bundle table on the workstation, and the specified type of returned value is Realized, then the representation for text index one is returned.

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 this function detects an error.

ERRORS

003

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

054

Ignoring function, the specified workstation is not open

059

Ignoring function, the specified workstation does not have output capability (that is, the workstation category is not OUTPUT, OUTIN, or MO)

100

Ignoring function, the bundle index value is less than one

101

Ignoring function, the specified representation has not been defined

SEE ALSO

SET TEXT REPRESENTATION PLUS (3PP)

INQUIRE TEXT REPRESENTATION (3P)

INQUIRE PREDEFINED TEXT REPRESENTATION PLUS (3PP)