DESIGN (xvisual) functions


LIBRARY ROUTINE

xvw_create_string - create a string annotation

LIBRARY CALL

xvobject xvw_create_string(
   xvobject parent,
   char     *name)

INPUT

OUTPUT

none

RETURN VALUE

The string object on success, NULL on failure

DESCRIPTION

A string visual object is used to display a (non-editable) string of characters. The string specified may be of any length, and of multiple lines. Carriage returns may be specified with "\n".

The location of the upper left corner of the the string may be specified in world coordinates, where the world coordinate range is dictated by the "controlling" visual object. By default, the parent of the string object is its controlling visual object; this may be changed using the XVW_GRAPHICS_ATTACH attribute.

Alternatively, the location of the string may be specified using device coordinates. As when using world coordinates, specify the upper left hand corner of the string.

The amount of space used by the string cannot be explicitly set by the application; this is automatically calculated according to the font that is used. Specification of a width and height simply provides a buffer of space around the string; note that justification will have no effect unless the width and height are specified to be larger than what is actually needed by the string. Width and height may be specified in characters or in pixels.

In addition to font specification, the string object also supports multiple styles in which the string may appear: available styles include plain, emphasized, embossed in, and embossed out.

ADDITIONAL INFORMATION

none

EXAMPLES

none

SIDE EFFECTS

none

RESTRICTIONS

none

MODIFICATION

none

FILES

$DESIGN/objects/library/xvisual/src/String.c

SEE ALSO

xvisual(3)

COPYRIGHT

Copyright (C) 1993 - 1997, Khoral Research, Inc. ("KRI") All rights reserved.