IN_V2_TEXT_* structures

image\bltlrgsq_shg.gif Editions  image\bltlrgsq_shg.gif Related Functions image\bltlrgsq_shg.gif Example

You can define, place, and retrieve descriptions of version 2 text objects by using the IN_PlaceVectorObject and IN_GetVectorObjectDescription functions, and the following structures:

image\bltlrgsq_shg.gif IN_OBJECT_HEADER

image\bltlrgsq_shg.gif IN_V2_TEXT_PARMS

image\bltlrgsq_shg.gif IN_V2_TEXT_OBJECT

 

For information about version 1 text objects, see IN_V1_TEXT_* structures.

IN_OBJECT_HEADER

Syntax

typedef struct tagApiObjectHeader {

IN_OBJECT_TYPE objectType;

USHORT version;

USHORT size;

USHORT flags;

ULONG objectID;

ULONG parentID;

} IN_OBJECT_HEADER, FAR *IN_OBJECT_HEADER_PTR;

Parameters

Values

Meaning

objectType

IN_OBJTYPE_TEXT (6)

text

version

2

version number

size

sizeof (IN_V2_TEXT_OBJECT) + strlen(Textobject.string)

size of the data structure, including the string parameter in the text object structure

flags

IN_OBJFLAG_* values

 

objectID

identifier of the text object

parentID

identifier of the group of objects that the text object belongs to. Use 0 if the object is not part of a group.

IN_V2_TEXT_PARMS

Syntax

typedef struct tagApiTextParmsV2 {

IN_RGB color;

IN_TYPEFACE typeface;

char  fontName[82];

IN_MEASUREMENT height;

IN_MEASUREMENT width;

IN_ANGLE rotation;

IN_JUSTIFICATION justification;

IN_MIRROR mirror;

IN_ANGLE orientation;

IN_ANGLE shear;

IN_LINESTYLE lineStyle;

IN_FILLSTYLE fillStyle;

IN_RGB fillColour;

IN_HATCHSTYLE hatchStyle;

IN_MEASUREMENT outlineThickness;

} IN_V2_TEXT_PARMS, FAR *IN_V2_TEXT_PARMS_PTR;

Parameters

Values

Meaning

color

RGB color

text color

typeface

IN_TYPEFACE_* values

style to apply

 

-1

default typeface style

fontName

string, 82 characters or less

Windows-defined font name

height

Measurement structure

height of the text

width

Measurement structure

width of the text

rotation

floating point, in degrees

counter-clockwise rotation of the entire text string. Example

justification

IN_JUST_* values

position of text

mirror

IN_MIRROR_* values

text mirroring

orientation

floating point, in degrees

counter-clockwise rotation of each character in the text string. Example

shear

floating point, in degrees

slant of the text string. Example

lineStyle

IN_LINESTYLE_* values

line style (solid, dashed, dotted...)

fillStyle

IN_FILL_* values

For examples, click Fill styles

fillColour

RGB color

text fill color

hatchStyle

IN_HATCH_* values

hatch styles

outlineThickness

Measurement structure

thickness of the outline line

IN_V2_TEXT_OBJECT

Syntax

typedef struct tagApiTextObjectV2 {

IN_OBJECT_HEADER header;

IN_V2_TEXT_PARMS  parms;

IN_POINT point;

char  str[1];

} IN_V2_TEXT_OBJECT, FAR *IN_V2_TEXT_OBJECT_PTR;

Parameters

Values

Meaning

header

IN_OBJECT_HEADER

header of the object

parms

IN_V2_TEXT_PARMS

parameters for the text

point

floating point, x1, y1

coordinates, in inches, where the text is placed

string

text in the object. See Remarks.

Remarks

The str[] array is dynamically allocated based on the number of characters in the text.

Release information

Added to Imagenation for Windows in Release 6.30.

This functionality has not been tested in Imagenation for UNIX, so it should not be used in UNIX integrations.