INQUIRE TEXT REPRESENTATION PLUS(3P+) — Kubota Pacfic Computer Inc. (29 February 1991)

NAME

INQUIRE TEXT REPRESENTATION PLUS − inquire an extended text representation on a workstation

SYNOPSIS

C Syntax

void
pinq_text_rep_plus ( ws, index, type, error_ind, rep )
Pintws;workstation identifier
Pintindex;text index
Pinq_typetype;type of returned value
Pint∗error_ind;OUT error indicator
Ptext_bundle_plus∗rep; OUT extended text representation

Required PHIGS Operating States

(PHOP, WSOP, ∗, ∗)

DESCRIPTION

Purpose

INQUIRE TEXT REPRESENTATION PLUS returns the attribute values of a specified entry in a workstation extended text bundle table. See SET TEXT REPRESENTATION PLUS for a full description of the contents of the bundle table entry and a description of the extended text bundle table.

C Input Parameters

wsThe workstation identifier.

indexThe text index.

typeAn 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 detected by this function.

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

typedef struct {
Pintfont;/∗ text font ∗/
Ptext_precprec;/∗ text precision ∗/
Pfloatchar_expan;/∗ character expansion factor ∗/
Pfloatchar_space;/∗ character spacing ∗/
Pgcolrcolr;/∗ 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 {
Pinttype;/∗ indirect, RGB, CIE, HSV, HLS ∗/
union {
     Pintind;/∗ index in workstation colour bundle table ∗/
     struct {
          Pfloatx;/∗ red, hue, etc. ∗/
          Pfloaty;/∗ green, saturation, lightness, etc. ∗/
          Pfloatz;/∗ blue, value, saturation, etc. ∗/
     } general;
} val;
} Pgcolr;

Constants defined for colour type are:

0PINDIRECTIndirect
1PMODEL_RGBRed, Green, Blue
2PMODEL_CIELUVCIE
3PMODEL_HSVHue, Saturation, Value
4PMODEL_HLSHue, Lightness, Saturation

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

Execution

If the inquired information is available, 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, the representation for text index one is returned.

If the inquired information is not available, the values returned in the output parameters are undefined and the error indicator is set to one of the following error numbers 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

003Ignoring function, function requires state (PHOP, WSOP, ∗, ∗)

054Ignoring function, the specified workstation is not open

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

100Ignoring function, the bundle index value is less than one

101Ignoring function, the specified representation has not been defined

Museum